SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::BilateralImageFilter Class Reference

Blurs an image while preserving edges. More...

#include <sitkBilateralImageFilter.h>

+ Inheritance diagram for itk::simple::BilateralImageFilter:
+ Collaboration diagram for itk::simple::BilateralImageFilter:

Public Types

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

Public Member Functions

 BilateralImageFilter ()
 
Image Execute (const Image &image1)
 
double GetDomainSigma () const
 
std::string GetName () const
 
unsigned int GetNumberOfRangeGaussianSamples () const
 
double GetRangeSigma () const
 
SelfSetDomainSigma (double DomainSigma)
 
SelfSetNumberOfRangeGaussianSamples (unsigned int NumberOfRangeGaussianSamples)
 
SelfSetRangeSigma (double RangeSigma)
 
std::string ToString () const
 
virtual ~BilateralImageFilter ()
 
- 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)
 
template<class TImageType >
Image ExecuteInternalVectorImage (const Image &image)
 

Private Attributes

double m_DomainSigma {4.0}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
unsigned int m_NumberOfRangeGaussianSamples {100u}
 
double m_RangeSigma {50.0}
 

Friends

struct detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >
 
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<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)
 

Detailed Description

Blurs an image while preserving edges.

This filter uses bilateral filtering to blur an image using both domain and range "neighborhoods". Pixels that are close to a pixel in the image domain and similar to a pixel in the image range are used to calculate the filtered value. Two gaussian kernels (one in the image domain and one in the image range) are used to smooth the image. The result is an image that is smoothed in homogeneous regions yet has edges preserved. The result is similar to anisotropic diffusion but the implementation in non-iterative. Another benefit to bilateral filtering is that any distance metric can be used for kernel smoothing the image range. Hence, color images can be smoothed as vector images, using the CIE distances between intensity values as the similarity metric (the Gaussian kernel for the image domain is evaluated using CIE distances). A separate version of this filter will be designed for color and vector images.

Bilateral filtering is capable of reducing the noise in an image by an order of magnitude while maintaining edges.

The bilateral operator used here was described by Tomasi and Manduchi (Bilateral Filtering for Gray and ColorImages. IEEE ICCV. 1998.)

See also
GaussianOperator
RecursiveGaussianImageFilter
DiscreteGaussianImageFilter
AnisotropicDiffusionImageFilter
Image
Neighborhood
NeighborhoodOperator

TodoSupport color images

Support vector images

See also
itk::simple::Bilateral for the procedural interface
itk::BilateralImageFilter for the Doxygen on the original ITK class.

Definition at line 71 of file sitkBilateralImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::BilateralImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )
private

Setup for member function dispatching

Definition at line 131 of file sitkBilateralImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 83 of file sitkBilateralImageFilter.h.

◆ Self

Definition at line 73 of file sitkBilateralImageFilter.h.

Constructor & Destructor Documentation

◆ ~BilateralImageFilter()

virtual itk::simple::BilateralImageFilter::~BilateralImageFilter ( )
virtual

Destructor

◆ BilateralImageFilter()

itk::simple::BilateralImageFilter::BilateralImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ ExecuteInternalVectorImage()

template<class TImageType >
Image itk::simple::BilateralImageFilter::ExecuteInternalVectorImage ( const Image image)
private

Dispatched methods which calls ExecuteInteral on each component

◆ GetDomainSigma()

double itk::simple::BilateralImageFilter::GetDomainSigma ( ) const
inline

Standard get/set macros for filter parameters. DomainSigma is specified in the same units as the Image spacing. RangeSigma is specified in the units of intensity.

Definition at line 94 of file sitkBilateralImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 117 of file sitkBilateralImageFilter.h.

◆ GetNumberOfRangeGaussianSamples()

unsigned int itk::simple::BilateralImageFilter::GetNumberOfRangeGaussianSamples ( ) const
inline

Set/Get the number of samples in the approximation to the Gaussian used for the range smoothing. Samples are only generated in the range of [0, 4*m_RangeSigma]. Default is 100.

Definition at line 114 of file sitkBilateralImageFilter.h.

◆ GetRangeSigma()

double itk::simple::BilateralImageFilter::GetRangeSigma ( ) const
inline

Standard get/set macros for filter parameters. DomainSigma is specified in the same units as the Image spacing. RangeSigma is specified in the units of intensity.

Definition at line 104 of file sitkBilateralImageFilter.h.

◆ SetDomainSigma()

Self& itk::simple::BilateralImageFilter::SetDomainSigma ( double  DomainSigma)
inline

Convenience get/set methods for setting all domain parameters to the same values.

Definition at line 89 of file sitkBilateralImageFilter.h.

◆ SetNumberOfRangeGaussianSamples()

Self& itk::simple::BilateralImageFilter::SetNumberOfRangeGaussianSamples ( unsigned int  NumberOfRangeGaussianSamples)
inline

Set/Get the number of samples in the approximation to the Gaussian used for the range smoothing. Samples are only generated in the range of [0, 4*m_RangeSigma]. Default is 100.

Definition at line 109 of file sitkBilateralImageFilter.h.

◆ SetRangeSigma()

Self& itk::simple::BilateralImageFilter::SetRangeSigma ( double  RangeSigma)
inline

Standard get/set macros for filter parameters. DomainSigma is specified in the same units as the Image spacing. RangeSigma is specified in the units of intensity.

Definition at line 99 of file sitkBilateralImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >

Definition at line 137 of file sitkBilateralImageFilter.h.

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 136 of file sitkBilateralImageFilter.h.

Member Data Documentation

◆ m_DomainSigma

double itk::simple::BilateralImageFilter::m_DomainSigma {4.0}
private

Definition at line 141 of file sitkBilateralImageFilter.h.

◆ m_MemberFactory

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

Definition at line 138 of file sitkBilateralImageFilter.h.

◆ m_NumberOfRangeGaussianSamples

unsigned int itk::simple::BilateralImageFilter::m_NumberOfRangeGaussianSamples {100u}
private

Definition at line 145 of file sitkBilateralImageFilter.h.

◆ m_RangeSigma

double itk::simple::BilateralImageFilter::m_RangeSigma {50.0}
private

Definition at line 143 of file sitkBilateralImageFilter.h.


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