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

This filter performs anisotropic diffusion on a scalar itk::Image using the modified curvature diffusion equation (MCDE). More...

#include <sitkCurvatureAnisotropicDiffusionImageFilter.h>

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

Public Types

using PixelIDTypeList = RealPixelIDTypeList
using Self = CurvatureAnisotropicDiffusionImageFilter
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject

Public Member Functions

 CurvatureAnisotropicDiffusionImageFilter ()
double EstimateOptimalTimeStep (Image &inImage)
Image Execute (const Image &image1)
Image Execute (Image &&image1)
double GetConductanceParameter () const
unsigned int GetConductanceScalingUpdateInterval () const
std::string GetName () const
uint32_t GetNumberOfIterations () const
double GetTimeStep () const
SelfSetConductanceParameter (double ConductanceParameter)
SelfSetConductanceScalingUpdateInterval (unsigned int ConductanceScalingUpdateInterval)
SelfSetNumberOfIterations (uint32_t NumberOfIterations)
SelfSetTimeStep (double TimeStep)
std::string ToString () const
virtual ~CurvatureAnisotropicDiffusionImageFilter ()
- 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

double m_ConductanceParameter {3.0}
unsigned int m_ConductanceScalingUpdateInterval {1u}
bool m_InPlace {false}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
uint32_t m_NumberOfIterations {5u}
double m_TimeStep {0.0625}


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)

Detailed Description

This filter performs anisotropic diffusion on a scalar itk::Image using the modified curvature diffusion equation (MCDE).

For detailed information on anisotropic diffusion and the MCDE see itkAnisotropicDiffusionFunction and itkCurvatureNDAnisotropicDiffusionFunction.

Inputs and Outputs
The input and output to this filter must be a scalar itk::Image with numerical pixel types (float or double). A user defined type which correctly defines arithmetic operations with floating point accuracy should also give correct results.
Please first read all the documentation found in AnisotropicDiffusionImageFilter and AnisotropicDiffusionFunction . Also see CurvatureNDAnisotropicDiffusionFunction .

The default time step for this filter is set to the maximum theoretically stable value: 0.5 / 2^N, where N is the dimensionality of the image. For a 2D image, this means valid time steps are below 0.1250. For a 3D image, valid time steps are below 0.0625.

See also
itk::simple::CurvatureAnisotropicDiffusion for the procedural interface
itk::CurvatureAnisotropicDiffusionImageFilter for the Doxygen on the original ITK class.

Definition at line 59 of file sitkCurvatureAnisotropicDiffusionImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 127 of file sitkCurvatureAnisotropicDiffusionImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 71 of file sitkCurvatureAnisotropicDiffusionImageFilter.h.

◆ Self

Constructor & Destructor Documentation

◆ ~CurvatureAnisotropicDiffusionImageFilter()

virtual itk::simple::CurvatureAnisotropicDiffusionImageFilter::~CurvatureAnisotropicDiffusionImageFilter ( )


◆ CurvatureAnisotropicDiffusionImageFilter()

itk::simple::CurvatureAnisotropicDiffusionImageFilter::CurvatureAnisotropicDiffusionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ EstimateOptimalTimeStep()

double itk::simple::CurvatureAnisotropicDiffusionImageFilter::EstimateOptimalTimeStep ( Image inImage)

This method autmatically sets the optimal timestep for an image given its spacing.

◆ Execute() [1/2]

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

◆ Execute() [2/2]

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

Execute the filter on the input image


◆ ExecuteInternal()

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

◆ GetConductanceParameter()

double itk::simple::CurvatureAnisotropicDiffusionImageFilter::GetConductanceParameter ( ) const

◆ GetConductanceScalingUpdateInterval()

unsigned int itk::simple::CurvatureAnisotropicDiffusionImageFilter::GetConductanceScalingUpdateInterval ( ) const

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 107 of file sitkCurvatureAnisotropicDiffusionImageFilter.h.

◆ GetNumberOfIterations()

uint32_t itk::simple::CurvatureAnisotropicDiffusionImageFilter::GetNumberOfIterations ( ) const

◆ GetTimeStep()

double itk::simple::CurvatureAnisotropicDiffusionImageFilter::GetTimeStep ( ) const

◆ SetConductanceParameter()

Self& itk::simple::CurvatureAnisotropicDiffusionImageFilter::SetConductanceParameter ( double  ConductanceParameter)

◆ SetConductanceScalingUpdateInterval()

Self& itk::simple::CurvatureAnisotropicDiffusionImageFilter::SetConductanceScalingUpdateInterval ( unsigned int  ConductanceScalingUpdateInterval)

◆ SetNumberOfIterations()

Self& itk::simple::CurvatureAnisotropicDiffusionImageFilter::SetNumberOfIterations ( uint32_t  NumberOfIterations)

◆ SetTimeStep()

Self& itk::simple::CurvatureAnisotropicDiffusionImageFilter::SetTimeStep ( double  TimeStep)

◆ ToString()

std::string itk::simple::CurvatureAnisotropicDiffusionImageFilter::ToString ( ) const

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_ConductanceParameter

double itk::simple::CurvatureAnisotropicDiffusionImageFilter::m_ConductanceParameter {3.0}

◆ m_ConductanceScalingUpdateInterval

unsigned int itk::simple::CurvatureAnisotropicDiffusionImageFilter::m_ConductanceScalingUpdateInterval {1u}

◆ m_InPlace

bool itk::simple::CurvatureAnisotropicDiffusionImageFilter::m_InPlace {false}

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::CurvatureAnisotropicDiffusionImageFilter::m_MemberFactory

◆ m_NumberOfIterations

uint32_t itk::simple::CurvatureAnisotropicDiffusionImageFilter::m_NumberOfIterations {5u}

◆ m_TimeStep

double itk::simple::CurvatureAnisotropicDiffusionImageFilter::m_TimeStep {0.0625}

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