#include <itkRecursiveGaussianImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage = TInputImage>
class itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >

Base class for computing IIR convolution with an approximation of a Gaussian kernel.

\[ \frac{ 1 }{ \sigma \sqrt{ 2 \pi } } \exp{ \left( - \frac{x^2}{ 2 \sigma^2 } \right) } \]

RecursiveGaussianImageFilter is the base class for recursive filters that approximate convolution with the Gaussian kernel. This class implements the recursive filtering method proposed by R.Deriche in IEEE-PAMI Vol.12, No.1, January 1990, pp 78-87, "Fast Algorithms for Low-Level Vision"

Details of the implementation are described in the technical report: R. Deriche, "Recursively Implementing The Gaussian and Its Derivatives", INRIA, 1993, ftp://ftp.inria.fr/INRIA/tech-reports/RR/RR-1893.ps.gz

Further improvements of the algorithm are described in: G. Farnebäck & C.-F. Westin, "Improving Deriche-style Recursive Gaussian Filters". J Math Imaging Vis 26, 293–299 (2006). https://doi.org/10.1007/s10851-006-8464-z

As compared to itk::DiscreteGaussianImageFilter, this filter tends to be faster for large kernels, and it can take the derivative of the blurred image in one step. Also, note that we have itk::RecursiveGaussianImageFilter::SetSigma(), but itk::DiscreteGaussianImageFilter::SetVariance().

See also: DiscreteGaussianImageFilter

ITK Sphinx Examples:

All ITK Sphinx Examples

Find Higher Derivatives Of Image

Examples: Examples/Filtering/LaplacianRecursiveGaussianImageFilter1.cxx, Examples/Filtering/ResampleVolumesToBeIsotropic.cxx, Examples/Filtering/SecondDerivativeRecursiveGaussianImageFilter.cxx, Examples/Filtering/SmoothingRecursiveGaussianImageFilter.cxx, Examples/Filtering/SubsampleVolume.cxx, and SphinxExamples/src/Filtering/Smoothing/FindHigherDerivativesOfImage/Code.cxx.

Definition at line 100 of file itkRecursiveGaussianImageFilter.h.

Inheritance diagram for itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = RecursiveGaussianImageFilter

using	Superclass = RecursiveSeparableImageFilter< TInputImage, TOutputImage >

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

using	InputImageConstPointer = typename TInputImage::ConstPointer

using	InputImagePointer = typename TInputImage::Pointer

using	InputImageType = TInputImage

using	InputPixelType = typename TInputImage::PixelType

using	OutputImageRegionType = typename TOutputImage::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	RealType = typename NumericTraits< InputPixelType >::RealType

using	ScalarRealType = typename NumericTraits< InputPixelType >::ScalarRealType

using	Self = RecursiveSeparableImageFilter

using	Superclass = InPlaceImageFilter< TInputImage, TOutputImage >

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

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = InPlaceImageFilter

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

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

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TOutputImage >

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

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

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

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

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
const char *	GetNameOfClass () const override

virtual bool	GetNormalizeAcrossScale () const

virtual void	NormalizeAcrossScaleOn ()

void	SetFirstOrder ()

virtual void	SetNormalizeAcrossScale (bool _arg)

void	SetSecondOrder ()

void	SetZeroOrder ()


virtual ScalarRealType	GetSigma () const

virtual void	SetSigma (ScalarRealType _arg)


virtual void	SetOrder (GaussianOrderEnum _arg)

virtual GaussianOrderEnum	GetOrder () const

Public Member Functions inherited from itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >
virtual unsigned int	GetDirection () const

const TInputImage *	GetInputImage ()

virtual void	SetDirection (unsigned int _arg)

void	SetInputImage (const TInputImage *)

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	CanRunInPlace () const

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () 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::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

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

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

	RecursiveGaussianImageFilter ()

void	SetUp (ScalarRealType spacing) override

void	VerifyPreconditions () const override

	~RecursiveGaussianImageFilter () override=default

Protected Member Functions inherited from itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >
void	BeforeThreadedGenerateData () override

void	DynamicThreadedGenerateData (const OutputImageRegionType &) override

void	EnlargeOutputRequestedRegion (DataObject *output) override

void	FilterDataArray (RealType outs, const RealType data, RealType *scratch, SizeValueType ln) const

void	GenerateData () override

	RecursiveSeparableImageFilter ()

	~RecursiveSeparableImageFilter () override=default

Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

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
void	ComputeDCoefficients (ScalarRealType sigmad, ScalarRealType W1, ScalarRealType L1, ScalarRealType W2, ScalarRealType L2, ScalarRealType &SD, ScalarRealType &DD, ScalarRealType &ED)

void	ComputeNCoefficients (ScalarRealType sigmad, ScalarRealType A1, ScalarRealType B1, ScalarRealType W1, ScalarRealType L1, ScalarRealType A2, ScalarRealType B2, ScalarRealType W2, ScalarRealType L2, ScalarRealType &N0, ScalarRealType &N1, ScalarRealType &N2, ScalarRealType &N3, ScalarRealType &SN, ScalarRealType &DN, ScalarRealType &EN)

void	ComputeRemainingCoefficients (bool symmetric)

Private Attributes
bool	m_NormalizeAcrossScale {}

GaussianOrderEnum	m_Order {}

ScalarRealType	m_Sigma {}

Additional Inherited Members
Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Static Protected Member Functions inherited from itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >
template<typename T1 , typename T2 >
static void	MathEMAMAMAM (T1 &out, const T1 &a1, const T2 &b1, const T1 &a2, const T2 &b2, const T1 &a3, const T2 &b3, const T1 &a4, const T2 &b4)

template<typename T1 , typename T2 >
static void	MathEMAMAMAM (VariableLengthVector< T1 > &out, const VariableLengthVector< T1 > &a1, const T2 &b1, const VariableLengthVector< T1 > &a2, const T2 &b2, const VariableLengthVector< T1 > &a3, const T2 &b3, const VariableLengthVector< T1 > &a4, const T2 &b4)

template<typename T1 , typename T2 >
static void	MathSMAMAMAM (T1 &out, const T1 &a1, const T2 &b1, const T1 &a2, const T2 &b2, const T1 &a3, const T2 &b3, const T1 &a4, const T2 &b4)

template<typename T1 , typename T2 >
static void	MathSMAMAMAM (VariableLengthVector< T1 > &out, const VariableLengthVector< T1 > &a1, const T2 &b1, const VariableLengthVector< T1 > &a2, const T2 &b2, const VariableLengthVector< T1 > &a3, const T2 &b3, const VariableLengthVector< T1 > &a4, const T2 &b4)

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >
ScalarRealType	m_BM1 {}

ScalarRealType	m_BM2 {}

ScalarRealType	m_BM3 {}

ScalarRealType	m_BM4 {}

ScalarRealType	m_BN1 {}

ScalarRealType	m_BN2 {}

ScalarRealType	m_BN3 {}

ScalarRealType	m_BN4 {}

ScalarRealType	m_D1 {}

ScalarRealType	m_D2 {}

ScalarRealType	m_D3 {}

ScalarRealType	m_D4 {}

ScalarRealType	m_M1 {}

ScalarRealType	m_M2 {}

ScalarRealType	m_M3 {}

ScalarRealType	m_M4 {}

ScalarRealType	m_N0 {}

ScalarRealType	m_N1 {}

ScalarRealType	m_N2 {}

ScalarRealType	m_N3 {}

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

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

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage = TInputImage>

using itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 110 of file itkRecursiveGaussianImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage = TInputImage>

using itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Type of the output image

Definition at line 130 of file itkRecursiveGaussianImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage = TInputImage>

using itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 109 of file itkRecursiveGaussianImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage = TInputImage>

using itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::Self = RecursiveGaussianImageFilter

Standard class type aliases.

Definition at line 107 of file itkRecursiveGaussianImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage = TInputImage>

using itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::Superclass = RecursiveSeparableImageFilter<TInputImage, TOutputImage>

Definition at line 108 of file itkRecursiveGaussianImageFilter.h.

Constructor & Destructor Documentation

◆ RecursiveGaussianImageFilter()

template<typename TInputImage , typename TOutputImage = TInputImage>

itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::RecursiveGaussianImageFilter ( )

protected

◆ ~RecursiveGaussianImageFilter()

template<typename TInputImage , typename TOutputImage = TInputImage>

itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::~RecursiveGaussianImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ ComputeDCoefficients()

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::ComputeDCoefficients	(	ScalarRealType	sigmad,
		ScalarRealType	W1,
		ScalarRealType	L1,
		ScalarRealType	W2,
		ScalarRealType	L2,
		ScalarRealType &	SD,
		ScalarRealType &	DD,
		ScalarRealType &	ED
	)

private

Compute the D coefficients in the recursive filter.

◆ ComputeNCoefficients()

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::ComputeNCoefficients	(	ScalarRealType	sigmad,
		ScalarRealType	A1,
		ScalarRealType	B1,
		ScalarRealType	W1,
		ScalarRealType	L1,
		ScalarRealType	A2,
		ScalarRealType	B2,
		ScalarRealType	W2,
		ScalarRealType	L2,
		ScalarRealType &	N0,
		ScalarRealType &	N1,
		ScalarRealType &	N2,
		ScalarRealType &	N3,
		ScalarRealType &	SN,
		ScalarRealType &	DN,
		ScalarRealType &	EN
	)

private

Compute the N coefficients in the recursive filter.

◆ ComputeRemainingCoefficients()

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::ComputeRemainingCoefficients ( bool symmetric )

private

Compute the M coefficients and the boundary coefficients in the recursive filter.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage = TInputImage>

const char* itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >.

◆ GetNormalizeAcrossScale()

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual bool itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::GetNormalizeAcrossScale ( ) const

virtual

◆ GetOrder()

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual GaussianOrderEnum itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::GetOrder ( ) const

virtual

Set/Get the Order of the Gaussian to convolve with.

ZeroOrder is equivalent to convolving with a Gaussian. This is the default.
FirstOrder is equivalent to convolving with the first derivative of a Gaussian.
SecondOrder is equivalent to convolving with the second derivative of a Gaussian.

◆ GetSigma()

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual ScalarRealType itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::GetSigma ( ) const

virtual

Set/Get the Sigma, measured in world coordinates, of the Gaussian kernel. The default is 1.0. An exception will be generated if the Sigma value is less than or equal to zero.

◆ New()

template<typename TInputImage , typename TOutputImage = TInputImage>

static Pointer itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

◆ NormalizeAcrossScaleOn()

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual void itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::NormalizeAcrossScaleOn ( )

virtual

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::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::RecursiveSeparableImageFilter< TInputImage, TOutputImage >.

◆ SetFirstOrder()

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetFirstOrder ( )

Explicitly set a first order derivative.

◆ SetNormalizeAcrossScale()

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual void itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetNormalizeAcrossScale ( bool _arg )

virtual

Set/Get the flag for normalizing the gaussian over scale-space.

This flag enables the analysis of the differential shape of features independent of their size ( both pixels and physical size ). Following the notation of Tony Lindeberg:

Let

\[ L(x; t) = g(x; t) \ast f(x) \]

be the scale-space representation of image

\[ f(x) \]

where

\[ g(x; t) = \frac{1}{ \sqrt{ 2 \pi t} } \exp{ \left( -\frac{x^2}{ 2 t } \right) } \]

is the Gaussian function and

\[\ast\]

denotes convolution. This is a change from above with

\[ t = \sigma^2 \]

.

Then the normalized derivative operator for normalized coordinates across scale is:

\[ \partial_\xi = \sqrt{t} \partial_x \]

The resulting scaling factor is

\[ \sigma^N \]

where N is the order of the derivative.

When this flag is ON the filter will be normalized in such a way that the values of derivatives are not biased by the size of the object. That is to say the maximum value a feature reaches across scale is independent of the scale of the object.

For analyzing an image across scale-space you want to enable this flag. It is disabled by default.

Note: Not all scale space axioms are satisfied by this filter, some are only approximated. Particularly, at fine scales ( say less than 1 pixel ) other methods such as a discrete Gaussian kernel should be considered.

◆ SetOrder()

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual void itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetOrder ( GaussianOrderEnum _arg )

virtual

Set/Get the Order of the Gaussian to convolve with.

ZeroOrder is equivalent to convolving with a Gaussian. This is the default.
FirstOrder is equivalent to convolving with the first derivative of a Gaussian.
SecondOrder is equivalent to convolving with the second derivative of a Gaussian.

◆ SetSecondOrder()

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetSecondOrder ( )

Explicitly set a second order derivative.

◆ SetSigma()

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual void itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetSigma ( ScalarRealType _arg )

virtual

Set/Get the Sigma, measured in world coordinates, of the Gaussian kernel. The default is 1.0. An exception will be generated if the Sigma value is less than or equal to zero.

◆ SetUp()

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetUp ( ScalarRealType spacing )

overrideprotectedvirtual

Set up the coefficients of the filter to approximate a specific kernel. Here it is used to approximate a Gaussian or one of its derivatives. Parameter is the spacing along the dimension to filter.

Implements itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >.

◆ SetZeroOrder()

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::SetZeroOrder ( )

Explicitly set a zeroth order derivative.

◆ VerifyPreconditions()

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::VerifyPreconditions ( ) const

overrideprotectedvirtual

Verifies that the process object has been configured correctly, that all required inputs are set, and needed parameters are set appropriately. If not valid an exceptions will be thrown.

This method is called before UpdateOutputInformation() is propagated to the inputs.

The ProcessObject's implementation verifies that the m_NumberOfRequiredInputs are set and not null.

Reimplemented from itk::ProcessObject.

Member Data Documentation

◆ m_NormalizeAcrossScale

template<typename TInputImage , typename TOutputImage = TInputImage>

bool itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::m_NormalizeAcrossScale {}

private

Normalize the image across scale space

Definition at line 266 of file itkRecursiveGaussianImageFilter.h.

◆ m_Order

template<typename TInputImage , typename TOutputImage = TInputImage>

GaussianOrderEnum itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::m_Order {}

private

Definition at line 268 of file itkRecursiveGaussianImageFilter.h.

◆ m_Sigma

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >::m_Sigma {}

private

Sigma of the gaussian kernel.

Definition at line 263 of file itkRecursiveGaussianImageFilter.h.

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

itkRecursiveGaussianImageFilter.h

Detailed Description

template<typename TInputImage, typename TOutputImage = TInputImage> class itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ OutputImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ RecursiveGaussianImageFilter()

◆ ~RecursiveGaussianImageFilter()

Member Function Documentation

◆ ComputeDCoefficients()

◆ ComputeNCoefficients()

◆ ComputeRemainingCoefficients()

◆ GetNameOfClass()

◆ GetNormalizeAcrossScale()

◆ GetOrder()

◆ GetSigma()

◆ New()

◆ NormalizeAcrossScaleOn()

◆ PrintSelf()

◆ SetFirstOrder()

◆ SetNormalizeAcrossScale()

◆ SetOrder()

◆ SetSecondOrder()

◆ SetSigma()

◆ SetUp()

◆ SetZeroOrder()

◆ VerifyPreconditions()

Member Data Documentation

◆ m_NormalizeAcrossScale

◆ m_Order

◆ m_Sigma

template<typename TInputImage, typename TOutputImage = TInputImage>
class itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >