itk::ImageBoundaryCondition< TImageType > Class Template Reference
[Data Representation Objects, Image Representation Objects]

A virtual base object that defines an interface to a class of boundary condition objects for use by neighborhood iterators. More...

#include <itkImageBoundaryCondition.h>

Inheritance diagram for itk::ImageBoundaryCondition:

[legend]List of all members.

Public Types
typedef ImageBoundaryCondition	Self
typedef Neighborhood< PixelPointerType, itkGetStaticConstMacro(ImageDimension)	NeighborhoodType )
typedef TImageType::PixelType	PixelType
typedef TImageType::InternalPixelType *	PixelPointerType
typedef Index< itkGetStaticConstMacro(ImageDimension)	IndexType )
typedef Offset< itkGetStaticConstMacro(ImageDimension)	OffsetType )
Public Methods
	itkStaticConstMacro (ImageDimension, unsigned int, TImageType::ImageDimension)
	ImageBoundaryCondition ()
virtual PixelType	operator() (const OffsetType &point_index, const OffsetType &boundary_offset, const NeighborhoodType *data) const=0

---

Detailed Description

template<class TImageType>
class itk::ImageBoundaryCondition< TImageType >

A virtual base object that defines an interface to a class of boundary condition objects for use by neighborhood iterators.

A boundary condition object supplies a phantom pixel value when given a neighborhood of (pointers to) image values, the (ND) index of the phantom pixel, and its (ND) offset from the boundary. The index of the phantom pixel is relative to the "upper left-hand corner" of the neighborhood (as opposed to its center).

Associated Types Description ---------------- ----------- PixelType The data type of the return value. PixelPointerType A pointer to PixelType. PixelPointerTypeNeighborhood A neighborhood of PixelPointerTypes that points to the pixel values in an image neighborhood.

Definition at line 52 of file itkImageBoundaryCondition.h.

---

Member Typedef Documentation

template<class TImageType> typedef Index<itkGetStaticConstMacro(ImageDimension) itk::ImageBoundaryCondition< TImageType >::IndexType)

Extract information from the image type Reimplemented in itk::ConstantBoundaryCondition< TImage >, and itk::ZeroFluxNeumannBoundaryCondition< TImage >. Definition at line 66 of file itkImageBoundaryCondition.h.

template<class TImageType> typedef Neighborhood<PixelPointerType, itkGetStaticConstMacro(ImageDimension) itk::ImageBoundaryCondition< TImageType >::NeighborhoodType)

Type of the data container passed to this function object. Reimplemented in itk::ConstantBoundaryCondition< TImage >, and itk::ZeroFluxNeumannBoundaryCondition< TImage >. Definition at line 72 of file itkImageBoundaryCondition.h.

template<class TImageType> typedef Offset<itkGetStaticConstMacro(ImageDimension) itk::ImageBoundaryCondition< TImageType >::OffsetType)

Extract information from the image type Reimplemented in itk::ConstantBoundaryCondition< TImage >, and itk::ZeroFluxNeumannBoundaryCondition< TImage >. Definition at line 67 of file itkImageBoundaryCondition.h.

template<class TImageType> typedef TImageType::InternalPixelType* itk::ImageBoundaryCondition< TImageType >::PixelPointerType

Extract information from the image type Reimplemented in itk::ConstantBoundaryCondition< TImage >, and itk::ZeroFluxNeumannBoundaryCondition< TImage >. Definition at line 65 of file itkImageBoundaryCondition.h.

template<class TImageType> typedef TImageType::PixelType itk::ImageBoundaryCondition< TImageType >::PixelType

Extract information from the image type Reimplemented in itk::ConstantBoundaryCondition< TImage >, and itk::ZeroFluxNeumannBoundaryCondition< TImage >. Definition at line 64 of file itkImageBoundaryCondition.h.

template<class TImageType> typedef ImageBoundaryCondition itk::ImageBoundaryCondition< TImageType >::Self

Standard typedefs. Reimplemented in itk::ConstantBoundaryCondition< TImage >, and itk::ZeroFluxNeumannBoundaryCondition< TImage >. Definition at line 61 of file itkImageBoundaryCondition.h.

---

Constructor & Destructor Documentation

template<class TImageType> itk::ImageBoundaryCondition< TImageType >::ImageBoundaryCondition (    )  [inline]

Default constructor. Definition at line 75 of file itkImageBoundaryCondition.h.

---

Member Function Documentation

template<class TImageType> itk::ImageBoundaryCondition< TImageType >::itkStaticConstMacro (  ImageDimension   , unsigned    int, TImageType::ImageDimension    )

Extract information from the image type

template<class TImageType> virtual PixelType itk::ImageBoundaryCondition< TImageType >::operator() (  const OffsetType &    point_index, const OffsetType &    boundary_offset, const NeighborhoodType *    data )  const [pure virtual]

Returns a value for a given out-of-bounds pixel. The arguments are the phantom pixel (ND) index within the neighborhood, the pixel's offset from the nearest image border pixel, and a neighborhood of pointers to pixel values in the image. Implemented in itk::ConstantBoundaryCondition< TImage >, and itk::ZeroFluxNeumannBoundaryCondition< TImage >.

---

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

• itkImageBoundaryCondition.h

---