Computes the smoothing of an image by convolution with the Gaussian kernels implemented as IIR filters. More...

#include <sitkSmoothingRecursiveGaussianImageFilter.h>

Inheritance diagram for itk::simple::SmoothingRecursiveGaussianImageFilter:

Collaboration diagram for itk::simple::SmoothingRecursiveGaussianImageFilter:

Detailed Description

Computes the smoothing of an image by convolution with the Gaussian kernels implemented as IIR filters.

This filter is implemented using the recursive gaussian filters. For multi-component images, the filter works on each component independently.

For this filter to be able to run in-place the input and output image types need to be the same and/or the same type as the RealImageType.

See also: itk::simple::SmoothingRecursiveGaussian for the procedural interface; itk::SmoothingRecursiveGaussianImageFilter for the Doxygen on the original ITK class.

Examples: CppInPlace/CppInPlace.cxx, and SimpleGaussian/SimpleGaussian.cxx.

Definition at line 43 of file sitkSmoothingRecursiveGaussianImageFilter.h.

Public Types
using	PixelIDTypeList = typelist2::append< BasicPixelIDTypeList, VectorPixelIDTypeList >::type

using	Self = SmoothingRecursiveGaussianImageFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
Image	Execute (const Image &image1)

Image	Execute (Image &&image1)

std::string	GetName () const

bool	GetNormalizeAcrossScale () const

std::vector< double >	GetSigma () const

Self &	NormalizeAcrossScaleOff ()

Self &	NormalizeAcrossScaleOn ()

Self &	SetNormalizeAcrossScale (bool NormalizeAcrossScale)

Self &	SetSigma (double value)

Self &	SetSigma (std::vector< double > Sigma)

	SmoothingRecursiveGaussianImageFilter ()

std::string	ToString () const

virtual	~SmoothingRecursiveGaussianImageFilter ()

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
bool	m_InPlace {false}

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

bool	m_NormalizeAcrossScale {false}

std::vector< double >	m_Sigma {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::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::SmoothingRecursiveGaussianImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 106 of file sitkSmoothingRecursiveGaussianImageFilter.h.

◆ PixelIDTypeList

using itk::simple::SmoothingRecursiveGaussianImageFilter::PixelIDTypeList = typelist2::append<BasicPixelIDTypeList, VectorPixelIDTypeList>::type

Define the pixels types supported by this filter

Definition at line 55 of file sitkSmoothingRecursiveGaussianImageFilter.h.

◆ Self

using itk::simple::SmoothingRecursiveGaussianImageFilter::Self = SmoothingRecursiveGaussianImageFilter

Definition at line 45 of file sitkSmoothingRecursiveGaussianImageFilter.h.

Constructor & Destructor Documentation

◆ ~SmoothingRecursiveGaussianImageFilter()

virtual itk::simple::SmoothingRecursiveGaussianImageFilter::~SmoothingRecursiveGaussianImageFilter ( )

virtual

Destructor

◆ SmoothingRecursiveGaussianImageFilter()

itk::simple::SmoothingRecursiveGaussianImageFilter::SmoothingRecursiveGaussianImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

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

◆ Execute() [2/2]

Image itk::simple::SmoothingRecursiveGaussianImageFilter::Execute ( Image && image1 )

Execute the filter on the input image

Examples: CppInPlace/CppInPlace.cxx, and SimpleGaussian/SimpleGaussian.cxx.

◆ ExecuteInternal()

template<class TImageType >

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

private

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 90 of file sitkSmoothingRecursiveGaussianImageFilter.h.

◆ GetNormalizeAcrossScale()

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

inline

     Set/Get the flag for normalizing the Gaussian over scale-space. This method does not effect the output of this filter.

See also: RecursiveGaussianImageFilter::SetNormalizeAcrossScale

Definition at line 87 of file sitkSmoothingRecursiveGaussianImageFilter.h.

◆ GetSigma()

std::vector<double> itk::simple::SmoothingRecursiveGaussianImageFilter::GetSigma ( ) const

inline

Get the Sigma scalar. If the Sigma is anisotropic, we will just return the Sigma along the first dimension.

Definition at line 69 of file sitkSmoothingRecursiveGaussianImageFilter.h.

◆ NormalizeAcrossScaleOff()

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

inline

Definition at line 80 of file sitkSmoothingRecursiveGaussianImageFilter.h.

◆ NormalizeAcrossScaleOn()

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

inline

Set the value of NormalizeAcrossScale to true or false respectfully.

Definition at line 79 of file sitkSmoothingRecursiveGaussianImageFilter.h.

◆ SetNormalizeAcrossScale()

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

inline

     Set/Get the flag for normalizing the Gaussian over scale-space. This method does not effect the output of this filter.

See also: RecursiveGaussianImageFilter::SetNormalizeAcrossScale

Definition at line 76 of file sitkSmoothingRecursiveGaussianImageFilter.h.

◆ SetSigma() [1/2]

Self& itk::simple::SmoothingRecursiveGaussianImageFilter::SetSigma ( double value )

inline

Set the values of the Sigma vector all to value

Definition at line 64 of file sitkSmoothingRecursiveGaussianImageFilter.h.

◆ SetSigma() [2/2]

Self& itk::simple::SmoothingRecursiveGaussianImageFilter::SetSigma ( std::vector< double > Sigma )

inline

Set the standard deviation of the Gaussian used for smoothing. Sigma is measured in the units of image spacing. You may use the method SetSigma to set the same value across each axis or use the method SetSigmaArray if you need different values along each axis.