itk::NeighborhoodAccessorFunctor< TImage > Class Template Reference

Provides accessor interfaces to Get pixels and is meant to be used on pointers contained within Neighborhoods. A typical user should not need to use this class directly. This class is used by the neighborhood iterators to get pixels from pixel pointers or assign a pixel to an address. More...

#include <itkNeighborhoodAccessorFunctor.h>

List of all members.

Public Types
typedef TImage	ImageType
typedef ImageType::PixelType	PixelType
typedef ImageType::InternalPixelType	InternalPixelType
typedef unsigned int	VectorLengthType
typedef ImageType::OffsetType	OffsetType
typedef Neighborhood< InternalPixelType *, ::itk::GetImageDimension< TImage >::ImageDimension >	NeighborhoodType
typedef ImageBoundaryCondition< ImageType > const *	ImageBoundaryConditionConstPointerType
Public Member Functions
void	SetBegin (const InternalPixelType *)
PixelType	Get (const InternalPixelType *pixelPointer) const
void	Set (InternalPixelType *&pixelPointer, const PixelType &p) const
PixelType	BoundaryCondition (const OffsetType &point_index, const OffsetType &boundary_offset, const NeighborhoodType *data, const ImageBoundaryConditionConstPointerType boundaryCondition) const
void	SetVectorLength (VectorLengthType length)
VectorLengthType	SetVectorLength ()

---

Detailed Description

template<class TImage>
class itk::NeighborhoodAccessorFunctor< TImage >

Provides accessor interfaces to Get pixels and is meant to be used on pointers contained within Neighborhoods. A typical user should not need to use this class directly. This class is used by the neighborhood iterators to get pixels from pixel pointers or assign a pixel to an address.

Note:

This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149.

Definition at line 41 of file itkNeighborhoodAccessorFunctor.h.

---

Member Typedef Documentation

template<class TImage> typedef ImageBoundaryCondition< ImageType > const* itk::NeighborhoodAccessorFunctor< TImage >::ImageBoundaryConditionConstPointerType

Definition at line 54 of file itkNeighborhoodAccessorFunctor.h. Referenced by itk::NeighborhoodAccessorFunctor< TImage >::BoundaryCondition().

template<class TImage> typedef TImage itk::NeighborhoodAccessorFunctor< TImage >::ImageType

Definition at line 44 of file itkNeighborhoodAccessorFunctor.h.

template<class TImage> typedef ImageType::InternalPixelType itk::NeighborhoodAccessorFunctor< TImage >::InternalPixelType

Definition at line 46 of file itkNeighborhoodAccessorFunctor.h. Referenced by itk::NeighborhoodAccessorFunctor< TImage >::Get(), itk::NeighborhoodAccessorFunctor< TImage >::Set(), and itk::NeighborhoodAccessorFunctor< TImage >::SetBegin().

template<class TImage> typedef Neighborhood< InternalPixelType *, ::itk::GetImageDimension< TImage >::ImageDimension > itk::NeighborhoodAccessorFunctor< TImage >::NeighborhoodType

Definition at line 51 of file itkNeighborhoodAccessorFunctor.h. Referenced by itk::NeighborhoodAccessorFunctor< TImage >::BoundaryCondition().

template<class TImage> typedef ImageType::OffsetType itk::NeighborhoodAccessorFunctor< TImage >::OffsetType

Definition at line 48 of file itkNeighborhoodAccessorFunctor.h. Referenced by itk::NeighborhoodAccessorFunctor< TImage >::BoundaryCondition().

template<class TImage> typedef ImageType::PixelType itk::NeighborhoodAccessorFunctor< TImage >::PixelType

Definition at line 45 of file itkNeighborhoodAccessorFunctor.h. Referenced by itk::NeighborhoodAccessorFunctor< TImage >::BoundaryCondition(), itk::NeighborhoodAccessorFunctor< TImage >::Get(), and itk::NeighborhoodAccessorFunctor< TImage >::Set().

template<class TImage> typedef unsigned int itk::NeighborhoodAccessorFunctor< TImage >::VectorLengthType

Definition at line 47 of file itkNeighborhoodAccessorFunctor.h. Referenced by itk::NeighborhoodAccessorFunctor< TImage >::SetVectorLength().

---

Member Function Documentation

template<class TImage> PixelType itk::NeighborhoodAccessorFunctor< TImage >::BoundaryCondition (  const OffsetType &  point_index, const OffsetType &  boundary_offset, const NeighborhoodType *  data, const ImageBoundaryConditionConstPointerType  boundaryCondition )  const [inline]

Definition at line 76 of file itkNeighborhoodAccessorFunctor.h. References itk::NeighborhoodAccessorFunctor< TImage >::ImageBoundaryConditionConstPointerType, itk::NeighborhoodAccessorFunctor< TImage >::NeighborhoodType, itk::NeighborhoodAccessorFunctor< TImage >::OffsetType, and itk::NeighborhoodAccessorFunctor< TImage >::PixelType.

template<class TImage> PixelType itk::NeighborhoodAccessorFunctor< 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. Definition at line 65 of file itkNeighborhoodAccessorFunctor.h. References itk::NeighborhoodAccessorFunctor< TImage >::InternalPixelType, and itk::NeighborhoodAccessorFunctor< TImage >::PixelType.

template<class TImage> void itk::NeighborhoodAccessorFunctor< TImage >::Set (  InternalPixelType *&  pixelPointer, const PixelType &  p )  const [inline]

Method to set the pixel value at a certain pixel pointer Definition at line 71 of file itkNeighborhoodAccessorFunctor.h. References itk::NeighborhoodAccessorFunctor< TImage >::InternalPixelType, and itk::NeighborhoodAccessorFunctor< TImage >::PixelType.

template<class TImage> void itk::NeighborhoodAccessorFunctor< TImage >::SetBegin (  const InternalPixelType *   )  [inline]

Set the pointer index to the start of the buffer. Definition at line 57 of file itkNeighborhoodAccessorFunctor.h. References itk::NeighborhoodAccessorFunctor< TImage >::InternalPixelType.

template<class TImage> VectorLengthType itk::NeighborhoodAccessorFunctor< TImage >::SetVectorLength (   )  [inline]

Definition at line 86 of file itkNeighborhoodAccessorFunctor.h. References itk::NeighborhoodAccessorFunctor< TImage >::VectorLengthType.

template<class TImage> void itk::NeighborhoodAccessorFunctor< TImage >::SetVectorLength (  VectorLengthType  length  )  [inline]

Definition at line 85 of file itkNeighborhoodAccessorFunctor.h. References itk::NeighborhoodAccessorFunctor< TImage >::VectorLengthType.

---

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

• itkNeighborhoodAccessorFunctor.h

---