itk::simple::DiscreteGaussianDerivativeImageFilter Class Reference

Calculates image derivatives using discrete derivative gaussian kernels. This filter calculates Gaussian derivative by separable convolution of an image and a discrete Gaussian derivative operator (kernel). More...

#include <sitkDiscreteGaussianDerivativeImageFilter.h>

Inheritance diagram for itk::simple::DiscreteGaussianDerivativeImageFilter:

Collaboration diagram for itk::simple::DiscreteGaussianDerivativeImageFilter:

Detailed Description

Calculates image derivatives using discrete derivative gaussian kernels. This filter calculates Gaussian derivative by separable convolution of an image and a discrete Gaussian derivative operator (kernel).

The Gaussian operators used here were described by Tony Lindeberg (Discrete Scale-Space Theory and the Scale-Space Primal Sketch. Dissertation. Royal Institute of Technology, Stockholm, Sweden. May 1991.)

The variance or standard deviation (sigma) will be evaluated as pixel units if SetUseImageSpacing is off (false) or as physical units if SetUseImageSpacing is on (true, default). The variance can be set independently in each dimension.

When the Gaussian kernel is small, this filter tends to run faster than itk::RecursiveGaussianImageFilter .

Author

Ivan Macia, Vicomtech, Spain, https://www.vicomtech.org/en

This implementation was taken from the Insight Journal paper: https://doi.org/10.54294/mrg5is

See also

GaussianDerivativeOperator

Image

Neighborhood

NeighborhoodOperator

itk::simple::DiscreteGaussianDerivative for the procedural interface

itk::DiscreteGaussianDerivativeImageFilter for the Doxygen on the original ITK class.

Definition at line 61 of file sitkDiscreteGaussianDerivativeImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList
using	Self = DiscreteGaussianDerivativeImageFilter
Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter
Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	DiscreteGaussianDerivativeImageFilter ()
Image	Execute (const Image &image1)
double	GetMaximumError () const
unsigned int	GetMaximumKernelWidth () const
std::string	GetName () const
bool	GetNormalizeAcrossScale () const
std::vector< unsigned int >	GetOrder () const
bool	GetUseImageSpacing () const
std::vector< double >	GetVariance () const
Self &	NormalizeAcrossScaleOff ()
Self &	NormalizeAcrossScaleOn ()
Self &	SetMaximumError (double MaximumError)
Self &	SetMaximumKernelWidth (unsigned int MaximumKernelWidth)
Self &	SetNormalizeAcrossScale (bool NormalizeAcrossScale)
Self &	SetOrder (std::vector< unsigned int > Order)
Self &	SetOrder (unsigned int value)
Self &	SetUseImageSpacing (bool UseImageSpacing)
Self &	SetVariance (double value)
Self &	SetVariance (std::vector< double > Variance)
std::string	ToString () const
Self &	UseImageSpacingOff ()
Self &	UseImageSpacingOn ()
virtual	~DiscreteGaussianDerivativeImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event. More...
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...
virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands. More...
virtual	~ProcessObject ()
virtual void	DebugOn ()
virtual void	DebugOff ()
virtual bool	GetDebug () const
virtual void	SetDebug (bool debugFlag)
virtual void	SetNumberOfThreads (unsigned int n)
virtual unsigned int	GetNumberOfThreads () const
virtual void	SetNumberOfWorkUnits (unsigned int n)
virtual unsigned int	GetNumberOfWorkUnits () const

Private Types
using	MemberFunctionType = Image(Self::*)(const Image &image1)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1)

Private Attributes
double	m_MaximumError {0.01}
unsigned int	m_MaximumKernelWidth {32u}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
bool	m_NormalizeAcrossScale {false}
std::vector< unsigned int >	m_Order {std::vector<unsigned int>(3, 1)}
bool	m_UseImageSpacing {true}
std::vector< double >	m_Variance {std::vector<double>(3, 0.0)}

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()
static void	GlobalDefaultDebugOff ()
static void	GlobalDefaultDebugOn ()
static void	SetGlobalDefaultDebug (bool debugFlag)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects. More...
static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects. More...
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects. More...
Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObject *	GetActiveProcess ()
virtual void	OnActiveProcessDelete ()
virtual void	onCommandDelete (const itk::simple::Command *cmd) noexcept
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default
	NonCopyable (const NonCopyable &)=delete
NonCopyable &	operator= (const NonCopyable &)=delete
Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void	FixNonZeroIndex (TImageType *img)
Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)
template<class TImageType >
static Image	CastITKToImage (TImageType *img)
static const itk::EventObject &	GetITKEventObject (EventEnum e)
template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)
static std::ostream &	ToStringHelper (std::ostream &os, const char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Member Typedef Documentation

MemberFunctionType

using itk::simple::DiscreteGaussianDerivativeImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 165 of file sitkDiscreteGaussianDerivativeImageFilter.h.

PixelIDTypeList

using itk::simple::DiscreteGaussianDerivativeImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 73 of file sitkDiscreteGaussianDerivativeImageFilter.h.

Self

using itk::simple::DiscreteGaussianDerivativeImageFilter::Self = DiscreteGaussianDerivativeImageFilter

Definition at line 63 of file sitkDiscreteGaussianDerivativeImageFilter.h.

Constructor & Destructor Documentation

~DiscreteGaussianDerivativeImageFilter()

virtual itk::simple::DiscreteGaussianDerivativeImageFilter::~DiscreteGaussianDerivativeImageFilter ( )

virtual

Destructor

DiscreteGaussianDerivativeImageFilter()

itk::simple::DiscreteGaussianDerivativeImageFilter::DiscreteGaussianDerivativeImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute()

Image itk::simple::DiscreteGaussianDerivativeImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

ExecuteInternal()

template<class TImageType >

Image itk::simple::DiscreteGaussianDerivativeImageFilter::ExecuteInternal ( const Image &  image1 )

private

GetMaximumError()

double itk::simple::DiscreteGaussianDerivativeImageFilter::GetMaximumError ( ) const

inline

The algorithm will size the discrete kernel so that the error resulting from truncation of the kernel is no greater than MaximumError. The default is 0.01 in each dimension.

Definition at line 120 of file sitkDiscreteGaussianDerivativeImageFilter.h.

GetMaximumKernelWidth()

unsigned int itk::simple::DiscreteGaussianDerivativeImageFilter::GetMaximumKernelWidth ( ) const

inline

Set the kernel to be no wider than MaximumKernelWidth pixels, even if MaximumError demands it. The default is 32 pixels.

Definition at line 110 of file sitkDiscreteGaussianDerivativeImageFilter.h.

GetName()

std::string itk::simple::DiscreteGaussianDerivativeImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 151 of file sitkDiscreteGaussianDerivativeImageFilter.h.

GetNormalizeAcrossScale()

bool itk::simple::DiscreteGaussianDerivativeImageFilter::GetNormalizeAcrossScale ( ) const

inline

Set/Get the flag for calculating scale-space normalized derivatives. Normalized derivatives are obtained multiplying by the scale parameter t.

Definition at line 148 of file sitkDiscreteGaussianDerivativeImageFilter.h.

GetOrder()

std::vector<unsigned int> itk::simple::DiscreteGaussianDerivativeImageFilter::GetOrder ( ) const

inline

Order of derivatives in each dimension. Sets the derivative order independently for each dimension, but see also SetOrder(const unsigned int v) . The default is 1 in each dimension.

Definition at line 100 of file sitkDiscreteGaussianDerivativeImageFilter.h.

GetUseImageSpacing()

bool itk::simple::DiscreteGaussianDerivativeImageFilter::GetUseImageSpacing ( ) const

inline

Set/Get whether or not the filter will use the spacing of the input image in its calculations. Default is ImageSpacingOn.

Definition at line 134 of file sitkDiscreteGaussianDerivativeImageFilter.h.

GetVariance()

std::vector<double> itk::simple::DiscreteGaussianDerivativeImageFilter::GetVariance ( ) const

inline

The variance for the discrete Gaussian kernel. Sets the variance independently for each dimension, but see also SetVariance(const double v) . The default is 0.0 in each dimension. If UseImageSpacing is true, the units are the physical units of your image. If UseImageSpacing is false then the units are pixels.

Definition at line 87 of file sitkDiscreteGaussianDerivativeImageFilter.h.

NormalizeAcrossScaleOff()

Self& itk::simple::DiscreteGaussianDerivativeImageFilter::NormalizeAcrossScaleOff ( )

inline

Definition at line 143 of file sitkDiscreteGaussianDerivativeImageFilter.h.

NormalizeAcrossScaleOn()

Self& itk::simple::DiscreteGaussianDerivativeImageFilter::NormalizeAcrossScaleOn ( )

inline

Set the value of NormalizeAcrossScale to true or false respectfully.

Definition at line 142 of file sitkDiscreteGaussianDerivativeImageFilter.h.

SetMaximumError()

Self& itk::simple::DiscreteGaussianDerivativeImageFilter::SetMaximumError ( double  MaximumError )

inline

Convenience Set methods for setting all dimensional parameters to the same values.

Definition at line 115 of file sitkDiscreteGaussianDerivativeImageFilter.h.

SetMaximumKernelWidth()

Self& itk::simple::DiscreteGaussianDerivativeImageFilter::SetMaximumKernelWidth ( unsigned int  MaximumKernelWidth )

inline

Set the kernel to be no wider than MaximumKernelWidth pixels, even if MaximumError demands it. The default is 32 pixels.

Definition at line 105 of file sitkDiscreteGaussianDerivativeImageFilter.h.

SetNormalizeAcrossScale()

Self& itk::simple::DiscreteGaussianDerivativeImageFilter::SetNormalizeAcrossScale ( bool  NormalizeAcrossScale )

inline

Set/Get the flag for calculating scale-space normalized derivatives. Normalized derivatives are obtained multiplying by the scale parameter t.

Definition at line 139 of file sitkDiscreteGaussianDerivativeImageFilter.h.

SetOrder() [1/2]

Self& itk::simple::DiscreteGaussianDerivativeImageFilter::SetOrder ( std::vector< unsigned int >  Order )

inline

Convenience Set methods for setting all dimensional parameters to the same values.

Definition at line 92 of file sitkDiscreteGaussianDerivativeImageFilter.h.

SetOrder() [2/2]

Self& itk::simple::DiscreteGaussianDerivativeImageFilter::SetOrder ( unsigned int  value )

inline

Set the values of the Order vector all to value

Definition at line 95 of file sitkDiscreteGaussianDerivativeImageFilter.h.

SetUseImageSpacing()

Self& itk::simple::DiscreteGaussianDerivativeImageFilter::SetUseImageSpacing ( bool  UseImageSpacing )

inline

Set/Get whether or not the filter will use the spacing of the input image in its calculations. Default is ImageSpacingOn.

Definition at line 125 of file sitkDiscreteGaussianDerivativeImageFilter.h.

SetVariance() [1/2]

Self& itk::simple::DiscreteGaussianDerivativeImageFilter::SetVariance ( double  value )

inline

Set the values of the Variance vector all to value

Definition at line 82 of file sitkDiscreteGaussianDerivativeImageFilter.h.

SetVariance() [2/2]

Self& itk::simple::DiscreteGaussianDerivativeImageFilter::SetVariance ( std::vector< double >  Variance )

inline

Convenience Set methods for setting all dimensional parameters to the same values.

Definition at line 79 of file sitkDiscreteGaussianDerivativeImageFilter.h.

ToString()

std::string itk::simple::DiscreteGaussianDerivativeImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

UseImageSpacingOff()

Self& itk::simple::DiscreteGaussianDerivativeImageFilter::UseImageSpacingOff ( )

inline

Definition at line 129 of file sitkDiscreteGaussianDerivativeImageFilter.h.

UseImageSpacingOn()

Self& itk::simple::DiscreteGaussianDerivativeImageFilter::UseImageSpacingOn ( )

inline

Set the value of UseImageSpacing to true or false respectfully.

Definition at line 128 of file sitkDiscreteGaussianDerivativeImageFilter.h.

Friends And Related Function Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 169 of file sitkDiscreteGaussianDerivativeImageFilter.h.

Member Data Documentation

m_MaximumError

double itk::simple::DiscreteGaussianDerivativeImageFilter::m_MaximumError {0.01}

private

Definition at line 180 of file sitkDiscreteGaussianDerivativeImageFilter.h.

m_MaximumKernelWidth

unsigned int itk::simple::DiscreteGaussianDerivativeImageFilter::m_MaximumKernelWidth {32u}

private

Definition at line 178 of file sitkDiscreteGaussianDerivativeImageFilter.h.

m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::DiscreteGaussianDerivativeImageFilter::m_MemberFactory

private

Definition at line 171 of file sitkDiscreteGaussianDerivativeImageFilter.h.

m_NormalizeAcrossScale

bool itk::simple::DiscreteGaussianDerivativeImageFilter::m_NormalizeAcrossScale {false}

private

Definition at line 184 of file sitkDiscreteGaussianDerivativeImageFilter.h.

m_Order

std::vector<unsigned int> itk::simple::DiscreteGaussianDerivativeImageFilter::m_Order {std::vector<unsigned int>(3, 1)}

private

Definition at line 176 of file sitkDiscreteGaussianDerivativeImageFilter.h.

m_UseImageSpacing

bool itk::simple::DiscreteGaussianDerivativeImageFilter::m_UseImageSpacing {true}

private

Definition at line 182 of file sitkDiscreteGaussianDerivativeImageFilter.h.

m_Variance

std::vector<double> itk::simple::DiscreteGaussianDerivativeImageFilter::m_Variance {std::vector<double>(3, 0.0)}

private

Definition at line 174 of file sitkDiscreteGaussianDerivativeImageFilter.h.

---

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

• sitkDiscreteGaussianDerivativeImageFilter.h