ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes
itk::ImageBoundaryCondition< TInputImage, TOutputImage > Class Template Reference

#include <itkImageBoundaryCondition.h>

+ Inheritance diagram for itk::ImageBoundaryCondition< TInputImage, TOutputImage >:

List of all members.

Public Types

typedef
TInputImage::NeighborhoodAccessorFunctorType 
NeighborhoodAccessorFunctorType
typedef Neighborhood
< PixelPointerType,
itkGetStaticConstMacro(ImageDimension) > 
NeighborhoodType
typedef ImageBoundaryCondition Self
typedef TInputImage::PixelType PixelType
typedef
TInputImage::InternalPixelType * 
PixelPointerType
typedef TOutputImage::PixelType OutputPixelType
typedef Index
< itkGetStaticConstMacro(ImageDimension) > 
IndexType
typedef Size
< itkGetStaticConstMacro(ImageDimension) > 
SizeType
typedef Offset
< itkGetStaticConstMacro(ImageDimension) > 
OffsetType
typedef ImageRegion
< itkGetStaticConstMacro(ImageDimension) > 
RegionType

Public Member Functions

virtual const char * GetNameOfClass () const
virtual OutputPixelType GetPixel (const IndexType &index, const TInputImage *image) const =0
 ImageBoundaryCondition ()
virtual OutputPixelType operator() (const OffsetType &point_index, const OffsetType &boundary_offset, const NeighborhoodType *data) const =0
virtual OutputPixelType operator() (const OffsetType &point_index, const OffsetType &boundary_offset, const NeighborhoodType *data, const NeighborhoodAccessorFunctorType &neighborhoodAccessorFunctor) const =0
virtual void Print (std::ostream &os, Indent i=0) const
virtual bool RequiresCompleteNeighborhood ()
virtual ~ImageBoundaryCondition ()
virtual RegionType GetInputRequestedRegion (const RegionType &inputLargestPossibleRegion, const RegionType &outputRequestedRegion) const

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension

Detailed Description

template<class TInputImage, class TOutputImage = TInputImage>
class itk::ImageBoundaryCondition< TInputImage, TOutputImage >

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 TInputImage, class TOutputImage = TInputImage>
typedef Index< itkGetStaticConstMacro(ImageDimension) > itk::ImageBoundaryCondition< TInputImage, TOutputImage >::IndexType
template<class TInputImage, class TOutputImage = TInputImage>
typedef TInputImage::NeighborhoodAccessorFunctorType itk::ImageBoundaryCondition< TInputImage, TOutputImage >::NeighborhoodAccessorFunctorType
template<class TInputImage, class TOutputImage = TInputImage>
typedef Neighborhood< PixelPointerType, itkGetStaticConstMacro(ImageDimension) > itk::ImageBoundaryCondition< TInputImage, TOutputImage >::NeighborhoodType
template<class TInputImage, class TOutputImage = TInputImage>
typedef Offset< itkGetStaticConstMacro(ImageDimension) > itk::ImageBoundaryCondition< TInputImage, TOutputImage >::OffsetType
template<class TInputImage, class TOutputImage = TInputImage>
typedef TOutputImage::PixelType itk::ImageBoundaryCondition< TInputImage, TOutputImage >::OutputPixelType
template<class TInputImage, class TOutputImage = TInputImage>
typedef TInputImage::InternalPixelType* itk::ImageBoundaryCondition< TInputImage, TOutputImage >::PixelPointerType
template<class TInputImage, class TOutputImage = TInputImage>
typedef TInputImage::PixelType itk::ImageBoundaryCondition< TInputImage, TOutputImage >::PixelType
template<class TInputImage, class TOutputImage = TInputImage>
typedef ImageRegion< itkGetStaticConstMacro(ImageDimension) > itk::ImageBoundaryCondition< TInputImage, TOutputImage >::RegionType
template<class TInputImage, class TOutputImage = TInputImage>
typedef ImageBoundaryCondition itk::ImageBoundaryCondition< TInputImage, TOutputImage >::Self
template<class TInputImage, class TOutputImage = TInputImage>
typedef Size< itkGetStaticConstMacro(ImageDimension) > itk::ImageBoundaryCondition< TInputImage, TOutputImage >::SizeType

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage = TInputImage>
itk::ImageBoundaryCondition< TInputImage, TOutputImage >::ImageBoundaryCondition ( ) [inline]

Default constructor.

Definition at line 82 of file itkImageBoundaryCondition.h.

template<class TInputImage, class TOutputImage = TInputImage>
virtual itk::ImageBoundaryCondition< TInputImage, TOutputImage >::~ImageBoundaryCondition ( ) [inline, virtual]

Definition at line 112 of file itkImageBoundaryCondition.h.


Member Function Documentation

template<class TInputImage, class TOutputImage = TInputImage>
virtual RegionType itk::ImageBoundaryCondition< TInputImage, TOutputImage >::GetInputRequestedRegion ( const RegionType inputLargestPossibleRegion,
const RegionType outputRequestedRegion 
) const [inline, virtual]
template<class TInputImage, class TOutputImage = TInputImage>
virtual const char* itk::ImageBoundaryCondition< TInputImage, TOutputImage >::GetNameOfClass ( ) const [inline, virtual]
template<class TInputImage, class TOutputImage = TInputImage>
virtual OutputPixelType itk::ImageBoundaryCondition< TInputImage, TOutputImage >::GetPixel ( const IndexType index,
const TInputImage *  image 
) const [pure virtual]
template<class TInputImage, class TOutputImage = TInputImage>
virtual OutputPixelType itk::ImageBoundaryCondition< TInputImage, TOutputImage >::operator() ( const OffsetType point_index,
const OffsetType boundary_offset,
const NeighborhoodType data 
) const [pure virtual]
template<class TInputImage, class TOutputImage = TInputImage>
virtual OutputPixelType itk::ImageBoundaryCondition< TInputImage, TOutputImage >::operator() ( const OffsetType point_index,
const OffsetType boundary_offset,
const NeighborhoodType data,
const NeighborhoodAccessorFunctorType neighborhoodAccessorFunctor 
) const [pure virtual]
template<class TInputImage, class TOutputImage = TInputImage>
virtual void itk::ImageBoundaryCondition< TInputImage, TOutputImage >::Print ( std::ostream &  os,
Indent  i = 0 
) const [inline, virtual]

Utility for printing the boundary condition.

Reimplemented in itk::ConstantBoundaryCondition< TInputImage, TOutputImage >, and itk::ConstantBoundaryCondition< InputImageType >.

Definition at line 91 of file itkImageBoundaryCondition.h.

template<class TInputImage, class TOutputImage = TInputImage>
virtual bool itk::ImageBoundaryCondition< TInputImage, TOutputImage >::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< TInputImage, TOutputImage >, and itk::ConstantBoundaryCondition< InputImageType >.

Definition at line 120 of file itkImageBoundaryCondition.h.


Member Data Documentation

template<class TInputImage, class TOutputImage = TInputImage>
const unsigned int itk::ImageBoundaryCondition< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension [static]

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