#include <itkGaussianOperator.h>

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

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

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.).

See Also: NeighborhoodOperator; NeighborhoodIterator; Neighborhood

Wiki Examples:

Examples:: Examples/Iterators/NeighborhoodIterators4.cxx, Examples/Iterators/NeighborhoodIterators5.cxx, and WikiExamples/Operators/GaussianOperator.cxx.

Definition at line 67 of file itkGaussianOperator.h.

Public Types
using	Self = GaussianOperator

using	Superclass = NeighborhoodOperator< TPixel, VDimension, TAllocator >

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

using	PixelType = TPixel

using	Self = NeighborhoodOperator

using	SizeType = typename Superclass::SizeType

using	SliceIteratorType = SliceIterator< TPixel, Self >

using	Superclass = Neighborhood< TPixel, VDimension, TAllocator >

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
	GaussianOperator ()

double	GetMaximumError ()

unsigned int	GetMaximumKernelWidth () const

virtual const char *	GetNameOfClass () const

double	GetVariance ()

double	ModifiedBesselI (int, double)

double	ModifiedBesselI0 (double)

double	ModifiedBesselI1 (double)

void	SetMaximumError (const double &max_error)

void	SetMaximumKernelWidth (unsigned int n)

void	SetVariance (const double &variance)


	GaussianOperator (const Self &other)


Self &	operator= (const Self &other)


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

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

	NeighborhoodOperator ()

	NeighborhoodOperator (const Self &orig)

void	ScaleCoefficients (PixelRealType)

void	SetDirection (const unsigned long &direction)

Self &	operator= (const Self &orig)

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

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

TPixel	GetCenterValue () const

virtual NeighborIndexType	GetNeighborhoodIndex (const OffsetType &) const

OffsetType	GetOffset (NeighborIndexType i) const

const SizeType	GetRadius () const

SizeValueType	GetRadius (DimensionValueType n) const

SizeValueType	GetSize (DimensionValueType n) const

SizeType	GetSize () const

std::slice	GetSlice (unsigned int) const

OffsetValueType	GetStride (DimensionValueType axis) const

	itkTypeMacroNoParent (Neighborhood)

	Neighborhood (const Self &other)

	Neighborhood (Self &&)=default

bool	operator!= (const Self &other) const

Self &	operator= (const Self &other)

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

	Neighborhood ()

Iterator	End ()

Iterator	Begin ()

ConstIterator	End () const

ConstIterator	Begin () const

TPixel &	operator[] (NeighborIndexType i)

const TPixel &	operator[] (NeighborIndexType i) const

TPixel &	GetElement (NeighborIndexType i)

void	SetRadius (const SizeValueType *rad)

AllocatorType &	GetBufferReference ()

const AllocatorType &	GetBufferReference () const

TPixel &	operator[] (const OffsetType &o)

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

Protected Types
using	CoefficientVector = typename Superclass::CoefficientVector

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

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

CoefficientVector	GenerateCoefficients () override

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 >
virtual void	Allocate (NeighborIndexType i)

virtual void	ComputeNeighborhoodOffsetTable ()

virtual void	ComputeNeighborhoodStrideTable ()

void	SetSize ()

Private Attributes
double	m_MaximumError {.01}

unsigned int	m_MaximumKernelWidth {30}

double	m_Variance {1}

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