#include <itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h>

Detailed Description

template<typename TImage>
class itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >

ImageNeighborhoodPixelAccessPolicy class for ShapedImageNeighborhoodRange. Allows getting and setting the value of a pixel, located in a specified neighborhood location, at a specified offset. Uses a constant as value for pixels outside the image border.

See also: ShapedNeighborhoodIterator; ConstantBoundaryCondition

Definition at line 42 of file itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h.

Public Types
using	PixelAccessParameterType = PixelType

Public Member Functions
	ConstantBoundaryImageNeighborhoodPixelAccessPolicy ()=delete

	ConstantBoundaryImageNeighborhoodPixelAccessPolicy (const ConstantBoundaryImageNeighborhoodPixelAccessPolicy &)=default

PixelType	GetPixelValue (const InternalPixelType *const imageBufferPointer) const noexcept

ConstantBoundaryImageNeighborhoodPixelAccessPolicy &	operator= (const ConstantBoundaryImageNeighborhoodPixelAccessPolicy &)=delete

	~ConstantBoundaryImageNeighborhoodPixelAccessPolicy ()=default


	ConstantBoundaryImageNeighborhoodPixelAccessPolicy (const ImageSizeType &imageSize, const OffsetType &offsetTable, const NeighborhoodAccessorFunctorType &neighborhoodAccessor, const IndexType &pixelIndex, const PixelType constant={}) noexcept


void	SetPixelValue (InternalPixelType *const imageBufferPointer, const PixelType &pixelValue) const noexcept

Private Types
using	ImageDimensionType = typename TImage::ImageDimensionType

using	ImageSizeType = Size< ImageDimension >

using	ImageSizeValueType = SizeValueType

using	IndexType = Index< ImageDimension >

using	InternalPixelType = typename TImage::InternalPixelType

using	NeighborhoodAccessorFunctorType = typename TImage::NeighborhoodAccessorFunctorType

using	OffsetType = Offset< ImageDimension >

using	PixelType = typename TImage::PixelType

Static Private Member Functions
static IndexValueType	CalculatePixelIndexValue (const OffsetType &offsetTable, const IndexType &pixelIndex) noexcept

static bool	IsInside (const IndexType &pixelIndex, const ImageSizeType &imageSize) noexcept

Private Attributes
const PixelType	m_Constant

const NeighborhoodAccessorFunctorType &	m_NeighborhoodAccessor

const IndexValueType	m_PixelIndexValue

Static Private Attributes
static constexpr ImageDimensionType	ImageDimension = TImage::ImageDimension

Member Typedef Documentation

◆ ImageDimensionType

template<typename TImage >

using itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::ImageDimensionType = typename TImage::ImageDimensionType

private

Definition at line 49 of file itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h.

◆ ImageSizeType

template<typename TImage >

using itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::ImageSizeType = Size<ImageDimension>

private

Definition at line 54 of file itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h.

◆ ImageSizeValueType

template<typename TImage >

using itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::ImageSizeValueType = SizeValueType

private

Definition at line 55 of file itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h.

◆ IndexType

template<typename TImage >

using itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::IndexType = Index<ImageDimension>

private

Definition at line 52 of file itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h.

◆ InternalPixelType

template<typename TImage >

using itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::InternalPixelType = typename TImage::InternalPixelType

private

Definition at line 47 of file itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h.

◆ NeighborhoodAccessorFunctorType

template<typename TImage >

using itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::NeighborhoodAccessorFunctorType = typename TImage::NeighborhoodAccessorFunctorType

private

Definition at line 45 of file itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h.

◆ OffsetType

template<typename TImage >

using itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::OffsetType = Offset<ImageDimension>

private

Definition at line 53 of file itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h.

◆ PixelAccessParameterType

template<typename TImage >

using itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::PixelAccessParameterType = PixelType

This type is necessary to tell the ShapedImageNeighborhoodRange that the constructor accepts a pixel value as (optional) extra parameter.

Definition at line 103 of file itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h.

◆ PixelType

template<typename TImage >

using itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::PixelType = typename TImage::PixelType

private

Definition at line 46 of file itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h.

Constructor & Destructor Documentation

◆ ConstantBoundaryImageNeighborhoodPixelAccessPolicy() [1/3]

template<typename TImage >

itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::ConstantBoundaryImageNeighborhoodPixelAccessPolicy ( )

delete

◆ ~ConstantBoundaryImageNeighborhoodPixelAccessPolicy()

template<typename TImage >

itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::~ConstantBoundaryImageNeighborhoodPixelAccessPolicy ( )

default

◆ ConstantBoundaryImageNeighborhoodPixelAccessPolicy() [2/3]

template<typename TImage >

itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::ConstantBoundaryImageNeighborhoodPixelAccessPolicy ( const ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage > & )

default

◆ ConstantBoundaryImageNeighborhoodPixelAccessPolicy() [3/3]

template<typename TImage >

itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::ConstantBoundaryImageNeighborhoodPixelAccessPolicy	(	const ImageSizeType &	imageSize,
		const OffsetType &	offsetTable,
		const NeighborhoodAccessorFunctorType &	neighborhoodAccessor,
		const IndexType &	pixelIndex,
		const PixelType	constant = `{}`
	)

inlinenoexcept

Constructor called directly by the pixel proxy of ShapedImageNeighborhoodRange.

Definition at line 117 of file itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h.

Member Function Documentation

◆ CalculatePixelIndexValue()

template<typename TImage >

static IndexValueType itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::CalculatePixelIndexValue	(	const OffsetType &	offsetTable,
		const IndexType &	pixelIndex
	)

inlinestaticprivatenoexcept

Definition at line 89 of file itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h.

References itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::ImageDimension.

◆ GetPixelValue()

template<typename TImage >

PixelType itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::GetPixelValue ( const InternalPixelType *const imageBufferPointer ) const

inlinenoexcept

Retrieves the pixel value from the image buffer, at the current index. When the index is out of bounds, it returns the constant value specified during construction.

Definition at line 133 of file itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h.

References itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::m_Constant, itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::m_NeighborhoodAccessor, and itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::m_PixelIndexValue.

◆ IsInside()

template<typename TImage >

static bool itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::IsInside	(	const IndexType &	pixelIndex,
		const ImageSizeType &	imageSize
	)

inlinestaticprivatenoexcept

Definition at line 69 of file itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h.

References itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::ImageDimension.

◆ operator=()

template<typename TImage >

ConstantBoundaryImageNeighborhoodPixelAccessPolicy& itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::operator= ( const ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage > & )

delete

◆ SetPixelValue()

template<typename TImage >

void itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::SetPixelValue	(	InternalPixelType *const	imageBufferPointer,
		const PixelType &	pixelValue
	)		const