ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | List of all members
itk::NeighborhoodAccessorFunctor< TImage > Class Template Referencefinal

#include <itkNeighborhoodAccessorFunctor.h>

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.

Public Types

template<typename TOutput = ImageType>
using ImageBoundaryConditionType = ImageBoundaryCondition< ImageType, TOutput >
 
using ImageType = TImage
 
using InternalPixelType = typename ImageType::InternalPixelType
 
using NeighborhoodType = Neighborhood< InternalPixelType *, Self::ImageDimension >
 
using OffsetType = typename ImageType::OffsetType
 
using PixelType = typename ImageType::PixelType
 
using Self = NeighborhoodAccessorFunctor
 
using VectorLengthType = unsigned int
 

Public Member Functions

template<typename TOutput >
ImageBoundaryConditionType< TOutput >::OutputPixelType BoundaryCondition (const OffsetType &point_index, const OffsetType &boundary_offset, const NeighborhoodType *data, const ImageBoundaryConditionType< TOutput > *boundaryCondition) const
 
PixelType Get (const InternalPixelType *pixelPointer) const
 
void Set (InternalPixelType *const pixelPointer, const PixelType &p) const
 
void SetBegin (const InternalPixelType *)
 
VectorLengthType SetVectorLength ()
 
void SetVectorLength (VectorLengthType)
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TImage::ImageDimension
 

Member Typedef Documentation

◆ ImageBoundaryConditionType

template<typename TImage >
template<typename TOutput = ImageType>
using itk::NeighborhoodAccessorFunctor< TImage >::ImageBoundaryConditionType = ImageBoundaryCondition<ImageType, TOutput>

Definition at line 55 of file itkNeighborhoodAccessorFunctor.h.

◆ ImageType

template<typename TImage >
using itk::NeighborhoodAccessorFunctor< TImage >::ImageType = TImage

Definition at line 45 of file itkNeighborhoodAccessorFunctor.h.

◆ InternalPixelType

template<typename TImage >
using itk::NeighborhoodAccessorFunctor< TImage >::InternalPixelType = typename ImageType::InternalPixelType

Definition at line 47 of file itkNeighborhoodAccessorFunctor.h.

◆ NeighborhoodType

template<typename TImage >
using itk::NeighborhoodAccessorFunctor< TImage >::NeighborhoodType = Neighborhood<InternalPixelType *, Self::ImageDimension>

Definition at line 52 of file itkNeighborhoodAccessorFunctor.h.

◆ OffsetType

template<typename TImage >
using itk::NeighborhoodAccessorFunctor< TImage >::OffsetType = typename ImageType::OffsetType

Definition at line 49 of file itkNeighborhoodAccessorFunctor.h.

◆ PixelType

template<typename TImage >
using itk::NeighborhoodAccessorFunctor< TImage >::PixelType = typename ImageType::PixelType

Definition at line 46 of file itkNeighborhoodAccessorFunctor.h.

◆ Self

template<typename TImage >
using itk::NeighborhoodAccessorFunctor< TImage >::Self = NeighborhoodAccessorFunctor

Definition at line 44 of file itkNeighborhoodAccessorFunctor.h.

◆ VectorLengthType

template<typename TImage >
using itk::NeighborhoodAccessorFunctor< TImage >::VectorLengthType = unsigned int

Definition at line 48 of file itkNeighborhoodAccessorFunctor.h.

Member Function Documentation

◆ BoundaryCondition()

template<typename TImage >
template<typename TOutput >
ImageBoundaryConditionType< TOutput >::OutputPixelType itk::NeighborhoodAccessorFunctor< TImage >::BoundaryCondition ( const OffsetType point_index,
const OffsetType boundary_offset,
const NeighborhoodType data,
const ImageBoundaryConditionType< TOutput > *  boundaryCondition 
) const
inline

Definition at line 83 of file itkNeighborhoodAccessorFunctor.h.

◆ Get()

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 69 of file itkNeighborhoodAccessorFunctor.h.

◆ Set()

template<typename TImage >
void itk::NeighborhoodAccessorFunctor< TImage >::Set ( InternalPixelType *const  pixelPointer,
const PixelType p 
) const
inline

Method to set the pixel value at a certain pixel pointer

Definition at line 76 of file itkNeighborhoodAccessorFunctor.h.

◆ SetBegin()

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

Set the pointer index to the start of the buffer.

Definition at line 59 of file itkNeighborhoodAccessorFunctor.h.

◆ SetVectorLength() [1/2]

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

Definition at line 93 of file itkNeighborhoodAccessorFunctor.h.

◆ SetVectorLength() [2/2]

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

Definition at line 91 of file itkNeighborhoodAccessorFunctor.h.

Member Data Documentation

◆ ImageDimension

template<typename TImage >
constexpr unsigned int itk::NeighborhoodAccessorFunctor< TImage >::ImageDimension = TImage::ImageDimension
staticconstexpr

Definition at line 51 of file itkNeighborhoodAccessorFunctor.h.


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