Blurs an image by separable convolution with discrete gaussian kernels. This filter performs Gaussian blurring by separable convolution of an image and a discrete Gaussian operator (kernel). More...

#include <sitkDiscreteGaussianImageFilter.h>

Inheritance diagram for itk::simple::DiscreteGaussianImageFilter:

Collaboration diagram for itk::simple::DiscreteGaussianImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList

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

Image	Execute (const Image &image1)

Image	Execute (const Image &image1, double variance, unsigned int maximumKernelWidth, double maximumError, bool useImageSpacing)

double	GetMaximumError () const

unsigned int	GetMaximumKernelWidth () const

std::string	GetName () const

bool	GetUseImageSpacing () const

double	GetVariance () const

Self &	SetMaximumError (double MaximumError)

Self &	SetMaximumKernelWidth (unsigned int MaximumKernelWidth)

Self &	SetUseImageSpacing (bool UseImageSpacing)

Self &	SetVariance (double Variance)

std::string	ToString () const

Self &	UseImageSpacingOff ()

Self &	UseImageSpacingOn ()

	~DiscreteGaussianImageFilter ()

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_UseImageSpacing

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

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

Blurs an image by separable convolution with discrete gaussian kernels. This filter performs Gaussian blurring by separable convolution of an image and a discrete Gaussian operator (kernel).

The Gaussian operator used here was described by Tony Lindeberg (Discrete Scale-Space Theory and the Scale-Space Primal Sketch. Dissertation. Royal Institute of Technology, Stockholm, Sweden. May 1991.) The Gaussian kernel used here was designed so that smoothing and derivative operations commute after discretization.

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 .

See also: GaussianOperator; Image; Neighborhood; NeighborhoodOperator; RecursiveGaussianImageFilter

Wiki Examples:

All Examples

Smooth an image with a discrete Gaussian filter
See also
itk::simple::DiscreteGaussian for the procedural interface

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

Examples:: FilterProgressReporting/FilterProgressReporting.cxx.

Definition at line 62 of file sitkDiscreteGaussianImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 138 of file sitkDiscreteGaussianImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::DiscreteGaussianImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 74 of file sitkDiscreteGaussianImageFilter.h.

typedef DiscreteGaussianImageFilter itk::simple::DiscreteGaussianImageFilter::Self

Definition at line 64 of file sitkDiscreteGaussianImageFilter.h.

Constructor & Destructor Documentation

itk::simple::DiscreteGaussianImageFilter::DiscreteGaussianImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

itk::simple::DiscreteGaussianImageFilter::~DiscreteGaussianImageFilter ( )

Destructor

Member Function Documentation

Image itk::simple::DiscreteGaussianImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

Examples:: FilterProgressReporting/FilterProgressReporting.cxx.

Image itk::simple::DiscreteGaussianImageFilter::Execute	(	const Image &	image1,
		double	variance,
		unsigned int	maximumKernelWidth,
		double	maximumError,
		bool	useImageSpacing
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

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

private

double itk::simple::DiscreteGaussianImageFilter::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 104 of file sitkDiscreteGaussianImageFilter.h.

unsigned int itk::simple::DiscreteGaussianImageFilter::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 95 of file sitkDiscreteGaussianImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 120 of file sitkDiscreteGaussianImageFilter.h.

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

inline

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

Definition at line 118 of file sitkDiscreteGaussianImageFilter.h.

double itk::simple::DiscreteGaussianImageFilter::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 85 of file sitkDiscreteGaussianImageFilter.h.

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

inline

Definition at line 99 of file sitkDiscreteGaussianImageFilter.h.

Self& itk::simple::DiscreteGaussianImageFilter::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 90 of file sitkDiscreteGaussianImageFilter.h.

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

inline

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

Definition at line 109 of file sitkDiscreteGaussianImageFilter.h.