SimpleITK
2.0.0
|
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>
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 |
Self & | SetMaximumError (double value) |
Self & | SetMaximumError (std::vector< double > MaximumError) |
Self & | SetMaximumKernelWidth (unsigned int MaximumKernelWidth) |
Self & | SetUseImageSpacing (bool UseImageSpacing) |
Self & | SetVariance (double value) |
Self & | SetVariance (std::vector< double > Variance) |
std::string | ToString () const |
Self & | UseImageSpacingOff () |
Self & | UseImageSpacingOn () |
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::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<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) |
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 .
Definition at line 60 of file sitkDiscreteGaussianImageFilter.h.
|
private |
Setup for member function dispatching
Definition at line 138 of file sitkDiscreteGaussianImageFilter.h.
Define the pixels types supported by this filter
Definition at line 72 of file sitkDiscreteGaussianImageFilter.h.
Definition at line 62 of file sitkDiscreteGaussianImageFilter.h.
|
virtual |
Destructor
itk::simple::DiscreteGaussianImageFilter::DiscreteGaussianImageFilter | ( | ) |
Default Constructor that takes no arguments and initializes default parameters
Execute the filter on the input image
|
private |
|
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 107 of file sitkDiscreteGaussianImageFilter.h.
|
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.
|
inlinevirtual |
Name of this class
Implements itk::simple::ProcessObject.
Definition at line 124 of file sitkDiscreteGaussianImageFilter.h.
|
inline |
Set/Get whether or not the filter will use the spacing of the input image in its calculations
Definition at line 121 of file sitkDiscreteGaussianImageFilter.h.
|
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.
|
inline |
Set the values of the MaximumError vector all to value
Definition at line 102 of file sitkDiscreteGaussianImageFilter.h.
|
inline |
Definition at line 99 of file sitkDiscreteGaussianImageFilter.h.
|
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.
|
inline |
Set/Get whether or not the filter will use the spacing of the input image in its calculations
Definition at line 112 of file sitkDiscreteGaussianImageFilter.h.
|
inline |
Set the values of the Variance vector all to value
Definition at line 80 of file sitkDiscreteGaussianImageFilter.h.
|
inline |
Definition at line 77 of file sitkDiscreteGaussianImageFilter.h.
|
virtual |
Print ourselves out
Reimplemented from itk::simple::ProcessObject.
|
inline |
Definition at line 116 of file sitkDiscreteGaussianImageFilter.h.
|
inline |
Set the value of UseImageSpacing to true or false respectfully.
Definition at line 115 of file sitkDiscreteGaussianImageFilter.h.
|
friend |
Definition at line 142 of file sitkDiscreteGaussianImageFilter.h.
|
private |
Definition at line 151 of file sitkDiscreteGaussianImageFilter.h.
|
private |
Definition at line 149 of file sitkDiscreteGaussianImageFilter.h.
|
private |
Definition at line 144 of file sitkDiscreteGaussianImageFilter.h.
|
private |
Definition at line 153 of file sitkDiscreteGaussianImageFilter.h.
|
private |
Definition at line 147 of file sitkDiscreteGaussianImageFilter.h.