Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
Public Types | Public Member Functions | Static Public Attributes

itk::ImageBoundaryCondition< TImageType > Class Template Reference
[Data Representation ObjectsImage 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< TImageType >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef
TImageType::NeighborhoodAccessorFunctorType 
NeighborhoodAccessorFunctorType
typedef Neighborhood
< PixelPointerType,
itkGetStaticConstMacro(ImageDimension)> 
NeighborhoodType
typedef ImageBoundaryCondition Self

typedef TImageType::PixelType PixelType
typedef
TImageType::InternalPixelType * 
PixelPointerType
typedef Index
< itkGetStaticConstMacro(ImageDimension)> 
IndexType
typedef Offset
< itkGetStaticConstMacro(ImageDimension)> 
OffsetType

Public Member Functions

 ImageBoundaryCondition ()
virtual PixelType operator() (const OffsetType &point_index, const OffsetType &boundary_offset, const NeighborhoodType *data) const =0
virtual PixelType operator() (const OffsetType &point_index, const OffsetType &boundary_offset, const NeighborhoodType *data, const NeighborhoodAccessorFunctorType &neighborhoodAccessorFunctor) const =0
virtual ~ImageBoundaryCondition ()

virtual bool RequiresCompleteNeighborhood ()

Static Public Attributes

static const unsigned int ImageDimension = TImageType::ImageDimension

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 51 of file itkImageBoundaryCondition.h.


Member Typedef Documentation

template<class TImageType>
typedef Index<itkGetStaticConstMacro(ImageDimension)> itk::ImageBoundaryCondition< TImageType >::IndexType
template<class TImageType>
typedef TImageType::NeighborhoodAccessorFunctorType itk::ImageBoundaryCondition< TImageType >::NeighborhoodAccessorFunctorType
template<class TImageType>
typedef Neighborhood<PixelPointerType, itkGetStaticConstMacro(ImageDimension)> itk::ImageBoundaryCondition< TImageType >::NeighborhoodType
template<class TImageType>
typedef Offset<itkGetStaticConstMacro(ImageDimension)> itk::ImageBoundaryCondition< TImageType >::OffsetType
template<class TImageType>
typedef TImageType::InternalPixelType* itk::ImageBoundaryCondition< TImageType >::PixelPointerType
template<class TImageType>
typedef TImageType::PixelType itk::ImageBoundaryCondition< TImageType >::PixelType
template<class TImageType>
typedef ImageBoundaryCondition itk::ImageBoundaryCondition< TImageType >::Self

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 78 of file itkImageBoundaryCondition.h.

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

Definition at line 96 of file itkImageBoundaryCondition.h.


Member Function Documentation

template<class TImageType>
virtual PixelType itk::ImageBoundaryCondition< TImageType >::operator() ( const OffsetType point_index,
const OffsetType boundary_offset,
const NeighborhoodType data 
) const [pure virtual]
template<class TImageType>
virtual PixelType itk::ImageBoundaryCondition< TImageType >::operator() ( const OffsetType point_index,
const OffsetType boundary_offset,
const NeighborhoodType data,
const NeighborhoodAccessorFunctorType neighborhoodAccessorFunctor 
) const [pure virtual]
template<class TImageType>
virtual bool itk::ImageBoundaryCondition< TImageType >::RequiresCompleteNeighborhood (  )  [inline, virtual]

Tell if the boundary condition can index to any location within the associated iterator's neighborhood or if it has some limited subset (such as none) that it relies upon. Subclasses should override this method if they can safely limit indexes to active pixels (or no pixels).

Reimplemented in itk::ConstantBoundaryCondition< TImage >, and itk::ConstantBoundaryCondition< InputImageType >.

Definition at line 104 of file itkImageBoundaryCondition.h.


Member Data Documentation

template<class TImageType>
const unsigned int itk::ImageBoundaryCondition< TImageType >::ImageDimension = TImageType::ImageDimension [static]

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

Generated at Mon Jul 12 2010 23:09:16 for ITK by doxygen 1.7.1 written by Dimitri van Heesch, © 1997-2000