Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::PeriodicBoundaryCondition< TImage > Class Template Reference
[Data Representation ObjectsImage Representation Objects]

#include <itkPeriodicBoundaryCondition.h>

Inheritance diagram for itk::PeriodicBoundaryCondition< TImage >:

Inheritance graph
[legend]
Collaboration diagram for itk::PeriodicBoundaryCondition< TImage >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class TImage>
class itk::PeriodicBoundaryCondition< TImage >

A function object that determines values outside of image boundaries according to periodic (wrap-around) conditions.

The input to this function object is a neighborhood iterator. This boundary condition object is designed to be given as a template argument to a NeighborhoodIterator or any of the NeighborhoodIterator subclasses.

Definition at line 38 of file itkPeriodicBoundaryCondition.h.

Public Types

typedef Superclass::IndexType IndexType
typedef Superclass::NeighborhoodAccessorFunctorType NeighborhoodAccessorFunctorType
typedef Superclass::NeighborhoodType NeighborhoodType
typedef Superclass::OffsetType OffsetType
typedef Superclass::PixelPointerType PixelPointerType
typedef Superclass::PixelType PixelType
typedef PeriodicBoundaryCondition Self
typedef ImageBoundaryCondition<
TImage > 
Superclass

Public Member Functions

 itkStaticConstMacro (ImageDimension, unsigned int, TImage::ImageDimension)
 itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
virtual PixelType operator() (const OffsetType &point_index, const OffsetType &boundary_offset, const NeighborhoodType *data, const NeighborhoodAccessorFunctorType &neighborhoodAccessorFunctor) const =0
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
 PeriodicBoundaryCondition ()
virtual bool RequiresCompleteNeighborhood ()
virtual PixelType operator() (const OffsetType &point_index, const OffsetType &boundary_offset, const NeighborhoodType *data, const NeighborhoodAccessorFunctorType &neighborhoodAccessorFunctor) const


Member Typedef Documentation

template<class TImage>
typedef Superclass::IndexType itk::PeriodicBoundaryCondition< TImage >::IndexType

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 49 of file itkPeriodicBoundaryCondition.h.

template<class TImage>
typedef Superclass::NeighborhoodAccessorFunctorType itk::PeriodicBoundaryCondition< TImage >::NeighborhoodAccessorFunctorType

Functor used to access pixels from a neighborhood of pixel pointers

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 54 of file itkPeriodicBoundaryCondition.h.

template<class TImage>
typedef Superclass::NeighborhoodType itk::PeriodicBoundaryCondition< TImage >::NeighborhoodType

Type of the data container passed to this function object.

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 51 of file itkPeriodicBoundaryCondition.h.

template<class TImage>
typedef Superclass::OffsetType itk::PeriodicBoundaryCondition< TImage >::OffsetType

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 50 of file itkPeriodicBoundaryCondition.h.

template<class TImage>
typedef Superclass::PixelPointerType itk::PeriodicBoundaryCondition< TImage >::PixelPointerType

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 48 of file itkPeriodicBoundaryCondition.h.

template<class TImage>
typedef Superclass::PixelType itk::PeriodicBoundaryCondition< TImage >::PixelType

Extract information from the image type.

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 47 of file itkPeriodicBoundaryCondition.h.

template<class TImage>
typedef PeriodicBoundaryCondition itk::PeriodicBoundaryCondition< TImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 43 of file itkPeriodicBoundaryCondition.h.

template<class TImage>
typedef ImageBoundaryCondition<TImage> itk::PeriodicBoundaryCondition< TImage >::Superclass

Definition at line 44 of file itkPeriodicBoundaryCondition.h.


Constructor & Destructor Documentation

template<class TImage>
itk::PeriodicBoundaryCondition< TImage >::PeriodicBoundaryCondition (  )  [inline]

Default constructor.

Definition at line 60 of file itkPeriodicBoundaryCondition.h.


Member Function Documentation

itk::ImageBoundaryCondition< TImage >::itkStaticConstMacro ( ImageDimension  ,
unsigned  int,
TImage ::ImageDimension   
) [inherited]

Extract information from the image type

template<class TImage>
itk::PeriodicBoundaryCondition< TImage >::itkStaticConstMacro ( ImageDimension  ,
unsigned  int,
Superclass::ImageDimension   
)

Extract information from the image type.

virtual PixelType itk::ImageBoundaryCondition< TImage >::operator() ( const OffsetType point_index,
const OffsetType boundary_offset,
const NeighborhoodType data,
const NeighborhoodAccessorFunctorType neighborhoodAccessorFunctor 
) const [pure virtual, inherited]

Computes and returns the appropriate pixel value from neighborhood iterator data, using the functor.

virtual PixelType itk::ImageBoundaryCondition< TImage >::operator() ( const OffsetType point_index,
const OffsetType boundary_offset,
const NeighborhoodType data 
) const [pure virtual, inherited]

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::ZeroFluxNeumannBoundaryCondition< >.

template<class TImage>
virtual PixelType itk::PeriodicBoundaryCondition< TImage >::operator() ( const OffsetType point_index,
const OffsetType boundary_offset,
const NeighborhoodType data,
const NeighborhoodAccessorFunctorType neighborhoodAccessorFunctor 
) const [virtual]

Computes and returns the appropriate pixel value from neighborhood iterator data, using the functor.

template<class TImage>
virtual PixelType itk::PeriodicBoundaryCondition< TImage >::operator() ( const OffsetType point_index,
const OffsetType boundary_offset,
const NeighborhoodType data 
) const [virtual]

Computes and returns a neighborhood of appropriate values from neighborhood iterator data..

virtual bool itk::ImageBoundaryCondition< TImage >::RequiresCompleteNeighborhood (  )  [inline, virtual, inherited]

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 >.

Definition at line 104 of file itkImageBoundaryCondition.h.


The documentation for this class was generated from the following file:
Generated at Mon Mar 12 09:14:37 2007 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000