SimpleITK  1.3.0.dev466
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::SmoothingRecursiveGaussianImageFilter Class Reference

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:

Public Types

typedef typelist::Append< BasicPixelIDTypeList, VectorPixelIDTypeList >::Type PixelIDTypeList
 
typedef SmoothingRecursiveGaussianImageFilter 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

Image Execute (const Image &image1)
 
Image Execute (const Image &image1, const std::vector< double > &sigma, bool normalizeAcrossScale)
 
std::string GetName () const
 
bool GetNormalizeAcrossScale () const
 
std::vector< double > GetSigma () const
 
SelfNormalizeAcrossScaleOff ()
 
SelfNormalizeAcrossScaleOn ()
 
SelfSetNormalizeAcrossScale (bool NormalizeAcrossScale)
 
SelfSetSigma (const std::vector< double > &Sigma)
 
SelfSetSigma (double value)
 
 SmoothingRecursiveGaussianImageFilter ()
 
std::string ToString () const
 
virtual ~SmoothingRecursiveGaussianImageFilter ()
 
- 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

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
bool m_NormalizeAcrossScale
 
std::vector< double > m_Sigma
 

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::ProcessObjectGetActiveProcess ()
 
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::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)
 

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:
SimpleGaussian/SimpleGaussian.cxx.

Definition at line 44 of file sitkSmoothingRecursiveGaussianImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 109 of file sitkSmoothingRecursiveGaussianImageFilter.h.

Define the pixels types supported by this filter

Definition at line 56 of file sitkSmoothingRecursiveGaussianImageFilter.h.

Definition at line 46 of file sitkSmoothingRecursiveGaussianImageFilter.h.

Constructor & Destructor Documentation

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

Destructor

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Examples:
SimpleGaussian/SimpleGaussian.cxx.
Image itk::simple::SmoothingRecursiveGaussianImageFilter::Execute ( const Image image1,
const std::vector< double > &  sigma,
bool  normalizeAcrossScale 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::SmoothingRecursiveGaussianImageFilter::ExecuteInternal ( const Image image1)
private
std::string itk::simple::SmoothingRecursiveGaussianImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 92 of file sitkSmoothingRecursiveGaussianImageFilter.h.

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 90 of file sitkSmoothingRecursiveGaussianImageFilter.h.

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 72 of file sitkSmoothingRecursiveGaussianImageFilter.h.

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

Definition at line 83 of file sitkSmoothingRecursiveGaussianImageFilter.h.

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

Set the value of NormalizeAcrossScale to true or false respectfully.

Definition at line 82 of file sitkSmoothingRecursiveGaussianImageFilter.h.

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 79 of file sitkSmoothingRecursiveGaussianImageFilter.h.

Self& itk::simple::SmoothingRecursiveGaussianImageFilter::SetSigma ( const 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.

Examples:
SimpleGaussian/SimpleGaussian.cxx.

Definition at line 63 of file sitkSmoothingRecursiveGaussianImageFilter.h.

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

Set the values of the Sigma vector all to value

Definition at line 66 of file sitkSmoothingRecursiveGaussianImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 113 of file sitkSmoothingRecursiveGaussianImageFilter.h.

Member Data Documentation

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::SmoothingRecursiveGaussianImageFilter::m_MemberFactory
private

Definition at line 115 of file sitkSmoothingRecursiveGaussianImageFilter.h.

bool itk::simple::SmoothingRecursiveGaussianImageFilter::m_NormalizeAcrossScale
private

Definition at line 121 of file sitkSmoothingRecursiveGaussianImageFilter.h.

std::vector<double> itk::simple::SmoothingRecursiveGaussianImageFilter::m_Sigma
private

Definition at line 119 of file sitkSmoothingRecursiveGaussianImageFilter.h.


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