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

#include <itkConstantBoundaryCondition.h>

Inheritance diagram for itk::ConstantBoundaryCondition< TImage >:

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

[legend]List of all members.

---

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

Note:

If you are using an image with Array as the pixel type, you will need to set the constant explicitly with an array of the appropriate length. This is also true if your image type is a VectorImage.

See also:

ImageBoundaryCondition

Definition at line 60 of file itkConstantBoundaryCondition.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 ConstantBoundaryCondition	Self
typedef ImageBoundaryCondition< TImage >	Superclass
Public Member Functions
	ConstantBoundaryCondition ()
const PixelType &	GetConstant () const
	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 &, const OffsetType &, const NeighborhoodType *, const NeighborhoodAccessorFunctorType &) const
virtual PixelType	operator() (const OffsetType &, const OffsetType &, const NeighborhoodType *) const
bool	RequiresCompleteNeighborhood ()
void	SetConstant (const PixelType &c)

---

Member Typedef Documentation

template<class TImage>

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

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 71 of file itkConstantBoundaryCondition.h.

template<class TImage>

typedef Superclass::NeighborhoodAccessorFunctorType itk::ConstantBoundaryCondition< TImage >::NeighborhoodAccessorFunctorType

Functor used to access pixels from a neighborhood of pixel pointers

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 76 of file itkConstantBoundaryCondition.h.

template<class TImage>

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

Type of the data container passed to this function object.

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 73 of file itkConstantBoundaryCondition.h.

template<class TImage>

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

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 72 of file itkConstantBoundaryCondition.h.

template<class TImage>

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

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 70 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 69 of file itkConstantBoundaryCondition.h.

template<class TImage>

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

Self & superclass typedefs

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 65 of file itkConstantBoundaryCondition.h.

template<class TImage>

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

Definition at line 66 of file itkConstantBoundaryCondition.h.

---

Constructor & Destructor Documentation

template<class TImage>

itk::ConstantBoundaryCondition< TImage >::ConstantBoundaryCondition

(

)

[inline]

Default constructor.

Definition at line 82 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 106 of file itkConstantBoundaryCondition.h.

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

Extract information from the image type

template<class TImage>

itk::ConstantBoundaryCondition< TImage >::itkStaticConstMacro	(	ImageDimension	,
		unsigned	int,
		Superclass::ImageDimension
	)

Save the image dimension.

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::ConstantBoundaryCondition< TImage >::operator()	(	const OffsetType &	,
		const OffsetType &	,
		const NeighborhoodType *	,
		const NeighborhoodAccessorFunctorType &
	)			const [inline, virtual]

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

Definition at line 94 of file itkConstantBoundaryCondition.h.

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.

Definition at line 87 of file itkConstantBoundaryCondition.h.

template<class TImage>

bool itk::ConstantBoundaryCondition< TImage >::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.

Reimplemented from itk::ImageBoundaryCondition< TImage >.

Definition at line 112 of file itkConstantBoundaryCondition.h.

template<class TImage>

void itk::ConstantBoundaryCondition< TImage >::SetConstant

(

const PixelType &

c

)

[inline]

Set the value of the constant.

Definition at line 102 of file itkConstantBoundaryCondition.h.

---

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

• itkConstantBoundaryCondition.h

---