ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Private Attributes | List of all members
itk::VectorImageNeighborhoodAccessorFunctor< TImage > Class Template Reference

#include <itkVectorImageNeighborhoodAccessorFunctor.h>

Detailed Description

template<typename TImage>
class itk::VectorImageNeighborhoodAccessorFunctor< 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.

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 itkVectorImageNeighborhoodAccessorFunctor.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 SetVectorLength (VectorLengthType length)
 
 VectorImageNeighborhoodAccessorFunctor (VectorLengthType length)
 
 VectorImageNeighborhoodAccessorFunctor ()
 
void SetBegin (const InternalPixelType *begin)
 

Private Attributes

InternalPixelTypem_Begin
 
VectorLengthType m_OffsetMultiplier
 
VectorLengthType m_VectorLength
 

Member Typedef Documentation

Definition at line 54 of file itkVectorImageNeighborhoodAccessorFunctor.h.

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

Definition at line 44 of file itkVectorImageNeighborhoodAccessorFunctor.h.

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

Definition at line 46 of file itkVectorImageNeighborhoodAccessorFunctor.h.

template<typename TImage >
typedef Neighborhood< InternalPixelType *, TImage ::ImageDimension > itk::VectorImageNeighborhoodAccessorFunctor< TImage >::NeighborhoodType

Definition at line 51 of file itkVectorImageNeighborhoodAccessorFunctor.h.

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

Definition at line 48 of file itkVectorImageNeighborhoodAccessorFunctor.h.

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

Definition at line 45 of file itkVectorImageNeighborhoodAccessorFunctor.h.

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

Definition at line 47 of file itkVectorImageNeighborhoodAccessorFunctor.h.

Constructor & Destructor Documentation

Definition at line 56 of file itkVectorImageNeighborhoodAccessorFunctor.h.

Definition at line 58 of file itkVectorImageNeighborhoodAccessorFunctor.h.

Member Function Documentation

template<typename TImage >
PixelType itk::VectorImageNeighborhoodAccessorFunctor< TImage >::BoundaryCondition ( const OffsetType point_index,
const OffsetType boundary_offset,
const NeighborhoodType data,
const ImageBoundaryConditionConstPointerType  boundaryCondition 
) const
inline

Definition at line 102 of file itkVectorImageNeighborhoodAccessorFunctor.h.

template<typename TImage >
PixelType itk::VectorImageNeighborhoodAccessorFunctor< 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 85 of file itkVectorImageNeighborhoodAccessorFunctor.h.

References itk::VectorImageNeighborhoodAccessorFunctor< TImage >::m_Begin, itk::VectorImageNeighborhoodAccessorFunctor< TImage >::m_OffsetMultiplier, and itk::VectorImageNeighborhoodAccessorFunctor< TImage >::m_VectorLength.

template<typename TImage >
VectorLengthType itk::VectorImageNeighborhoodAccessorFunctor< TImage >::GetVectorLength ( )
inline

Methods to Set/Get vector length. This should be the length of a block of pixels in the VectorImage.

Definition at line 121 of file itkVectorImageNeighborhoodAccessorFunctor.h.

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

template<typename TImage >
void itk::VectorImageNeighborhoodAccessorFunctor< TImage >::Set ( InternalPixelType *&  pixelPointer,
const PixelType p 
) const
inline
template<typename TImage >
void itk::VectorImageNeighborhoodAccessorFunctor< 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 74 of file itkVectorImageNeighborhoodAccessorFunctor.h.

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

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

Methods to Set/Get vector length. This should be the length of a block of pixels in the VectorImage.

Definition at line 113 of file itkVectorImageNeighborhoodAccessorFunctor.h.

References itk::VectorImageNeighborhoodAccessorFunctor< TImage >::m_OffsetMultiplier, and itk::VectorImageNeighborhoodAccessorFunctor< TImage >::m_VectorLength.

Member Data Documentation

template<typename TImage >
InternalPixelType* itk::VectorImageNeighborhoodAccessorFunctor< TImage >::m_Begin
private
template<typename TImage >
VectorLengthType itk::VectorImageNeighborhoodAccessorFunctor< TImage >::m_OffsetMultiplier
private
template<typename TImage >
VectorLengthType itk::VectorImageNeighborhoodAccessorFunctor< TImage >::m_VectorLength
private

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