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

Denoise a binary image using min/max curvature flow. More...

#include <sitkBinaryMinMaxCurvatureFlowImageFilter.h>

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

Public Types

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

Public Member Functions

 BinaryMinMaxCurvatureFlowImageFilter ()
Image Execute (const Image &image1)
Image Execute (Image &&image1)
std::string GetName () const
uint32_t GetNumberOfIterations () const
int GetStencilRadius () const
double GetThreshold () const
double GetTimeStep () const
SelfSetNumberOfIterations (uint32_t NumberOfIterations)
SelfSetStencilRadius (int StencilRadius)
SelfSetThreshold (double Threshold)
SelfSetTimeStep (double TimeStep)
std::string ToString () const
virtual ~BinaryMinMaxCurvatureFlowImageFilter ()
- 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}
int m_StencilRadius {2}
double m_Threshold {0.0}
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 a binary image using min/max curvature flow.

BinaryMinMaxCurvatureFlowImageFilter implements a curvature driven image denoising algorithm. This filter assumes that the image is essentially binary: consisting of two classes. Iso-brightness contours in the input image are viewed as a level set. The level set is then evolved using a curvature-based speed function:

\[ I_t = F_{\mbox{minmax}} |\nabla I| \]

where \( F_{\mbox{minmax}} = \min(\kappa,0) \) if \( \mbox{Avg}_{\mbox{stencil}}(x) \) is less than or equal to \( T_{threshold} \) and \( \max(\kappa,0) \) , otherwise. \( \kappa \) is the mean curvature of the iso-brightness contour at point \( x \) .

In min/max curvature flow, movement is turned on or off depending on the scale of the noise one wants to remove. Switching depends on the average image value of a region of radius \( R \) around each point. The choice of \( R \) , the stencil radius, governs the scale of the noise to be removed.

The threshold value \( T_{threshold} \) is a user specified value which discriminates between the two pixel classes.

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

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 real 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::BinaryMinMaxCurvatureFlow for the procedural interface
itk::BinaryMinMaxCurvatureFlowImageFilter for the Doxygen on the original ITK class.

Definition at line 65 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 131 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 77 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ Self

Definition at line 67 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

Constructor & Destructor Documentation

◆ ~BinaryMinMaxCurvatureFlowImageFilter()

virtual itk::simple::BinaryMinMaxCurvatureFlowImageFilter::~BinaryMinMaxCurvatureFlowImageFilter ( )


◆ BinaryMinMaxCurvatureFlowImageFilter()

itk::simple::BinaryMinMaxCurvatureFlowImageFilter::BinaryMinMaxCurvatureFlowImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

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

◆ Execute() [2/2]

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 115 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ GetNumberOfIterations()

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

Definition at line 94 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ GetStencilRadius()

int itk::simple::BinaryMinMaxCurvatureFlowImageFilter::GetStencilRadius ( ) const

Definition at line 102 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ GetThreshold()

double itk::simple::BinaryMinMaxCurvatureFlowImageFilter::GetThreshold ( ) const

Set/Get the threshold value.

Definition at line 112 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ GetTimeStep()

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

Definition at line 86 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ SetNumberOfIterations()

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

Definition at line 90 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ SetStencilRadius()

Self& itk::simple::BinaryMinMaxCurvatureFlowImageFilter::SetStencilRadius ( int  StencilRadius)

Definition at line 98 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ SetThreshold()

Self& itk::simple::BinaryMinMaxCurvatureFlowImageFilter::SetThreshold ( double  Threshold)

Set/Get the threshold value.

Definition at line 107 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

References itk::simple::Threshold().

◆ SetTimeStep()

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

Definition at line 82 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 135 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

Member Data Documentation

◆ m_InPlace

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

Definition at line 151 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ m_MemberFactory

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

Definition at line 137 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ m_NumberOfIterations

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

Definition at line 144 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ m_StencilRadius

int itk::simple::BinaryMinMaxCurvatureFlowImageFilter::m_StencilRadius {2}

Definition at line 146 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ m_Threshold

double itk::simple::BinaryMinMaxCurvatureFlowImageFilter::m_Threshold {0.0}

Definition at line 148 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

◆ m_TimeStep

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

Definition at line 141 of file sitkBinaryMinMaxCurvatureFlowImageFilter.h.

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