Orfeo Toolbox  4.0
Public Types | Public Member Functions | Static Public Attributes | List of all members
itk::ImageBoundaryCondition< TInputImage, TOutputImage > Class Template Referenceabstract

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< TInputImage, TOutputImage >:

Public Types

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

Public Member Functions

 ImageBoundaryCondition ()
 
virtual ~ImageBoundaryCondition ()
 
virtual RegionType GetInputRequestedRegion (const RegionType &inputLargestPossibleRegion, const RegionType &outputRequestedRegion) const
 
virtual const char * GetNameOfClass () const
 
virtual OutputPixelType GetPixel (const IndexType &index, const TInputImage *image) const =0
 
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 ()
 

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension
 

Detailed Description

template<typename TInputImage, typename 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<typename TInputImage, typename TOutputImage = TInputImage>
typedef Index< itkGetStaticConstMacro(ImageDimension) > itk::ImageBoundaryCondition< TInputImage, TOutputImage >::IndexType

Definition at line 66 of file itkImageBoundaryCondition.h.

template<typename TInputImage, typename TOutputImage = TInputImage>
typedef TInputImage::NeighborhoodAccessorFunctorType itk::ImageBoundaryCondition< TInputImage, TOutputImage >::NeighborhoodAccessorFunctorType

Functor used to access pixels from a neighborhood of pixel pointers

Definition at line 77 of file itkImageBoundaryCondition.h.

template<typename TInputImage, typename TOutputImage = TInputImage>
typedef Neighborhood< PixelPointerType, itkGetStaticConstMacro(ImageDimension) > itk::ImageBoundaryCondition< TInputImage, TOutputImage >::NeighborhoodType

Type of the data container passed to this function object.

Definition at line 73 of file itkImageBoundaryCondition.h.

template<typename TInputImage, typename TOutputImage = TInputImage>
typedef Offset< itkGetStaticConstMacro(ImageDimension) > itk::ImageBoundaryCondition< TInputImage, TOutputImage >::OffsetType

Definition at line 68 of file itkImageBoundaryCondition.h.

template<typename TInputImage, typename TOutputImage = TInputImage>
typedef TOutputImage::PixelType itk::ImageBoundaryCondition< TInputImage, TOutputImage >::OutputPixelType

Definition at line 65 of file itkImageBoundaryCondition.h.

template<typename TInputImage, typename TOutputImage = TInputImage>
typedef TInputImage::InternalPixelType* itk::ImageBoundaryCondition< TInputImage, TOutputImage >::PixelPointerType

Definition at line 64 of file itkImageBoundaryCondition.h.

template<typename TInputImage, typename TOutputImage = TInputImage>
typedef TInputImage::PixelType itk::ImageBoundaryCondition< TInputImage, TOutputImage >::PixelType

Extract information from the image type

Definition at line 63 of file itkImageBoundaryCondition.h.

template<typename TInputImage, typename TOutputImage = TInputImage>
typedef ImageRegion< itkGetStaticConstMacro(ImageDimension) > itk::ImageBoundaryCondition< TInputImage, TOutputImage >::RegionType

Definition at line 69 of file itkImageBoundaryCondition.h.

template<typename TInputImage, typename TOutputImage = TInputImage>
typedef ImageBoundaryCondition itk::ImageBoundaryCondition< TInputImage, TOutputImage >::Self

Standard typedefs.

Definition at line 60 of file itkImageBoundaryCondition.h.

template<typename TInputImage, typename TOutputImage = TInputImage>
typedef Size< itkGetStaticConstMacro(ImageDimension) > itk::ImageBoundaryCondition< TInputImage, TOutputImage >::SizeType

Definition at line 67 of file itkImageBoundaryCondition.h.

Constructor & Destructor Documentation

template<typename TInputImage, typename TOutputImage = TInputImage>
itk::ImageBoundaryCondition< TInputImage, TOutputImage >::ImageBoundaryCondition ( )
inline

Default constructor.

Definition at line 80 of file itkImageBoundaryCondition.h.

template<typename TInputImage, typename TOutputImage = TInputImage>
virtual itk::ImageBoundaryCondition< TInputImage, TOutputImage >::~ImageBoundaryCondition ( )
inlinevirtual

Definition at line 110 of file itkImageBoundaryCondition.h.

Member Function Documentation

template<typename TInputImage, typename TOutputImage = TInputImage>
virtual RegionType itk::ImageBoundaryCondition< TInputImage, TOutputImage >::GetInputRequestedRegion ( const RegionType inputLargestPossibleRegion,
const RegionType outputRequestedRegion 
) const
inlinevirtual

Determines the necessary input region for an output region given the largest possible region of the input image. Subclasses should override this method to efficiently support streaming.

Parameters
inputLargestPossibleRegionLargest possible region of the input image.
outputRequestedRegionThe output requested region.
Returns
The necessary input region required to determine the pixel values in the outputRequestedRegion.

Reimplemented in itk::ConstantBoundaryCondition< InputImageType >, itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >, itk::ZeroFluxNeumannBoundaryCondition< ImageType >, itk::ZeroFluxNeumannBoundaryCondition< itk::Image >, itk::ZeroFluxNeumannBoundaryCondition< TInputImage >, itk::ZeroFluxNeumannBoundaryCondition< TImage >, itk::ZeroFluxNeumannBoundaryCondition< FixedImageType >, itk::ZeroFluxNeumannBoundaryCondition< InputImageType >, itk::ZeroFluxNeumannBoundaryCondition< TImageType >, itk::ZeroFluxNeumannBoundaryCondition< TDisplacementField >, itk::ZeroFluxNeumannBoundaryCondition< TSparseImageType >, and itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >.

Definition at line 129 of file itkImageBoundaryCondition.h.

template<typename TInputImage, typename TOutputImage = TInputImage>
virtual const char* itk::ImageBoundaryCondition< TInputImage, TOutputImage >::GetNameOfClass ( ) const
inlinevirtual
template<typename TInputImage, typename TOutputImage = TInputImage>
virtual OutputPixelType itk::ImageBoundaryCondition< TInputImage, TOutputImage >::GetPixel ( const IndexType index,
const TInputImage *  image 
) const
pure virtual
template<typename TInputImage, typename TOutputImage = TInputImage>
virtual OutputPixelType itk::ImageBoundaryCondition< TInputImage, TOutputImage >::operator() ( const OffsetType point_index,
const OffsetType boundary_offset,
const NeighborhoodType data 
) const
pure virtual
template<typename TInputImage, typename 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<typename TInputImage, typename TOutputImage = TInputImage>
virtual void itk::ImageBoundaryCondition< TInputImage, TOutputImage >::Print ( std::ostream &  os,
Indent  i = 0 
) const
inlinevirtual

Utility for printing the boundary condition.

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

Definition at line 89 of file itkImageBoundaryCondition.h.

template<typename TInputImage, typename TOutputImage = TInputImage>
virtual bool itk::ImageBoundaryCondition< TInputImage, TOutputImage >::RequiresCompleteNeighborhood ( )
inlinevirtual

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

Member Data Documentation

template<typename TInputImage, typename TOutputImage = TInputImage>
const unsigned int itk::ImageBoundaryCondition< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension
static

Extract information from the image type

Definition at line 57 of file itkImageBoundaryCondition.h.


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

Generated at Sat Mar 8 2014 17:11:21 for Orfeo Toolbox with doxygen 1.8.3.1