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:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList
typedef DiscreteGaussianDerivativeImageFilter	Self
Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter	Self
Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
	DiscreteGaussianDerivativeImageFilter ()
Image	Execute (const Image &image1)
Image	Execute (const Image &image1, const std::vector< double > &variance, const std::vector< unsigned int > &order, unsigned int maximumKernelWidth, double maximumError, bool useImageSpacing, bool normalizeAcrossScale)
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 (const std::vector< unsigned int > &Order)
Self &	SetOrder (unsigned int value)
Self &	SetUseImageSpacing (bool UseImageSpacing)
Self &	SetVariance (const std::vector< double > &Variance)
Self &	SetVariance (double value)
std::string	ToString () const
Self &	UseImageSpacingOff ()
Self &	UseImageSpacingOn ()
virtual	~DiscreteGaussianDerivativeImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter< 1 >
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
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

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

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

Private Attributes
double	m_MaximumError
unsigned int	m_MaximumKernelWidth
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
bool	m_NormalizeAcrossScale
std::vector< unsigned int >	m_Order
bool	m_UseImageSpacing
std::vector< double >	m_Variance

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 void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
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...
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) SITK_NOEXCEPT
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()
Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
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 TImageType >
static Image	CastITKToImage (TImageType *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)
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)

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, http://www.vicomtech.es

This implementation was taken from the Insight Journal paper: https://hdl.handle.net/1926/1290

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 58 of file sitkDiscreteGaussianDerivativeImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 167 of file sitkDiscreteGaussianDerivativeImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::DiscreteGaussianDerivativeImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 70 of file sitkDiscreteGaussianDerivativeImageFilter.h.

typedef DiscreteGaussianDerivativeImageFilter itk::simple::DiscreteGaussianDerivativeImageFilter::Self

Definition at line 60 of file sitkDiscreteGaussianDerivativeImageFilter.h.

Constructor & Destructor Documentation

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

virtual

Destructor

itk::simple::DiscreteGaussianDerivativeImageFilter::DiscreteGaussianDerivativeImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::DiscreteGaussianDerivativeImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Image itk::simple::DiscreteGaussianDerivativeImageFilter::Execute	(	const Image &	image1,
		const std::vector< double > &	variance,
		const std::vector< unsigned int > &	order,
		unsigned int	maximumKernelWidth,
		double	maximumError,
		bool	useImageSpacing,
		bool	normalizeAcrossScale
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

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

private

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.

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.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 150 of file sitkDiscreteGaussianDerivativeImageFilter.h.

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.

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.

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.

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 86 of file sitkDiscreteGaussianDerivativeImageFilter.h.

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

inline

Definition at line 143 of file sitkDiscreteGaussianDerivativeImageFilter.h.

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

inline

Set the value of NormalizeAcrossScale to true or false respectfully.

Definition at line 142 of file sitkDiscreteGaussianDerivativeImageFilter.h.

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.

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.

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.

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

inline

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

Definition at line 91 of file sitkDiscreteGaussianDerivativeImageFilter.h.

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

inline

Set the values of the Order vector all to value

Definition at line 94 of file sitkDiscreteGaussianDerivativeImageFilter.h.

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.

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

inline

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

Definition at line 77 of file sitkDiscreteGaussianDerivativeImageFilter.h.

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

inline

Set the values of the Variance vector all to value

Definition at line 80 of file sitkDiscreteGaussianDerivativeImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

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

inline

Definition at line 129 of file sitkDiscreteGaussianDerivativeImageFilter.h.

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

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 171 of file sitkDiscreteGaussianDerivativeImageFilter.h.

Member Data Documentation

double itk::simple::DiscreteGaussianDerivativeImageFilter::m_MaximumError

private

Definition at line 179 of file sitkDiscreteGaussianDerivativeImageFilter.h.

unsigned int itk::simple::DiscreteGaussianDerivativeImageFilter::m_MaximumKernelWidth

private

Definition at line 178 of file sitkDiscreteGaussianDerivativeImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::DiscreteGaussianDerivativeImageFilter::m_MemberFactory

private

Definition at line 173 of file sitkDiscreteGaussianDerivativeImageFilter.h.

bool itk::simple::DiscreteGaussianDerivativeImageFilter::m_NormalizeAcrossScale

private

Definition at line 181 of file sitkDiscreteGaussianDerivativeImageFilter.h.

std::vector<unsigned int> itk::simple::DiscreteGaussianDerivativeImageFilter::m_Order

private

Definition at line 177 of file sitkDiscreteGaussianDerivativeImageFilter.h.

bool itk::simple::DiscreteGaussianDerivativeImageFilter::m_UseImageSpacing

private

Definition at line 180 of file sitkDiscreteGaussianDerivativeImageFilter.h.

std::vector<double> itk::simple::DiscreteGaussianDerivativeImageFilter::m_Variance

private

Definition at line 176 of file sitkDiscreteGaussianDerivativeImageFilter.h.

---

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

• sitkDiscreteGaussianDerivativeImageFilter.h