SimpleITK  
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::DiscreteGaussianImageFilter Class Reference

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:

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
itk::simple::DiscreteGaussian for the procedural interface
itk::DiscreteGaussianImageFilter for the Doxygen on the original ITK class.
Examples
FilterProgressReporting/FilterProgressReporting.cxx.

Definition at line 59 of file sitkDiscreteGaussianImageFilter.h.

Public Types

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

Public Member Functions

 DiscreteGaussianImageFilter ()
 
Image Execute (const Image &image1)
 
std::vector< double > GetMaximumError () const
 
unsigned int GetMaximumKernelWidth () const
 
std::string GetName () const
 
bool GetUseImageSpacing () const
 
std::vector< double > GetVariance () const
 
SelfSetMaximumError (double value)
 
SelfSetMaximumError (std::vector< double > MaximumError)
 
SelfSetMaximumKernelWidth (unsigned int MaximumKernelWidth)
 
SelfSetUseImageSpacing (bool UseImageSpacing)
 
SelfSetVariance (double value)
 
SelfSetVariance (std::vector< double > Variance)
 
std::string ToString () const
 
SelfUseImageSpacingOff ()
 
SelfUseImageSpacingOn ()
 
virtual ~DiscreteGaussianImageFilter ()
 
- 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

std::vector< double > m_MaximumError {std::vector<double>(3, 0.01)}
 
unsigned int m_MaximumKernelWidth {32u}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
bool m_UseImageSpacing {true}
 
std::vector< double > m_Variance {std::vector<double>(3,1.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::ProcessObjectGetActiveProcess ()
 
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
 
NonCopyableoperator= (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::EventObjectGetITKEventObject (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::DiscreteGaussianImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )
private

Setup for member function dispatching

Definition at line 137 of file sitkDiscreteGaussianImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 71 of file sitkDiscreteGaussianImageFilter.h.

◆ Self

Definition at line 61 of file sitkDiscreteGaussianImageFilter.h.

Constructor & Destructor Documentation

◆ ~DiscreteGaussianImageFilter()

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

Destructor

◆ DiscreteGaussianImageFilter()

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

Examples
FilterProgressReporting/FilterProgressReporting.cxx.

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::DiscreteGaussianImageFilter::ExecuteInternal ( const Image image1)
private

◆ GetMaximumError()

std::vector<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 106 of file sitkDiscreteGaussianImageFilter.h.

◆ GetMaximumKernelWidth()

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 94 of file sitkDiscreteGaussianImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 123 of file sitkDiscreteGaussianImageFilter.h.

◆ GetUseImageSpacing()

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. Use On to take the image spacing information into account and to specify the Gaussian variance in real world units; use Off to ignore the image spacing and to specify the Gaussian variance in voxel units. Default is On.

Definition at line 120 of file sitkDiscreteGaussianImageFilter.h.

◆ GetVariance()

std::vector<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 84 of file sitkDiscreteGaussianImageFilter.h.

◆ SetMaximumError() [1/2]

Self& itk::simple::DiscreteGaussianImageFilter::SetMaximumError ( double  value)
inline

Set the values of the MaximumError vector all to value

Definition at line 101 of file sitkDiscreteGaussianImageFilter.h.

◆ SetMaximumError() [2/2]

Self& itk::simple::DiscreteGaussianImageFilter::SetMaximumError ( std::vector< double >  MaximumError)
inline

Definition at line 98 of file sitkDiscreteGaussianImageFilter.h.

◆ SetMaximumKernelWidth()

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 89 of file sitkDiscreteGaussianImageFilter.h.

◆ SetUseImageSpacing()

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. Use On to take the image spacing information into account and to specify the Gaussian variance in real world units; use Off to ignore the image spacing and to specify the Gaussian variance in voxel units. Default is On.

Definition at line 111 of file sitkDiscreteGaussianImageFilter.h.

◆ SetVariance() [1/2]

Self& itk::simple::DiscreteGaussianImageFilter::SetVariance ( double  value)
inline

Set the values of the Variance vector all to value

Definition at line 79 of file sitkDiscreteGaussianImageFilter.h.

◆ SetVariance() [2/2]

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

◆ ToString()

std::string itk::simple::DiscreteGaussianImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

◆ UseImageSpacingOff()

Self& itk::simple::DiscreteGaussianImageFilter::UseImageSpacingOff ( )
inline

Definition at line 115 of file sitkDiscreteGaussianImageFilter.h.

◆ UseImageSpacingOn()

Self& itk::simple::DiscreteGaussianImageFilter::UseImageSpacingOn ( )
inline

Set the value of UseImageSpacing to true or false respectfully.

Definition at line 114 of file sitkDiscreteGaussianImageFilter.h.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 141 of file sitkDiscreteGaussianImageFilter.h.

Member Data Documentation

◆ m_MaximumError

std::vector<double> itk::simple::DiscreteGaussianImageFilter::m_MaximumError {std::vector<double>(3, 0.01)}
private

Definition at line 150 of file sitkDiscreteGaussianImageFilter.h.

◆ m_MaximumKernelWidth

unsigned int itk::simple::DiscreteGaussianImageFilter::m_MaximumKernelWidth {32u}
private

Definition at line 148 of file sitkDiscreteGaussianImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::DiscreteGaussianImageFilter::m_MemberFactory
private

Definition at line 143 of file sitkDiscreteGaussianImageFilter.h.

◆ m_UseImageSpacing

bool itk::simple::DiscreteGaussianImageFilter::m_UseImageSpacing {true}
private

Definition at line 152 of file sitkDiscreteGaussianImageFilter.h.

◆ m_Variance

std::vector<double> itk::simple::DiscreteGaussianImageFilter::m_Variance {std::vector<double>(3,1.0)}
private

Definition at line 146 of file sitkDiscreteGaussianImageFilter.h.


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