Orfeo Toolbox  4.0
Public Types | Public Member Functions | Static Public Attributes | List of all members
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>

Public Types

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

Public Member Functions

 NeighborhoodAccessorFunctor ()
 
virtual ~NeighborhoodAccessorFunctor ()
 
PixelType BoundaryCondition (const OffsetType &point_index, const OffsetType &boundary_offset, const NeighborhoodType *data, const ImageBoundaryConditionConstPointerType boundaryCondition) const
 
PixelType Get (const InternalPixelType *pixelPointer) const
 
void Set (InternalPixelType *&pixelPointer, const PixelType &p) const
 
void SetBegin (const InternalPixelType *)
 
void SetVectorLength (VectorLengthType)
 
VectorLengthType SetVectorLength ()
 

Static Public Attributes

static const unsigned int ImageDimension = TImage::ImageDimension
 

Detailed Description

template<typename 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

Definition at line 55 of file itkNeighborhoodAccessorFunctor.h.

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

Definition at line 45 of file itkNeighborhoodAccessorFunctor.h.

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

Definition at line 47 of file itkNeighborhoodAccessorFunctor.h.

Definition at line 52 of file itkNeighborhoodAccessorFunctor.h.

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

Definition at line 49 of file itkNeighborhoodAccessorFunctor.h.

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

Definition at line 46 of file itkNeighborhoodAccessorFunctor.h.

template<typename TImage >
typedef NeighborhoodAccessorFunctor itk::NeighborhoodAccessorFunctor< TImage >::Self

Definition at line 44 of file itkNeighborhoodAccessorFunctor.h.

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

Definition at line 48 of file itkNeighborhoodAccessorFunctor.h.

Constructor & Destructor Documentation

template<typename TImage >
itk::NeighborhoodAccessorFunctor< TImage >::NeighborhoodAccessorFunctor ( )
inline

Constructor

Definition at line 90 of file itkNeighborhoodAccessorFunctor.h.

template<typename TImage >
virtual itk::NeighborhoodAccessorFunctor< TImage >::~NeighborhoodAccessorFunctor ( )
inlinevirtual

Destructor

Definition at line 93 of file itkNeighborhoodAccessorFunctor.h.

Member Function Documentation

template<typename 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 77 of file itkNeighborhoodAccessorFunctor.h.

template<typename 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 66 of file itkNeighborhoodAccessorFunctor.h.

template<typename 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 72 of file itkNeighborhoodAccessorFunctor.h.

template<typename TImage >
void itk::NeighborhoodAccessorFunctor< TImage >::SetBegin ( const InternalPixelType )
inline

Set the pointer index to the start of the buffer.

Definition at line 58 of file itkNeighborhoodAccessorFunctor.h.

template<typename TImage >
void itk::NeighborhoodAccessorFunctor< TImage >::SetVectorLength ( VectorLengthType  )
inline

Definition at line 86 of file itkNeighborhoodAccessorFunctor.h.

template<typename TImage >
VectorLengthType itk::NeighborhoodAccessorFunctor< TImage >::SetVectorLength ( )
inline

Definition at line 87 of file itkNeighborhoodAccessorFunctor.h.

Member Data Documentation

template<typename TImage >
const unsigned int itk::NeighborhoodAccessorFunctor< TImage >::ImageDimension = TImage::ImageDimension
static

Definition at line 51 of file itkNeighborhoodAccessorFunctor.h.


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

Generated at Sat Mar 8 2014 17:31:42 for Orfeo Toolbox with doxygen 1.8.3.1