itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage > Class Template Reference

#include <itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h>

Detailed Description

template<class TImage>
class itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >

Provides accessor interfaces to Access pixels and is meant to be used on pointers to pixels held by the Neighborhood class.

A typical user should not need to use this class. The class is internally used by the neighborhood iterators.

Author

Pew-Thian Yap (ptyap.nosp@m.@med.nosp@m..unc..nosp@m.edu)

Definition at line 36 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

Public Types
typedef ImageBoundaryCondition< ImageType > const *	ImageBoundaryConditionConstPointerType
typedef TImage	ImageType
typedef ImageType::InternalPixelType	InternalPixelType
typedef Neighborhood< InternalPixelType *, TImage::ImageDimension >	NeighborhoodType
typedef ImageType::OffsetType	OffsetType
typedef ImageType::PixelType	PixelType
typedef unsigned int	VectorLengthType

Public Member Functions
PixelType	BoundaryCondition (const OffsetType &point_index, const OffsetType &boundary_offset, const NeighborhoodType *data, const ImageBoundaryConditionConstPointerType boundaryCondition) const
PixelType	Get (const InternalPixelType *pixelPointer) const
VectorLengthType	GetVectorLength ()
void	Set (InternalPixelType *&pixelPointer, const PixelType &p) const
void	SetBegin (const InternalPixelType *begin)
void	SetVectorLength (VectorLengthType length)
	SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor (PixelType fillBufferValue, VectorLengthType length)
	SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor ()

Private Attributes
InternalPixelType *	m_Begin
PixelType	m_FillBufferValue
VectorLengthType	m_VectorLength

Member Typedef Documentation

template<class TImage >

typedef ImageBoundaryCondition< ImageType > const* itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::ImageBoundaryConditionConstPointerType

Definition at line 49 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

template<class TImage >

typedef TImage itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::ImageType

Definition at line 39 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

template<class TImage >

typedef ImageType::InternalPixelType itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::InternalPixelType

Definition at line 41 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

template<class TImage >

typedef Neighborhood< InternalPixelType *, TImage::ImageDimension> itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::NeighborhoodType

Definition at line 46 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

template<class TImage >

typedef ImageType::OffsetType itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::OffsetType

Definition at line 42 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

template<class TImage >

typedef ImageType::PixelType itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::PixelType

Definition at line 40 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

template<class TImage >

typedef unsigned int itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::VectorLengthType

Definition at line 43 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

Constructor & Destructor Documentation

template<class TImage >

itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor ( PixelType  fillBufferValue, VectorLengthType  length  )

inline

Definition at line 51 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

template<class TImage >

itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor ( )

inline

Definition at line 54 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

Member Function Documentation

template<class TImage >

PixelType itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::BoundaryCondition ( const OffsetType &  point_index, const OffsetType &  boundary_offset, const NeighborhoodType *  data, const ImageBoundaryConditionConstPointerType  boundaryCondition  ) const

inline

Definition at line 122 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

template<class TImage >

PixelType itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::Get ( const InternalPixelType *  pixelPointer ) const

inline

Method to dereference a pixel pointer. This is used from the ConstNeighborhoodIterator as the equivalent operation to (*it). This method should be preferred over the former (*it) notation. The reason is that dereferencing a pointer to a location of VectorImage pixel involves a different operation that simply dereferencing the pointer. Here a PixelType (array of InternalPixelType s) is created on the stack and returned.

Definition at line 80 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

References itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::m_FillBufferValue, and itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::m_VectorLength.

template<class TImage >

VectorLengthType itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::GetVectorLength ( )

inline

Required for some filters to compile.

Definition at line 138 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

References itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::m_VectorLength.

template<class TImage >

void itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::Set ( InternalPixelType *&  pixelPointer, const PixelType &  p  ) const

inline

Method to set the pixel value at a certain pixel pointer

Definition at line 106 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

References itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::m_VectorLength.

template<class TImage >

void itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::SetBegin ( const InternalPixelType *  begin )

inline

Set the pointer index to the start of the buffer. This must be set by the iterators to the starting location of the buffer. Typically a neighborhood iterator iterating on a neighborhood of an Image, say image will set this in its constructor. For instance:

ConstNeighborhoodIterator( radius, image, )
  {
  ...
  m_NeighborhoodAccessorFunctor.SetBegin( image->GetBufferPointer() );
  }

Definition at line 70 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

References itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::m_Begin.

template<class TImage >

void itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::SetVectorLength ( VectorLengthType  length )

inline

Required for some filters to compile.

Definition at line 132 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

References itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::m_VectorLength.

Member Data Documentation

template<class TImage >

InternalPixelType* itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::m_Begin

private

Definition at line 145 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

Referenced by itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::SetBegin().

template<class TImage >

PixelType itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::m_FillBufferValue

private

Definition at line 144 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

Referenced by itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::Get().

template<class TImage >

VectorLengthType itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::m_VectorLength

private

Definition at line 147 of file itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h.

Referenced by itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::Get(), itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::GetVectorLength(), itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::Set(), and itk::SpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor< TImage >::SetVectorLength().

---

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

• ThirdParty/SpatiallyDenseSparseVectorImage/include/itkSpatiallyDenseSparseVectorImageNeighborhoodAccessorFunctor.h