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

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

This boundary condition returns a constant value for out-of-bounds image pixels. More...

#include <itkConstantBoundaryCondition.h>

Inheritance diagram for itk::ConstantBoundaryCondition:

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

Collaboration graph
[legend]
List of all members.

Public Types

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

Public Methods

 itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
 ConstantBoundaryCondition ()
virtual PixelType operator() (const OffsetType &, const OffsetType &, const NeighborhoodType *) const
void SetConstant (const PixelType &c)
const PixelTypeGetConstant () const

Detailed Description

template<class TImage>
class itk::ConstantBoundaryCondition< TImage >

This boundary condition returns a constant value for out-of-bounds image pixels.

For example, invoking this function object with a constant value of zero (the default) on each out-of-bounds element of a 7x5 iterator that masks a region at an image corner (iterator is centered on the 2):

* * * * * * * * * * * * * * * * 1 2 3 4 5 (where * denotes pixels that lie * * 3 3 5 5 6 outside of the image boundary) * * 4 4 6 7 8

would produce the following neighborhood of values:

0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 2 3 4 5 0 0 3 3 5 5 6 0 0 4 4 6 7 8

See also:
ImageBoundaryCondition

Definition at line 57 of file itkConstantBoundaryCondition.h.


Member Typedef Documentation

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

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 68 of file itkConstantBoundaryCondition.h.

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

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 70 of file itkConstantBoundaryCondition.h.

Referenced by itk::ConstantBoundaryCondition< TImage >::operator()().

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

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 69 of file itkConstantBoundaryCondition.h.

Referenced by itk::ConstantBoundaryCondition< TImage >::operator()().

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

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 67 of file itkConstantBoundaryCondition.h.

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

Extract information from the image type

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 66 of file itkConstantBoundaryCondition.h.

Referenced by itk::ConstantBoundaryCondition< TImage >::GetConstant(), itk::ConstantBoundaryCondition< TImage >::operator()(), and itk::ConstantBoundaryCondition< TImage >::SetConstant().

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

Self & superclass typedefs

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 62 of file itkConstantBoundaryCondition.h.

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

Definition at line 63 of file itkConstantBoundaryCondition.h.


Constructor & Destructor Documentation

template<class TImage>
itk::ConstantBoundaryCondition< TImage >::ConstantBoundaryCondition   [inline]
 

Default constructor.

Definition at line 76 of file itkConstantBoundaryCondition.h.


Member Function Documentation

template<class TImage>
const PixelType& itk::ConstantBoundaryCondition< TImage >::GetConstant   const [inline]
 

Get the value of the constant.

Definition at line 91 of file itkConstantBoundaryCondition.h.

References itk::ConstantBoundaryCondition< TImage >::PixelType.

template<class TImage>
itk::ConstantBoundaryCondition< TImage >::itkStaticConstMacro ImageDimension   ,
unsigned    int,
Superclass::ImageDimension   
 

Save the image dimension.

template<class TImage>
virtual PixelType itk::ConstantBoundaryCondition< TImage >::operator() const OffsetType  ,
const OffsetType  ,
const NeighborhoodType  
const [inline, virtual]
 

Computes and returns appropriate out-of-bounds values from neighborhood iterator data.

Implements itk::ImageBoundaryCondition< TImage >.

Definition at line 81 of file itkConstantBoundaryCondition.h.

References itk::ConstantBoundaryCondition< TImage >::NeighborhoodType, itk::ConstantBoundaryCondition< TImage >::OffsetType, and itk::ConstantBoundaryCondition< TImage >::PixelType.

template<class TImage>
void itk::ConstantBoundaryCondition< TImage >::SetConstant const PixelType   c [inline]
 

Set the value of the constant.

Definition at line 87 of file itkConstantBoundaryCondition.h.

References itk::ConstantBoundaryCondition< TImage >::PixelType.


The documentation for this class was generated from the following file:
Generated at Fri May 21 01:23:12 2004 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000