itk::ConstantBoundaryCondition< TInputImage, TOutputImage > Class Template Reference

#include <itkConstantBoundaryCondition.h>

Inheritance diagram for itk::ConstantBoundaryCondition< TInputImage, TOutputImage >:

Collaboration diagram for itk::ConstantBoundaryCondition< TInputImage, TOutputImage >:

Public Types
using	IndexType = typename Superclass::IndexType
using	NeighborhoodAccessorFunctorType = typename Superclass::NeighborhoodAccessorFunctorType
using	NeighborhoodType = typename Superclass::NeighborhoodType
using	OffsetType = typename Superclass::OffsetType
using	OutputPixelType = typename Superclass::OutputPixelType
using	PixelPointerType = typename Superclass::PixelPointerType
using	PixelType = typename Superclass::PixelType
using	RegionType = typename Superclass::RegionType
using	Self = ConstantBoundaryCondition
using	SizeType = typename Superclass::SizeType
using	Superclass = ImageBoundaryCondition< TInputImage, TOutputImage >
Public Types inherited from itk::ImageBoundaryCondition< TInputImage, TOutputImage >
using	IndexType = Index< ImageDimension >
using	InputImageType = TInputImage
using	NeighborhoodAccessorFunctorType = typename TInputImage::NeighborhoodAccessorFunctorType
using	NeighborhoodType = Neighborhood< PixelPointerType, ImageDimension >
using	OffsetType = Offset< ImageDimension >
using	OutputImageType = TOutputImage
using	OutputPixelType = typename TOutputImage::PixelType
using	PixelPointerType = typename TInputImage::InternalPixelType *
using	PixelType = typename TInputImage::PixelType
using	RegionType = ImageRegion< ImageDimension >
using	Self = ImageBoundaryCondition
using	SizeType = Size< ImageDimension >

Public Member Functions
	ConstantBoundaryCondition ()
const OutputPixelType &	GetConstant () const
RegionType	GetInputRequestedRegion (const RegionType &inputLargestPossibleRegion, const RegionType &outputRequestedRegion) const override
const char *	GetNameOfClass () const override
OutputPixelType	GetPixel (const IndexType &index, const TInputImage *image) const override
template<typename TPixel >
void	Initialize (const VariableLengthVector< TPixel > *)
OutputPixelType	operator() (const OffsetType &, const OffsetType &, const NeighborhoodType *) const override
OutputPixelType	operator() (const OffsetType &, const OffsetType &, const NeighborhoodType *, const NeighborhoodAccessorFunctorType &) const override
void	Print (std::ostream &os, Indent i=0) const override
bool	RequiresCompleteNeighborhood () override
void	SetConstant (const OutputPixelType &c)
Public Member Functions inherited from itk::ImageBoundaryCondition< TInputImage, TOutputImage >
	ImageBoundaryCondition ()=default
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	~ImageBoundaryCondition ()=default
virtual RegionType	GetInputRequestedRegion (const RegionType &inputLargestPossibleRegion, const RegionType &outputRequestedRegion) const
virtual OutputPixelType	GetPixel (const IndexType &index, const TInputImage *image) const =0

Static Public Attributes
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::ImageBoundaryCondition< TInputImage, TOutputImage >
static constexpr unsigned int	ImageDimension = TInputImage::ImageDimension

Private Attributes
OutputPixelType	m_Constant

Detailed Description

template<typename TInputImage, typename TOutputImage = TInputImage>
class itk::ConstantBoundaryCondition< TInputImage, TOutputImage >

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

ITK Sphinx Examples:

• All ITK Sphinx Examples

• Make Out Of Bounds Pixels Return Constant Value

Examples

SphinxExamples/src/Core/Common/MakeOutOfBoundsPixelsReturnConstValue/Code.cxx.

Definition at line 68 of file itkConstantBoundaryCondition.h.

Member Typedef Documentation

IndexType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::IndexType = typename Superclass::IndexType

Definition at line 80 of file itkConstantBoundaryCondition.h.

NeighborhoodAccessorFunctorType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::NeighborhoodAccessorFunctorType = typename Superclass::NeighborhoodAccessorFunctorType

Definition at line 85 of file itkConstantBoundaryCondition.h.

NeighborhoodType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::NeighborhoodType = typename Superclass::NeighborhoodType

Definition at line 83 of file itkConstantBoundaryCondition.h.

OffsetType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::OffsetType = typename Superclass::OffsetType

Definition at line 82 of file itkConstantBoundaryCondition.h.

OutputPixelType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::OutputPixelType = typename Superclass::OutputPixelType

Definition at line 78 of file itkConstantBoundaryCondition.h.

PixelPointerType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::PixelPointerType = typename Superclass::PixelPointerType

Definition at line 77 of file itkConstantBoundaryCondition.h.

PixelType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::PixelType = typename Superclass::PixelType

Extract information from the image type

Definition at line 76 of file itkConstantBoundaryCondition.h.

RegionType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::RegionType = typename Superclass::RegionType

Definition at line 79 of file itkConstantBoundaryCondition.h.

Self

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::Self = ConstantBoundaryCondition

Self & superclass type alias

Definition at line 72 of file itkConstantBoundaryCondition.h.

SizeType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::SizeType = typename Superclass::SizeType

Definition at line 81 of file itkConstantBoundaryCondition.h.

Superclass

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::Superclass = ImageBoundaryCondition<TInputImage, TOutputImage>

Definition at line 73 of file itkConstantBoundaryCondition.h.

Constructor & Destructor Documentation

ConstantBoundaryCondition()

template<typename TInputImage, typename TOutputImage = TInputImage>

itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::ConstantBoundaryCondition

(

)

Default constructor.

Member Function Documentation

GetConstant()

template<typename TInputImage, typename TOutputImage = TInputImage>

const OutputPixelType& itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::GetConstant

(

)

const

Get the value of the constant.

GetInputRequestedRegion()

template<typename TInputImage, typename TOutputImage = TInputImage>

RegionType itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::GetInputRequestedRegion ( const RegionType &  inputLargestPossibleRegion, const RegionType &  outputRequestedRegion  ) const

override

Determines the necessary input region for the output region. For this boundary condition, only the intersection of the largest possible image region and the output requested region is needed.

Parameters

inputLargestPossibleRegion	Largest possible region of the input image.
outputRequestedRegion	The output requested region.

Returns

The necessary input region required to determine the pixel values in the outputRequestedRegion.

GetNameOfClass()

template<typename TInputImage, typename TOutputImage = TInputImage>

const char* itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::GetNameOfClass ( ) const

inlineoverridevirtual

Runtime information support.

Reimplemented from itk::ImageBoundaryCondition< TInputImage, TOutputImage >.

Definition at line 95 of file itkConstantBoundaryCondition.h.

GetPixel()

template<typename TInputImage, typename TOutputImage = TInputImage>

OutputPixelType itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::GetPixel ( const IndexType &  index, const TInputImage *  image  ) const

override

Returns a value for a given pixel at an index. If the index is inside the bounds of the input image, then the pixel value is obtained from the input image. Otherwise, the constant value is returned.

Parameters

index	The index of the desired pixel.
image	The image from which pixel values should be determined.

Initialize()

template<typename TInputImage, typename TOutputImage = TInputImage>

template<typename TPixel >

void itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::Initialize

(

const VariableLengthVector< TPixel > *

)

Special version of initialize for images with pixel type VariableLengthVector.

operator()() [1/2]

template<typename TInputImage, typename TOutputImage = TInputImage>

OutputPixelType itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::operator() ( const OffsetType &  , const OffsetType &  , const NeighborhoodType *    ) const

override

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

operator()() [2/2]

template<typename TInputImage, typename TOutputImage = TInputImage>

OutputPixelType itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::operator() ( const OffsetType &  , const OffsetType &  , const NeighborhoodType *  , const NeighborhoodAccessorFunctorType &    ) const

override

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

Print()

template<typename TInputImage, typename TOutputImage = TInputImage>

void itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::Print ( std::ostream &  os, Indent  i = 0  ) const

overridevirtual

Utility for printing the boundary condition.

Reimplemented from itk::ImageBoundaryCondition< TInputImage, TOutputImage >.

RequiresCompleteNeighborhood()

template<typename TInputImage, typename TOutputImage = TInputImage>

bool itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::RequiresCompleteNeighborhood ( )

inlineoverridevirtual

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

Definition at line 135 of file itkConstantBoundaryCondition.h.

SetConstant()

template<typename TInputImage, typename TOutputImage = TInputImage>

void itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::SetConstant

(

const OutputPixelType &

c

)

Set the value of the constant.

Referenced by itk::BoxAccumulateFunction(), and itk::BoxSquareAccumulateFunction().

Member Data Documentation

ImageDimension

template<typename TInputImage, typename TOutputImage = TInputImage>

constexpr unsigned int itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Save the image dimension.

Definition at line 88 of file itkConstantBoundaryCondition.h.

m_Constant

template<typename TInputImage, typename TOutputImage = TInputImage>

OutputPixelType itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::m_Constant

private

Definition at line 164 of file itkConstantBoundaryCondition.h.

---

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

• itkConstantBoundaryCondition.h