#include <itkGaussianOperator.h>

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

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

Public Types
using	Self = GaussianOperator

using	Superclass = NeighborhoodOperator< TPixel, VDimension, TAllocator >

Public Types inherited from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >
using	PixelType = TPixel

using	Self = NeighborhoodOperator

using	SizeType = typename Superclass::SizeType

using	SliceIteratorType = SliceIterator< TPixel, Self >

using	Superclass = Neighborhood< TPixel, VDimension, TAllocator >

using	PixelRealType = typename NumericTraits< TPixel >::RealType

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

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
double	GetMaximumError ()

unsigned int	GetMaximumKernelWidth () const

virtual const char *	GetNameOfClass () const

double	GetVariance ()

void	SetMaximumError (const double &max_error)

void	SetMaximumKernelWidth (unsigned int n)

void	SetVariance (const double &variance)

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

virtual void	CreateToRadius (const SizeType &)

virtual void	CreateToRadius (const SizeValueType)

virtual void	FlipAxes ()

unsigned long	GetDirection () const

void	SetDirection (const unsigned long &direction)

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

void	ScaleCoefficients (PixelRealType)

Public Member Functions inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
	itkTypeMacroNoParent (Neighborhood)

	Neighborhood ()

virtual	~Neighborhood ()=default

	Neighborhood (const Self &other)

	Neighborhood (Self &&)=default

Self &	operator= (const Self &other)

Self &	operator= (Self &&)=default

bool	operator== (const Self &other) const

bool	operator!= (const Self &other) const

const SizeType	GetRadius () const

SizeValueType	GetRadius (DimensionValueType n) const

SizeValueType	GetSize (DimensionValueType n) const

SizeType	GetSize () const

OffsetValueType	GetStride (DimensionValueType axis) const

Iterator	End ()

Iterator	Begin ()

ConstIterator	End () const

ConstIterator	Begin () const

NeighborIndexType	Size () const

TPixel &	operator[] (NeighborIndexType i)

const TPixel &	operator[] (NeighborIndexType i) const

TPixel &	GetElement (NeighborIndexType i)

TPixel	GetCenterValue () const

void	SetRadius (const SizeType &)

void	SetRadius (const SizeValueType *rad)

void	SetRadius (const SizeValueType)

void	Print (std::ostream &os) const

AllocatorType &	GetBufferReference ()

const AllocatorType &	GetBufferReference () const

TPixel &	operator[] (const OffsetType &o)

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

OffsetType	GetOffset (NeighborIndexType i) const

virtual NeighborIndexType	GetNeighborhoodIndex (const OffsetType &) const

NeighborIndexType	GetCenterNeighborhoodIndex () const

std::slice	GetSlice (unsigned int) const

using	CoefficientVector = typename Superclass::CoefficientVector

double	m_Variance { 1 }

double	m_MaximumError { .01 }

unsigned int	m_MaximumKernelWidth { 30 }

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

double	ModifiedBesselI0 (double)

double	ModifiedBesselI1 (double)

double	ModifiedBesselI (int, double)

CoefficientVector	GenerateCoefficients () override

void	Fill (const CoefficientVector &coeff) override

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

Protected Types inherited from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >
using	CoefficientVector = std::vector< PixelRealType >

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

virtual void	FillCenteredDirectional (const CoefficientVector &)

void	InitializeToZero ()

Protected Member Functions inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
void	SetSize ()

virtual void	Allocate (NeighborIndexType i)

virtual void	ComputeNeighborhoodStrideTable ()

virtual void	ComputeNeighborhoodOffsetTable ()

Detailed Description

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

A NeighborhoodOperator whose coefficients are a one dimensional, discrete Gaussian kernel.

GaussianOperator can be used to perform Gaussian blurring by taking its inner product with a Neighborhood (NeighborhoodIterator) that is swept across an image region. It is a directional operator. N successive applications oriented along each dimensional direction will effect separable, efficient, N-D Gaussian blurring of an image region.

GaussianOperator takes two parameters:

(1) The floating-point variance of the desired Gaussian function.

(2) The "maximum error" allowed in the discrete Gaussian function. "Maximum errror" is defined as the difference between the area under the discrete Gaussian curve and the area under the continuous Gaussian. Maximum error affects the Gaussian operator size. Care should be taken not to make this value too small relative to the variance lest the operator size become unreasonably large.

References: The Gaussian kernel contained in this operator was described by Tony Lindeberg (Discrete Scale-Space Theory and the Scale-Space Primal Sketch. Dissertation. Royal Institute of Technology, Stockholm, Sweden. May 1991.).

Note: GaussianOperator 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

ITK Sphinx Examples:

All ITK Sphinx Examples

Create Gaussian Kernel

Examples: Examples/Iterators/NeighborhoodIterators4.cxx, Examples/Iterators/NeighborhoodIterators5.cxx, SphinxExamples/src/Core/Common/CreateGaussianKernel/Code.cxx, and SphinxExamples/src/Core/Common/DemonstrateAllOperators/Code.cxx.

Definition at line 69 of file itkGaussianOperator.h.

Member Typedef Documentation

◆ CoefficientVector

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

using itk::GaussianOperator< TPixel, VDimension, TAllocator >::CoefficientVector = typename Superclass::CoefficientVector

protected

Desired variance of the discrete Gaussian function.

Definition at line 146 of file itkGaussianOperator.h.

◆ Self

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

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

Standard class type aliases.

Definition at line 74 of file itkGaussianOperator.h.

◆ Superclass

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

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

Definition at line 75 of file itkGaussianOperator.h.

Member Function Documentation

◆ Fill()

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

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

inlineoverrideprotected

Arranges coefficients spatially in the memory buffer.

Definition at line 171 of file itkGaussianOperator.h.

◆ GenerateCoefficients()

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

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

overrideprotectedvirtual

Calculates operator coefficients.

Implements itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >.

◆ GetMaximumError()

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

double itk::GaussianOperator< TPixel, VDimension, TAllocator >::GetMaximumError ( )

inline

Returns the maximum error of the gaussian approximation. Maximum error is the difference between the area under the discrete Gaussian curve and the area under the continuous Gaussian. Maximum error affects the Gaussian operator size.

Definition at line 113 of file itkGaussianOperator.h.

◆ GetMaximumKernelWidth()

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

unsigned int itk::GaussianOperator< TPixel, VDimension, TAllocator >::GetMaximumKernelWidth ( ) const

inline

Returns the maximum allowed kernel width.

Definition at line 130 of file itkGaussianOperator.h.

◆ GetNameOfClass()

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

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

virtual

Reimplemented from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >.

◆ GetVariance()

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

double itk::GaussianOperator< TPixel, VDimension, TAllocator >::GetVariance ( )

inline

Returns the variance of the Gaussian (scale) for the operator.

Definition at line 103 of file itkGaussianOperator.h.

◆ ModifiedBesselI()

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

double itk::GaussianOperator< TPixel, VDimension, TAllocator >::ModifiedBesselI	(	int	,
		double
	)

Returns the value of the modified Bessel function Ik(x) at a point x>=0, where k>=2.

◆ ModifiedBesselI0()

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

double itk::GaussianOperator< TPixel, VDimension, TAllocator >::ModifiedBesselI0 ( double )

Returns the value of the modified Bessel function I0(x) at a point x >= 0.

◆ ModifiedBesselI1()

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

double itk::GaussianOperator< TPixel, VDimension, TAllocator >::ModifiedBesselI1 ( double )

Returns the value of the modified Bessel function I1(x) at a point x, x real.

◆ PrintSelf()

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

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

inlineoverridevirtual

Prints some debugging information.

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

Definition at line 137 of file itkGaussianOperator.h.

◆ SetMaximumError()

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

void itk::GaussianOperator< TPixel, VDimension, TAllocator >::SetMaximumError ( const double & max_error )

inline

Sets the desired maximum error of the gaussian approximation. Maximum error is the difference between the area under the discrete Gaussian curve and the area under the continuous Gaussian. Maximum error affects the Gaussian operator size. The value must be between 0.0 and 1.0.

Definition at line 91 of file itkGaussianOperator.h.

◆ SetMaximumKernelWidth()

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

void itk::GaussianOperator< TPixel, VDimension, TAllocator >::SetMaximumKernelWidth ( unsigned int n )

inline

Sets a limit for growth of the kernel. Small maximum error values with large variances will yield very large kernel sizes. This value can be used to truncate a kernel in such instances. A warning will be given on truncation of the kernel.

Definition at line 123 of file itkGaussianOperator.h.

◆ SetVariance()

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

void itk::GaussianOperator< TPixel, VDimension, TAllocator >::SetVariance ( const double & variance )

inline

Sets the desired variance of the Gaussian kernel.

Definition at line 81 of file itkGaussianOperator.h.

Member Data Documentation

◆ m_MaximumError

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

double itk::GaussianOperator< TPixel, VDimension, TAllocator >::m_MaximumError { .01 }

private

Difference between the areas under the curves of the continuous and discrete Gaussian functions.

Definition at line 182 of file itkGaussianOperator.h.

◆ m_MaximumKernelWidth

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

unsigned int itk::GaussianOperator< TPixel, VDimension, TAllocator >::m_MaximumKernelWidth { 30 }

private

Maximum kernel size allowed. This value is used to truncate a kernel that has grown too large. A warning is given when the specified maximum error causes the kernel to exceed this size.

Definition at line 187 of file itkGaussianOperator.h.

◆ m_Variance

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

double itk::GaussianOperator< TPixel, VDimension, TAllocator >::m_Variance { 1 }

private

Desired variance of the discrete Gaussian function.

Definition at line 178 of file itkGaussianOperator.h.

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

itkGaussianOperator.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ CoefficientVector

◆ Self

◆ Superclass

Member Function Documentation

◆ Fill()

◆ GenerateCoefficients()

◆ GetMaximumError()

◆ GetMaximumKernelWidth()

◆ GetNameOfClass()

◆ GetVariance()

◆ ModifiedBesselI()

◆ ModifiedBesselI0()

◆ ModifiedBesselI1()

◆ PrintSelf()

◆ SetMaximumError()

◆ SetMaximumKernelWidth()

◆ SetVariance()

Member Data Documentation

◆ m_MaximumError

◆ m_MaximumKernelWidth

◆ m_Variance

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