SimpleITK  2.0.0rc2.post23
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::CurvatureFlowImageFilter Class Reference

Denoise an image using curvature driven flow. More...

#include <sitkCurvatureFlowImageFilter.h>

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

Public Types

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

Public Member Functions

 CurvatureFlowImageFilter ()
Image Execute (const Image &image1)
Image Execute (Image &&image1)
std::string GetName () const
uint32_t GetNumberOfIterations () const
double GetTimeStep () const
SelfSetNumberOfIterations (uint32_t NumberOfIterations)
SelfSetTimeStep (double TimeStep)
std::string ToString () const
virtual ~CurvatureFlowImageFilter ()
- 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
uint32_t m_NumberOfIterations {5u}
double m_TimeStep {0.05}


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

Denoise an image using curvature driven flow.

CurvatureFlowImageFilter implements a curvature driven image denoising algorithm. Iso-brightness contours in the grayscale input image are viewed as a level set. The level set is then evolved using a curvature-based speed function:

\[ I_t = \kappa |\nabla I| \]

where \( \kappa \) is the curvature.

The advantage of this approach is that sharp boundaries are preserved with smoothing occurring only within a region. However, it should be noted that continuous application of this scheme will result in the eventual removal of all information as each contour shrinks to zero and disappear.

Note that unlike level set segmentation algorithms, the image to be denoised is already the level set and can be set directly as the input using the SetInput() method.

This filter has two parameters: the number of update iterations to be performed and the timestep between each update.

The timestep should be "small enough" to ensure numerical stability. Stability is guarantee when the timestep meets the CFL (Courant-Friedrichs-Levy) condition. Broadly speaking, this condition ensures that each contour does not move more than one grid position at each timestep. In the literature, the timestep is typically user specified and have to manually tuned to the application.

This filter make use of the multi-threaded finite difference solver hierarchy. Updates are computed using a CurvatureFlowFunction object. A zero flux Neumann boundary condition when computing derivatives near the data boundary.

This filter may be streamed. To support streaming this filter produces a padded output which takes into account edge effects. The size of the padding is m_NumberOfIterations on each edge. Users of this filter should only make use of the center valid central region.

This filter assumes that the input and output types have the same dimensions. This filter also requires that the output image pixels are of a floating point type. This filter works for any dimensional images.

Reference: "Level Set Methods and Fast Marching Methods", J.A. Sethian, Cambridge Press, Chapter 16, Second edition, 1999.

See also
itk::simple::CurvatureFlow for the procedural interface
itk::CurvatureFlowImageFilter for the Doxygen on the original ITK class.
Segmentation/ConnectedThresholdImageFilter.cxx, and Segmentation/NeighborhoodConnectedImageFilter.cxx.

Definition at line 72 of file sitkCurvatureFlowImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 122 of file sitkCurvatureFlowImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 84 of file sitkCurvatureFlowImageFilter.h.

◆ Self

Definition at line 74 of file sitkCurvatureFlowImageFilter.h.

Constructor & Destructor Documentation

◆ ~CurvatureFlowImageFilter()

virtual itk::simple::CurvatureFlowImageFilter::~CurvatureFlowImageFilter ( )


◆ CurvatureFlowImageFilter()

itk::simple::CurvatureFlowImageFilter::CurvatureFlowImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

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

◆ Execute() [2/2]

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

◆ ExecuteInternal()

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

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 106 of file sitkCurvatureFlowImageFilter.h.

◆ GetNumberOfIterations()

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

Definition at line 103 of file sitkCurvatureFlowImageFilter.h.

◆ GetTimeStep()

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

Get the timestep parameter.

Definition at line 95 of file sitkCurvatureFlowImageFilter.h.

◆ SetNumberOfIterations()

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

◆ SetTimeStep()

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

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 126 of file sitkCurvatureFlowImageFilter.h.

Member Data Documentation

◆ m_InPlace

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

Definition at line 138 of file sitkCurvatureFlowImageFilter.h.

◆ m_MemberFactory

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

Definition at line 128 of file sitkCurvatureFlowImageFilter.h.

◆ m_NumberOfIterations

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

Definition at line 135 of file sitkCurvatureFlowImageFilter.h.

◆ m_TimeStep

double itk::simple::CurvatureFlowImageFilter::m_TimeStep {0.05}

Definition at line 132 of file sitkCurvatureFlowImageFilter.h.

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