ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Private Types | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage > Class Template Referencefinal

#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
 
ConstantBoundaryImageNeighborhoodPixelAccessPolicyoperator= (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 NeighborhoodAccessorFunctorTypem_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

◆ ImageSizeType

template<typename TImage >
using itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::ImageSizeType = Size<ImageDimension>
private

◆ ImageSizeValueType

template<typename TImage >
using itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::ImageSizeValueType = SizeValueType
private

◆ IndexType

template<typename TImage >
using itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::IndexType = Index<ImageDimension>
private

◆ InternalPixelType

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

◆ NeighborhoodAccessorFunctorType

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

◆ OffsetType

template<typename TImage >
using itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::OffsetType = Offset<ImageDimension>
private

◆ PixelAccessParameterType

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

Constructor & Destructor Documentation

◆ ConstantBoundaryImageNeighborhoodPixelAccessPolicy() [1/3]

◆ ~ConstantBoundaryImageNeighborhoodPixelAccessPolicy()

◆ ConstantBoundaryImageNeighborhoodPixelAccessPolicy() [2/3]

◆ 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

◆ 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

◆ operator=()

◆ SetPixelValue()

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

Member Data Documentation

◆ ImageDimension

template<typename TImage >
constexpr ImageDimensionType itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::ImageDimension = TImage::ImageDimension
staticconstexprprivate

◆ m_Constant

template<typename TImage >
const PixelType itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::m_Constant
private

◆ m_NeighborhoodAccessor

template<typename TImage >
const NeighborhoodAccessorFunctorType& itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::m_NeighborhoodAccessor
private

◆ m_PixelIndexValue

template<typename TImage >
const IndexValueType itk::ConstantBoundaryImageNeighborhoodPixelAccessPolicy< TImage >::m_PixelIndexValue
private

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