itk::NeighborhoodAllocator< TPixel > Class Template Reference
[Operators]

#include <itkNeighborhoodAllocator.h>

Collaboration diagram for itk::NeighborhoodAllocator< TPixel >:

[legend]List of all members.

---

Detailed Description

template<class TPixel>
class itk::NeighborhoodAllocator< TPixel >

This is a memory allocator for use as the default allocator type in Neighborhood. The API is designed to mimic that of vnl_vector so that vnl_vector can also be used as an allocator for Neighborhood.

The decision to create this allocator with the vnl_vector api (versus using an STL allocator and wrapping the vnl_vector API) was made because the STL allocator API is not guaranteed stable at this time.

Definition at line 35 of file itkNeighborhoodAllocator.h.

Public Types
typedef const TPixel *	const_iterator
typedef TPixel *	iterator
typedef NeighborhoodAllocator	Self
Public Member Functions
const_iterator	begin () const
STL style iterator support for the memory buffer *iterator	begin ()
const_iterator	end () const
iterator	end ()
Copy constructor *	NeighborhoodAllocator (const Self &other)
	NeighborhoodAllocator ()
bool	operator!= (const Self &other) const
Assignment	operator.*/const Self &operator= (const Self &other)
bool	operator== (const Self &other) const
TPixel &	operator[] (unsigned int i)
Data access methods *const TPixel &	operator[] (unsigned int i) const
Allocates or Reallocates a buffer of size n *void	set_size (unsigned int n)
unsigned int	size () const
	~NeighborhoodAllocator ()
Public Attributes
	m_ElementCount = n
Protected Attributes
TPixel *	m_Data
unsigned int	m_ElementCount

---

Member Typedef Documentation

template<class TPixel> typedef const TPixel* itk::NeighborhoodAllocator< TPixel >::const_iterator

Definition at line 46 of file itkNeighborhoodAllocator.h.

template<class TPixel> typedef TPixel* itk::NeighborhoodAllocator< TPixel >::iterator

Iterator support. Note that the naming of the typedefs is on purpose. itk::Neighborhood makes reference to the allocator, which because it may be vnl or other type, uses the lower case/underscore forms iterator and const_iterator. Definition at line 45 of file itkNeighborhoodAllocator.h.

template<class TPixel> typedef NeighborhoodAllocator itk::NeighborhoodAllocator< TPixel >::Self

Standard class typedefs. Definition at line 39 of file itkNeighborhoodAllocator.h.

---

Constructor & Destructor Documentation

template<class TPixel> itk::NeighborhoodAllocator< TPixel >::NeighborhoodAllocator (   )  [inline]

Default constructor Definition at line 49 of file itkNeighborhoodAllocator.h.

template<class TPixel> itk::NeighborhoodAllocator< TPixel >::~NeighborhoodAllocator (   )  [inline]

Default destructor Definition at line 52 of file itkNeighborhoodAllocator.h.

template<class TPixel> Copy constructor* itk::NeighborhoodAllocator< TPixel >::NeighborhoodAllocator (  const Self &  other  )  [inline]

Definition at line 72 of file itkNeighborhoodAllocator.h. References itk::NeighborhoodAllocator< TPixel >::m_ElementCount, itk::NeighborhoodAllocator< TPixel >::operator[](), and itk::NeighborhoodAllocator< TPixel >::set_size().

---

Member Function Documentation

template<class TPixel> const_iterator itk::NeighborhoodAllocator< TPixel >::begin (   )  const [inline]

Definition at line 107 of file itkNeighborhoodAllocator.h. References itk::NeighborhoodAllocator< TPixel >::m_Data.

template<class TPixel> STL style iterator support for the memory buffer* iterator itk::NeighborhoodAllocator< TPixel >::begin (   )  [inline]

Definition at line 105 of file itkNeighborhoodAllocator.h. References itk::NeighborhoodAllocator< TPixel >::m_Data.

template<class TPixel> const_iterator itk::NeighborhoodAllocator< TPixel >::end (   )  const [inline]

Definition at line 111 of file itkNeighborhoodAllocator.h. References itk::NeighborhoodAllocator< TPixel >::m_Data, and itk::NeighborhoodAllocator< TPixel >::m_ElementCount.

template<class TPixel> iterator itk::NeighborhoodAllocator< TPixel >::end (   )  [inline]

Definition at line 109 of file itkNeighborhoodAllocator.h. References itk::NeighborhoodAllocator< TPixel >::m_Data, and itk::NeighborhoodAllocator< TPixel >::m_ElementCount.

template<class TPixel> bool itk::NeighborhoodAllocator< TPixel >::operator!= (  const Self &  other  )  const [inline]

Not Equal operator. Definition at line 99 of file itkNeighborhoodAllocator.h. References itk::NeighborhoodAllocator< TPixel >::m_Data.

template<class TPixel> Assignment itk::NeighborhoodAllocator< TPixel >::operator.*/const Self &operator= (  const Self &  other  )  [inline]

Definition at line 82 of file itkNeighborhoodAllocator.h. References itk::NeighborhoodAllocator< TPixel >::m_ElementCount, itk::NeighborhoodAllocator< TPixel >::operator[](), and itk::NeighborhoodAllocator< TPixel >::set_size().

template<class TPixel> bool itk::NeighborhoodAllocator< TPixel >::operator== (  const Self &  other  )  const [inline]

Comparison operator. Definition at line 93 of file itkNeighborhoodAllocator.h. References itk::NeighborhoodAllocator< TPixel >::m_Data.

template<class TPixel> TPixel& itk::NeighborhoodAllocator< TPixel >::operator[] (  unsigned int  i  )  [inline]

Definition at line 120 of file itkNeighborhoodAllocator.h. References itk::NeighborhoodAllocator< TPixel >::m_Data.

template<class TPixel> Data access methods* const TPixel& itk::NeighborhoodAllocator< TPixel >::operator[] (  unsigned int  i  )  const [inline]

Definition at line 118 of file itkNeighborhoodAllocator.h. References itk::NeighborhoodAllocator< TPixel >::m_Data. Referenced by itk::NeighborhoodAllocator< TPixel >::NeighborhoodAllocator(), and itk::NeighborhoodAllocator< TPixel >::operator.*/const Self &operator=().

template<class TPixel> Allocates or Reallocates a buffer of size n* void itk::NeighborhoodAllocator< TPixel >::set_size (  unsigned int  n  )  [inline]

Definition at line 125 of file itkNeighborhoodAllocator.h. References itk::NeighborhoodAllocator< TPixel >::m_Data. Referenced by itk::NeighborhoodAllocator< TPixel >::NeighborhoodAllocator(), and itk::NeighborhoodAllocator< TPixel >::operator.*/const Self &operator=().

template<class TPixel> unsigned int itk::NeighborhoodAllocator< TPixel >::size (  void   )  const [inline]

Definition at line 113 of file itkNeighborhoodAllocator.h. References itk::NeighborhoodAllocator< TPixel >::m_ElementCount.

---

Member Data Documentation

template<class TPixel> TPixel* itk::NeighborhoodAllocator< TPixel >::m_Data [protected]

Definition at line 134 of file itkNeighborhoodAllocator.h. Referenced by itk::NeighborhoodAllocator< TPixel >::begin(), itk::NeighborhoodAllocator< TPixel >::end(), itk::NeighborhoodAllocator< TPixel >::operator!=(), itk::NeighborhoodAllocator< TPixel >::operator==(), itk::NeighborhoodAllocator< TPixel >::operator[](), and itk::NeighborhoodAllocator< TPixel >::set_size().

template<class TPixel> unsigned int itk::NeighborhoodAllocator< TPixel >::m_ElementCount [protected]

Definition at line 133 of file itkNeighborhoodAllocator.h.

template<class TPixel> itk::NeighborhoodAllocator< TPixel >::m_ElementCount = n

Definition at line 67 of file itkNeighborhoodAllocator.h. Referenced by itk::NeighborhoodAllocator< TPixel >::end(), itk::NeighborhoodAllocator< TPixel >::NeighborhoodAllocator(), itk::NeighborhoodAllocator< TPixel >::operator.*/const Self &operator=(), and itk::NeighborhoodAllocator< TPixel >::size().

---

The documentation for this class was generated from the following file:

• itkNeighborhoodAllocator.h

---