#include <itkImageKernelOperator.h>

Detailed Description

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
class itk::ImageKernelOperator< TPixel, VDimension, TAllocator >

A NeighborhoodOperator whose coefficients are from an image.

This code was contributed in the Insight Journal paper:

"Image Kernel Convolution" by Tustison N., Gee J. https://doi.org/10.54294/e292kx

Note: ImageKernelOperator does not have any user-declared "special member function", following the C++ Rule of Zero: the compiler will generate them if necessary.

See also: NeighborhoodOperator; NeighborhoodIterator; Neighborhood

Definition at line 49 of file itkImageKernelOperator.h.

Inheritance diagram for itk::ImageKernelOperator< TPixel, VDimension, TAllocator >:

Collaboration diagram for itk::ImageKernelOperator< TPixel, VDimension, TAllocator >:

Public Types
using	ImageType = Image< TPixel, VDimension >

using	Self = ImageKernelOperator

using	Superclass = NeighborhoodOperator< TPixel, VDimension, TAllocator >

Public Types inherited from itk::NeighborhoodOperator< TPixel, 2, NeighborhoodAllocator< TPixel > >
using	PixelRealType = typename NumericTraits< TPixel >::RealType

using	PixelType = TPixel

using	Self = NeighborhoodOperator

using	SizeType = itk::Size< VDimension >

using	SliceIteratorType = SliceIterator< TPixel, Self >

using	Superclass = Neighborhood< TPixel, VDimension, NeighborhoodAllocator< TPixel > >

Public Types inherited from itk::Neighborhood< TPixel, VDimension, NeighborhoodAllocator< TPixel > >
using	AllocatorType = NeighborhoodAllocator< TPixel >

using	ConstIterator = typename AllocatorType::const_iterator

using	DimensionValueType = unsigned int

using	Iterator = typename AllocatorType::iterator

using	NeighborIndexType = SizeValueType

using	OffsetType = Offset< VDimension >

using	PixelType = TPixel

using	RadiusType = itk::Size< VDimension >

using	Self = Neighborhood

using	SizeType = itk::Size< VDimension >

using	SizeValueType = typename SizeType::SizeValueType

using	SliceIteratorType = SliceIterator< TPixel, Self >

Public Member Functions
const ImageType *	GetImageKernel () const

const char *	GetNameOfClass () const override

void	PrintSelf (std::ostream &os, Indent indent) const override

void	SetImageKernel (const ImageType *kernel)

Public Member Functions inherited from itk::NeighborhoodOperator< TPixel, 2, NeighborhoodAllocator< TPixel > >
virtual void	CreateDirectional ()

virtual void	CreateToRadius (const SizeType &)

virtual void	CreateToRadius (const SizeValueType)

virtual void	FlipAxes ()

unsigned long	GetDirection () const

const char *	GetNameOfClass () const override

void	PrintSelf (std::ostream &os, Indent indent) const override

void	ScaleCoefficients (PixelRealType)

void	SetDirection (const unsigned long direction)

Public Member Functions inherited from itk::Neighborhood< TPixel, VDimension, NeighborhoodAllocator< TPixel > >
NeighborIndexType	GetCenterNeighborhoodIndex () const

TPixel	GetCenterValue () const

virtual const char *	GetNameOfClass () const

virtual NeighborIndexType	GetNeighborhoodIndex (const OffsetType &) const

OffsetType	GetOffset (NeighborIndexType i) const

const SizeType	GetRadius () const

SizeValueType	GetRadius (DimensionValueType n) const

SizeType	GetSize () const

SizeValueType	GetSize (DimensionValueType n) const

std::slice	GetSlice (unsigned int) const

OffsetValueType	GetStride (DimensionValueType axis) const

	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)

	Neighborhood ()=default

	Neighborhood (const Self &)=default

	Neighborhood (Self &&)=default

Self &	operator= (const Self &)=default

Self &	operator= (Self &&)=default

bool	operator== (const Self &other) const

void	Print (std::ostream &os) const

void	SetRadius (const SizeType &)

void	SetRadius (const SizeValueType)

NeighborIndexType	Size () const

virtual	~Neighborhood ()=default

Iterator	End ()

ConstIterator	End () const

Iterator	Begin ()

ConstIterator	Begin () const

TPixel &	operator[] (NeighborIndexType i)

const TPixel &	operator[] (NeighborIndexType i) const

TPixel &	GetElement (NeighborIndexType i)

TPixel &	operator[] (const OffsetType &o)

const TPixel &	operator[] (const OffsetType &o) const

void	SetRadius (const SizeValueType *rad)

AllocatorType &	GetBufferReference ()

const AllocatorType &	GetBufferReference () const

Protected Types
using	CoefficientVector = typename std::vector< PixelRealType >

Protected Types inherited from itk::NeighborhoodOperator< TPixel, 2, NeighborhoodAllocator< TPixel > >
using	CoefficientVector = typename std::vector< PixelRealType >

Protected Member Functions
void	Fill (const CoefficientVector &coeff) override

CoefficientVector	GenerateCoefficients () override

Protected Member Functions inherited from itk::NeighborhoodOperator< TPixel, 2, NeighborhoodAllocator< TPixel > >
virtual void	Fill (const CoefficientVector &)=0

virtual void	FillCenteredDirectional (const CoefficientVector &)

virtual CoefficientVector	GenerateCoefficients ()=0

void	InitializeToZero ()

Protected Member Functions inherited from itk::Neighborhood< TPixel, VDimension, NeighborhoodAllocator< TPixel > >
virtual void	Allocate (NeighborIndexType i)

virtual void	ComputeNeighborhoodOffsetTable ()

virtual void	ComputeNeighborhoodStrideTable ()

virtual void	PrintSelf (std::ostream &, Indent) const

void	SetSize ()

Private Attributes
ImageType::ConstPointer	m_ImageKernel {}

Additional Inherited Members
Static Public Attributes inherited from itk::Neighborhood< TPixel, VDimension, NeighborhoodAllocator< TPixel > >
static constexpr unsigned int	NeighborhoodDimension

Member Typedef Documentation

◆ CoefficientVector

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>

using itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CoefficientVector = typename std::vector<PixelRealType>

protected

Type alias support for coefficient vector type. Necessary to fix bug in the microsoft VC++ compiler.

Definition at line 153 of file itkNeighborhoodOperator.h.

◆ ImageType

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>

using itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::ImageType = Image<TPixel, VDimension>

Definition at line 57 of file itkImageKernelOperator.h.

◆ Self

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>

using itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::Self = ImageKernelOperator

Standard class type aliases.

Definition at line 54 of file itkImageKernelOperator.h.

◆ Superclass

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>

using itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::Superclass = NeighborhoodOperator<TPixel, VDimension, TAllocator>

Definition at line 55 of file itkImageKernelOperator.h.

Member Function Documentation

◆ Fill()

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>

void itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::Fill ( const CoefficientVector & coeff )

overrideprotectedvirtual

Arranges coefficients spatially in the memory buffer.

Implements itk::NeighborhoodOperator< TPixel, 2, NeighborhoodAllocator< TPixel > >.

◆ GenerateCoefficients()

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>

CoefficientVector itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::GenerateCoefficients ( )

overrideprotectedvirtual

Calculates operator coefficients.

Implements itk::NeighborhoodOperator< TPixel, 2, NeighborhoodAllocator< TPixel > >.

◆ GetImageKernel()

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>

const ImageType * itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::GetImageKernel ( ) const

Get the image kernel.

◆ GetNameOfClass()

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>

const char * itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Neighborhood< TPixel, VDimension, NeighborhoodAllocator< TPixel > >.

◆ PrintSelf()

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>

void itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::PrintSelf	(	std::ostream &	,
		Indent
	)		const

inlineoverridevirtual

Standard itk object method.

Reimplemented from itk::Neighborhood< TPixel, VDimension, NeighborhoodAllocator< TPixel > >.

Definition at line 73 of file itkImageKernelOperator.h.

◆ SetImageKernel()

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>

void itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::SetImageKernel ( const ImageType * kernel )

Set the image kernel. Only images with odd size in all dimensions are allowed. If an image with an even size is passed as an argument, an exception will be thrown.

Member Data Documentation

◆ m_ImageKernel

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>

ImageType::ConstPointer itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::m_ImageKernel {}

private

Definition at line 91 of file itkImageKernelOperator.h.

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

itkImageKernelOperator.h

Detailed Description

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ CoefficientVector

◆ ImageType

◆ Self

◆ Superclass

Member Function Documentation

◆ Fill()

◆ GenerateCoefficients()

◆ GetImageKernel()

◆ GetNameOfClass()

◆ PrintSelf()

◆ SetImageKernel()

Member Data Documentation

◆ m_ImageKernel