itk::NeighborhoodAllocator< TPixel > Class Template Reference

#include <itkNeighborhoodAllocator.h>

Inheritance diagram for itk::NeighborhoodAllocator< TPixel >:

Collaboration diagram for itk::NeighborhoodAllocator< TPixel >:

Detailed Description

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

A memory allocator for use as the default allocator type in Neighborhood.

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 41 of file itkNeighborhoodAllocator.h.

Public Types
typedef const TPixel *	const_iterator
typedef TPixel *	iterator
typedef NeighborhoodAllocator	Self

Public Member Functions
	NeighborhoodAllocator ()
bool	operator!= (const Self &other) const
bool	operator== (const Self &other) const
	~NeighborhoodAllocator ()
void	Allocate (unsigned int n)
void	Deallocate ()
	NeighborhoodAllocator (const Self &other)
const Self &	operator= (const Self &other)
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
unsigned int	size () const
const TPixel &	operator[] (unsigned int i) const
TPixel &	operator[] (unsigned int i)
void	set_size (unsigned int n)

Protected Attributes
TPixel *	m_Data
unsigned int	m_ElementCount

Member Typedef Documentation

template<typename TPixel>

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

Definition at line 52 of file itkNeighborhoodAllocator.h.

template<typename 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 51 of file itkNeighborhoodAllocator.h.

template<typename TPixel>

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

Standard class typedefs.

Definition at line 45 of file itkNeighborhoodAllocator.h.

Constructor & Destructor Documentation

template<typename TPixel>

itk::NeighborhoodAllocator< TPixel >::NeighborhoodAllocator ( )

inline

Default constructor

Definition at line 55 of file itkNeighborhoodAllocator.h.

template<typename TPixel>

itk::NeighborhoodAllocator< TPixel >::~NeighborhoodAllocator ( )

inline

Default destructor

Definition at line 58 of file itkNeighborhoodAllocator.h.

template<typename TPixel>

itk::NeighborhoodAllocator< TPixel >::NeighborhoodAllocator ( const Self &  other )

inline

Copy constructor.

Definition at line 78 of file itkNeighborhoodAllocator.h.

Member Function Documentation

template<typename TPixel>

void itk::NeighborhoodAllocator< TPixel >::Allocate ( unsigned int  n )

inline

Allocates memory using new()

Definition at line 62 of file itkNeighborhoodAllocator.h.

Referenced by itk::NeighborhoodAllocator< InputImagePixelType >::set_size().

template<typename TPixel>

iterator itk::NeighborhoodAllocator< TPixel >::begin ( )

inline

STL-style iterator support for the memory buffer.

Definition at line 118 of file itkNeighborhoodAllocator.h.

Referenced by itk::operator<<().

template<typename TPixel>

const_iterator itk::NeighborhoodAllocator< TPixel >::begin ( ) const

inline

STL-style iterator support for the memory buffer.

Definition at line 120 of file itkNeighborhoodAllocator.h.

template<typename TPixel>

void itk::NeighborhoodAllocator< TPixel >::Deallocate ( )

inline

Deallocates memory using delete[]().

Definition at line 70 of file itkNeighborhoodAllocator.h.

Referenced by itk::NeighborhoodAllocator< InputImagePixelType >::set_size(), and itk::NeighborhoodAllocator< InputImagePixelType >::~NeighborhoodAllocator().

template<typename TPixel>

iterator itk::NeighborhoodAllocator< TPixel >::end ( )

inline

STL-style iterator support for the memory buffer.

Definition at line 122 of file itkNeighborhoodAllocator.h.

template<typename TPixel>

const_iterator itk::NeighborhoodAllocator< TPixel >::end ( ) const

inline

STL-style iterator support for the memory buffer.

Definition at line 124 of file itkNeighborhoodAllocator.h.

template<typename TPixel>

bool itk::NeighborhoodAllocator< TPixel >::operator!= ( const Self &  other ) const

inline

Not Equal operator.

Definition at line 112 of file itkNeighborhoodAllocator.h.

template<typename TPixel>

const Self& itk::NeighborhoodAllocator< TPixel >::operator= ( const Self &  other )

inline

Assignment operator.

Definition at line 90 of file itkNeighborhoodAllocator.h.

template<typename TPixel>

bool itk::NeighborhoodAllocator< TPixel >::operator== ( const Self &  other ) const

inline

Comparison operator.

Definition at line 106 of file itkNeighborhoodAllocator.h.

template<typename TPixel>

const TPixel& itk::NeighborhoodAllocator< TPixel >::operator[] ( unsigned int  i ) const

inline

Data access methods

Definition at line 131 of file itkNeighborhoodAllocator.h.

Referenced by itk::NeighborhoodAllocator< InputImagePixelType >::NeighborhoodAllocator(), and itk::NeighborhoodAllocator< InputImagePixelType >::operator=().

template<typename TPixel>

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

inline

Data access methods

Definition at line 133 of file itkNeighborhoodAllocator.h.

template<typename TPixel>

void itk::NeighborhoodAllocator< TPixel >::set_size ( unsigned int  n )

inline

Allocates or Reallocates a buffer of size n

Definition at line 138 of file itkNeighborhoodAllocator.h.

Referenced by itk::NeighborhoodAllocator< InputImagePixelType >::NeighborhoodAllocator(), and itk::NeighborhoodAllocator< InputImagePixelType >::operator=().

template<typename TPixel>

unsigned int itk::NeighborhoodAllocator< TPixel >::size ( ) const

inline

STL-style iterator support for the memory buffer.

Definition at line 126 of file itkNeighborhoodAllocator.h.

Referenced by itk::operator<<().

Member Data Documentation

template<typename TPixel>

TPixel* itk::NeighborhoodAllocator< TPixel >::m_Data

protected

Definition at line 147 of file itkNeighborhoodAllocator.h.

Referenced by itk::NeighborhoodAllocator< InputImagePixelType >::Allocate(), itk::NeighborhoodAllocator< InputImagePixelType >::begin(), itk::NeighborhoodAllocator< InputImagePixelType >::Deallocate(), itk::NeighborhoodAllocator< InputImagePixelType >::end(), itk::NeighborhoodAllocator< InputImagePixelType >::operator!=(), itk::NeighborhoodAllocator< InputImagePixelType >::operator==(), itk::NeighborhoodAllocator< InputImagePixelType >::operator[](), and itk::NeighborhoodAllocator< InputImagePixelType >::set_size().

template<typename TPixel>

unsigned int itk::NeighborhoodAllocator< TPixel >::m_ElementCount

protected

Definition at line 146 of file itkNeighborhoodAllocator.h.

Referenced by itk::NeighborhoodAllocator< InputImagePixelType >::Allocate(), itk::NeighborhoodAllocator< InputImagePixelType >::Deallocate(), itk::NeighborhoodAllocator< InputImagePixelType >::end(), itk::NeighborhoodAllocator< InputImagePixelType >::NeighborhoodAllocator(), itk::NeighborhoodAllocator< InputImagePixelType >::operator=(), and itk::NeighborhoodAllocator< InputImagePixelType >::size().

---

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

• itkNeighborhoodAllocator.h