#include <itkGaussianBlurImageFunction.h>

Detailed Description

template<typename TInputImage, typename TOutput = double>
class itk::GaussianBlurImageFunction< TInputImage, TOutput >

Compute the convolution of a neighborhood operator with the image at a specific location in space, i.e. point, index or continuous index. This class is templated over the input image type.

See also: NeighborhoodOperator; ImageFunction

Examples: Examples/Filtering/GaussianBlurImageFunction.cxx.

Definition at line 39 of file itkGaussianBlurImageFunction.h.

Inheritance diagram for itk::GaussianBlurImageFunction< TInputImage, TOutput >:

Collaboration diagram for itk::GaussianBlurImageFunction< TInputImage, TOutput >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ErrorArrayType = itk::FixedArray< double, Self::ImageDimension >

using	ExtentArrayType = itk::FixedArray< double, Self::ImageDimension >

using	GaussianFunctionPointer = typename GaussianFunctionType::Pointer

using	GaussianFunctionType = GaussianSpatialFunction< TOutput, 1 >

using	GaussianOperatorType = GaussianOperator< TOutput, Self::ImageDimension >

using	InputImageType = TInputImage

using	InputPixelRealType = typename NumericTraits< InputPixelType >::RealType

using	InputPixelType = typename InputImageType::PixelType

using	InternalImagePointer = typename InternalImageType::Pointer

using	InternalImageType = itk::Image< InputPixelRealType, Self::ImageDimension >

using	NeighborhoodType = Neighborhood< TOutput, Self::ImageDimension >

using	OperatorArrayType = FixedArray< NeighborhoodType, Self::ImageDimension >

using	OperatorImageFunctionPointer = typename OperatorImageFunctionType::Pointer

using	OperatorImageFunctionType = NeighborhoodOperatorImageFunction< InputImageType, TOutput >

using	OperatorInternalImageFunctionPointer = typename OperatorInternalImageFunctionType::Pointer

using	OperatorInternalImageFunctionType = NeighborhoodOperatorImageFunction< InternalImageType, TOutput >

using	Pointer = SmartPointer< Self >

using	Self = GaussianBlurImageFunction

using	SigmaArrayType = itk::FixedArray< double, Self::ImageDimension >

using	Superclass = ImageFunction< TInputImage, TOutput >

Public Types inherited from itk::ImageFunction< TInputImage, TOutput >
using	ConstPointer = SmartPointer< const Self >

using	ContinuousIndexType = ContinuousIndex< float, Self::ImageDimension >

using	CoordRepType = float

using	IndexType = typename InputImageType::IndexType

using	IndexValueType = typename InputImageType::IndexValueType

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImageType = TInputImage

using	InputPixelType = typename InputImageType::PixelType

using	OutputType = TOutput

using	Pointer = SmartPointer< Self >

using	PointType = Point< float, Self::ImageDimension >

using	Self = ImageFunction

using	Superclass = FunctionBase< Point< float, Self::ImageDimension >, TOutput >

Public Types inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, TOutput >
using	ConstPointer = SmartPointer< const Self >

using	InputType = Point< float, TInputImage::ImageDimension >

using	OutputType = TOutput

using	Pointer = SmartPointer< Self >

using	Self = FunctionBase

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
TOutput	Evaluate (const PointType &point) const override

TOutput	EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override

TOutput	EvaluateAtIndex (const IndexType &index) const override

const char *	GetNameOfClass () const override

virtual const SigmaArrayType &	GetSigma () const

void	SetExtent (const double extent)

void	SetInputImage (const InputImageType *ptr) override

void	SetSigma (const double *sigma)

void	SetSigma (const double sigma)

void	SetSigma (const float *sigma)

virtual void	SetSigma (SigmaArrayType _arg)


virtual void	SetExtent (ExtentArrayType _arg)

virtual const ExtentArrayType &	GetExtent () const

void	SetExtent (const double *extent)


virtual void	SetMaximumError (ErrorArrayType _arg)

virtual const ErrorArrayType &	GetMaximumError () const


virtual void	SetMaximumKernelWidth (int _arg)

virtual int	GetMaximumKernelWidth () const


virtual void	SetUseImageSpacing (bool _arg)

virtual bool	GetUseImageSpacing () const

virtual void	UseImageSpacingOn ()

Public Member Functions inherited from itk::ImageFunction< TInputImage, TOutput >
void	ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const

void	ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const

virtual const ContinuousIndexType &	GetEndContinuousIndex () const

virtual const IndexType &	GetEndIndex () const

const InputImageType *	GetInputImage () const

const char *	GetNameOfClass () const override

virtual const ContinuousIndexType &	GetStartContinuousIndex () const

virtual const IndexType &	GetStartIndex () const

virtual bool	IsInsideBuffer (const IndexType &index) const

virtual bool	IsInsideBuffer (const ContinuousIndexType &index) const

virtual bool	IsInsideBuffer (const PointType &point) const

void	ConvertPointToNearestIndex (const PointType &point, IndexType &index) const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = InputImageType::ImageDimension

Static Public Attributes inherited from itk::ImageFunction< TInputImage, TOutput >
static constexpr unsigned int	ImageDimension

Protected Member Functions
	GaussianBlurImageFunction ()

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

void	RecomputeContinuousGaussianKernel (const double *offset) const

void	RecomputeGaussianKernel ()

	~GaussianBlurImageFunction () override=default

Protected Member Functions inherited from itk::ImageFunction< TInputImage, TOutput >
	ImageFunction ()

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

	~ImageFunction () override=default

Protected Member Functions inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, TOutput >
	FunctionBase ()=default

	~FunctionBase () override=default

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
virtual TOutput	EvaluateAtIndex (const IndexType &index, const OperatorArrayType &operatorArray) const

Private Attributes
OperatorArrayType	m_ContinuousOperatorArray {}

ExtentArrayType	m_Extent {}

unsigned int	m_FilterDimensionality {}

GaussianFunctionPointer	m_GaussianFunction {}

InternalImagePointer	m_InternalImage {}

ErrorArrayType	m_MaximumError {}

int	m_MaximumKernelWidth {}

OperatorArrayType	m_OperatorArray {}

OperatorImageFunctionPointer	m_OperatorImageFunction {}

OperatorInternalImageFunctionPointer	m_OperatorInternalImageFunction {}

SigmaArrayType	m_Sigma {}

bool	m_UseImageSpacing { true }

Additional Inherited Members
Protected Attributes inherited from itk::ImageFunction< TInputImage, TOutput >
ContinuousIndexType	m_EndContinuousIndex

IndexType	m_EndIndex

InputImageConstPointer	m_Image

ContinuousIndexType	m_StartContinuousIndex

IndexType	m_StartIndex

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::ConstPointer = SmartPointer<const Self>

Definition at line 52 of file itkGaussianBlurImageFunction.h.

◆ ErrorArrayType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::ErrorArrayType = itk::FixedArray<double, Self::ImageDimension>

Definition at line 85 of file itkGaussianBlurImageFunction.h.

◆ ExtentArrayType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::ExtentArrayType = itk::FixedArray<double, Self::ImageDimension>

Definition at line 86 of file itkGaussianBlurImageFunction.h.

◆ GaussianFunctionPointer

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::GaussianFunctionPointer = typename GaussianFunctionType::Pointer

Definition at line 74 of file itkGaussianBlurImageFunction.h.

◆ GaussianFunctionType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::GaussianFunctionType = GaussianSpatialFunction<TOutput, 1>

Definition at line 73 of file itkGaussianBlurImageFunction.h.

◆ GaussianOperatorType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::GaussianOperatorType = GaussianOperator<TOutput, Self::ImageDimension>

Definition at line 69 of file itkGaussianBlurImageFunction.h.

◆ InputImageType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::InputImageType = TInputImage

InputImageType type alias support

Definition at line 61 of file itkGaussianBlurImageFunction.h.

◆ InputPixelRealType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::InputPixelRealType = typename NumericTraits<InputPixelType>::RealType

Definition at line 75 of file itkGaussianBlurImageFunction.h.

◆ InputPixelType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::InputPixelType = typename InputImageType::PixelType

Definition at line 62 of file itkGaussianBlurImageFunction.h.

◆ InternalImagePointer

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::InternalImagePointer = typename InternalImageType::Pointer

Definition at line 77 of file itkGaussianBlurImageFunction.h.

◆ InternalImageType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::InternalImageType = itk::Image<InputPixelRealType, Self::ImageDimension>

Definition at line 76 of file itkGaussianBlurImageFunction.h.

◆ NeighborhoodType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::NeighborhoodType = Neighborhood<TOutput, Self::ImageDimension>

Definition at line 70 of file itkGaussianBlurImageFunction.h.

◆ OperatorArrayType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::OperatorArrayType = FixedArray<NeighborhoodType, Self::ImageDimension>

Definition at line 71 of file itkGaussianBlurImageFunction.h.

◆ OperatorImageFunctionPointer

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::OperatorImageFunctionPointer = typename OperatorImageFunctionType::Pointer

Definition at line 80 of file itkGaussianBlurImageFunction.h.

◆ OperatorImageFunctionType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::OperatorImageFunctionType = NeighborhoodOperatorImageFunction<InputImageType, TOutput>

Definition at line 79 of file itkGaussianBlurImageFunction.h.

◆ OperatorInternalImageFunctionPointer

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::OperatorInternalImageFunctionPointer = typename OperatorInternalImageFunctionType::Pointer

Definition at line 83 of file itkGaussianBlurImageFunction.h.

◆ OperatorInternalImageFunctionType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::OperatorInternalImageFunctionType = NeighborhoodOperatorImageFunction<InternalImageType, TOutput>

Definition at line 82 of file itkGaussianBlurImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::Pointer = SmartPointer<Self>

Smart pointer type alias support

Definition at line 51 of file itkGaussianBlurImageFunction.h.

◆ Self

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::Self = GaussianBlurImageFunction

Standard "Self" type alias

Definition at line 45 of file itkGaussianBlurImageFunction.h.

◆ SigmaArrayType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::SigmaArrayType = itk::FixedArray<double, Self::ImageDimension>

Definition at line 87 of file itkGaussianBlurImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TOutput = double>

using itk::GaussianBlurImageFunction< TInputImage, TOutput >::Superclass = ImageFunction<TInputImage, TOutput>

Standard "Superclass" type alias

Definition at line 48 of file itkGaussianBlurImageFunction.h.

Constructor & Destructor Documentation

◆ GaussianBlurImageFunction()

template<typename TInputImage , typename TOutput = double>

itk::GaussianBlurImageFunction< TInputImage, TOutput >::GaussianBlurImageFunction ( )

protected

◆ ~GaussianBlurImageFunction()

template<typename TInputImage , typename TOutput = double>

itk::GaussianBlurImageFunction< TInputImage, TOutput >::~GaussianBlurImageFunction ( )

overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TInputImage , typename TOutput = double>

TOutput itk::GaussianBlurImageFunction< TInputImage, TOutput >::Evaluate ( const PointType & point ) const

overridevirtual

Evaluate the function in the given dimension at specified point

Implements itk::ImageFunction< TInputImage, TOutput >.

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TOutput = double>

TOutput itk::GaussianBlurImageFunction< TInputImage, TOutput >::EvaluateAtContinuousIndex ( const ContinuousIndexType & cindex ) const

overridevirtual

Evaluate the function at specified ContinuousIndex position.

Implements itk::ImageFunction< TInputImage, TOutput >.

◆ EvaluateAtIndex() [1/2]

template<typename TInputImage , typename TOutput = double>

TOutput itk::GaussianBlurImageFunction< TInputImage, TOutput >::EvaluateAtIndex ( const IndexType & index ) const

overridevirtual

Evaluate the function at specified Index position

Implements itk::ImageFunction< TInputImage, TOutput >.

◆ EvaluateAtIndex() [2/2]

template<typename TInputImage , typename TOutput = double>

virtual TOutput itk::GaussianBlurImageFunction< TInputImage, TOutput >::EvaluateAtIndex	(	const IndexType &	index,
		const OperatorArrayType &	operatorArray
	)		const

privatevirtual

◆ GetExtent()

template<typename TInputImage , typename TOutput = double>

virtual const ExtentArrayType& itk::GaussianBlurImageFunction< TInputImage, TOutput >::GetExtent ( ) const

virtual

Set/Get the Extent of the array holding the coefficients of the Gaussian kernel computed by the GaussianOperator.

◆ GetMaximumError()

template<typename TInputImage , typename TOutput = double>

virtual const ErrorArrayType& itk::GaussianBlurImageFunction< TInputImage, TOutput >::GetMaximumError ( ) const

virtual

Set/Get the maximum error acceptable for the approximation of the Gaussian kernel with the GaussianOperator.

◆ GetMaximumKernelWidth()

template<typename TInputImage , typename TOutput = double>

virtual int itk::GaussianBlurImageFunction< TInputImage, TOutput >::GetMaximumKernelWidth ( ) const

virtual

Set/GetMaximumKernelWidth() This value is used by the underling GaussianOperator for computing the number of coefficients to be used in the Gaussian kernel

◆ GetNameOfClass()

template<typename TInputImage , typename TOutput = double>

const char* itk::GaussianBlurImageFunction< TInputImage, TOutput >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetSigma()

template<typename TInputImage , typename TOutput = double>

virtual const SigmaArrayType& itk::GaussianBlurImageFunction< TInputImage, TOutput >::GetSigma ( ) const

virtual

◆ GetUseImageSpacing()

template<typename TInputImage , typename TOutput = double>

virtual bool itk::GaussianBlurImageFunction< TInputImage, TOutput >::GetUseImageSpacing ( ) const

virtual

Set/GetUseImageSpacing() This flag is used by the underling GaussianOperator to decide if the image spacing should be used to scale the value of sigma or not. The methods UseImageSpacingOn() and UseImageSpacingOff() provide a similar functionality.

◆ New()

template<typename TInputImage , typename TOutput = double>

static Pointer itk::GaussianBlurImageFunction< TInputImage, TOutput >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutput = double>

void itk::GaussianBlurImageFunction< TInputImage, TOutput >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

◆ RecomputeContinuousGaussianKernel()

template<typename TInputImage , typename TOutput = double>

void itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel ( const double * offset ) const

protected

◆ RecomputeGaussianKernel()

template<typename TInputImage , typename TOutput = double>

void itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel ( )

protected

◆ SetExtent() [1/3]

template<typename TInputImage , typename TOutput = double>

void itk::GaussianBlurImageFunction< TInputImage, TOutput >::SetExtent ( const double * extent )

Set/Get the Extent of the array holding the coefficients of the Gaussian kernel computed by the GaussianOperator.

◆ SetExtent() [2/3]

template<typename TInputImage , typename TOutput = double>

void itk::GaussianBlurImageFunction< TInputImage, TOutput >::SetExtent ( const double extent )

◆ SetExtent() [3/3]

template<typename TInputImage , typename TOutput = double>

virtual void itk::GaussianBlurImageFunction< TInputImage, TOutput >::SetExtent ( ExtentArrayType _arg )

virtual

Set/Get the Extent of the array holding the coefficients of the Gaussian kernel computed by the GaussianOperator.

◆ SetInputImage()

template<typename TInputImage , typename TOutput = double>

void itk::GaussianBlurImageFunction< TInputImage, TOutput >::SetInputImage ( const InputImageType * ptr )

overridevirtual

Set the input image.

Warning: this method caches BufferedRegion information. If the BufferedRegion has changed, user must call SetInputImage again to update cached values.

Reimplemented from itk::ImageFunction< TInputImage, TOutput >.

◆ SetMaximumError()

template<typename TInputImage , typename TOutput = double>

virtual void itk::GaussianBlurImageFunction< TInputImage, TOutput >::SetMaximumError ( ErrorArrayType _arg )

virtual

Set/Get the maximum error acceptable for the approximation of the Gaussian kernel with the GaussianOperator.

◆ SetMaximumKernelWidth()

template<typename TInputImage , typename TOutput = double>

virtual void itk::GaussianBlurImageFunction< TInputImage, TOutput >::SetMaximumKernelWidth ( int _arg )

virtual

Set/GetMaximumKernelWidth() This value is used by the underling GaussianOperator for computing the number of coefficients to be used in the Gaussian kernel

◆ SetSigma() [1/4]

template<typename TInputImage , typename TOutput = double>

void itk::GaussianBlurImageFunction< TInputImage, TOutput >::SetSigma ( const double * sigma )

The standard deviation for the discrete Gaussian kernel. Sets the standard deviation independently for each dimension. The default is 1.0 in each dimension. If UseImageSpacing is true (default), the units are the physical units of your image. If UseImageSpacing is false then the units are pixels.

◆ SetSigma() [2/4]

template<typename TInputImage , typename TOutput = double>

void itk::GaussianBlurImageFunction< TInputImage, TOutput >::SetSigma ( const double sigma )

◆ SetSigma() [3/4]

template<typename TInputImage , typename TOutput = double>

void itk::GaussianBlurImageFunction< TInputImage, TOutput >::SetSigma ( const float * sigma )

◆ SetSigma() [4/4]

template<typename TInputImage , typename TOutput = double>

virtual void itk::GaussianBlurImageFunction< TInputImage, TOutput >::SetSigma ( SigmaArrayType _arg )

virtual

◆ SetUseImageSpacing()

template<typename TInputImage , typename TOutput = double>

virtual void itk::GaussianBlurImageFunction< TInputImage, TOutput >::SetUseImageSpacing ( bool _arg )

virtual

Set/GetUseImageSpacing() This flag is used by the underling GaussianOperator to decide if the image spacing should be used to scale the value of sigma or not. The methods UseImageSpacingOn() and UseImageSpacingOff() provide a similar functionality.

◆ UseImageSpacingOn()

template<typename TInputImage , typename TOutput = double>

virtual void itk::GaussianBlurImageFunction< TInputImage, TOutput >::UseImageSpacingOn ( )

virtual

Set/GetUseImageSpacing() This flag is used by the underling GaussianOperator to decide if the image spacing should be used to scale the value of sigma or not. The methods UseImageSpacingOn() and UseImageSpacingOff() provide a similar functionality.