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

Denoise an image using min/max curvature flow. More...

#include <sitkMinMaxCurvatureFlowImageFilter.h>

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

Public Types

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

Public Member Functions

Image Execute (const Image &image1)
 
Image Execute (Image &&image1)
 
std::string GetName () const
 
uint32_t GetNumberOfIterations () const
 
int GetStencilRadius () const
 
double GetTimeStep () const
 
 MinMaxCurvatureFlowImageFilter ()
 
SelfSetNumberOfIterations (uint32_t NumberOfIterations)
 
SelfSetStencilRadius (int StencilRadius)
 
SelfSetTimeStep (double TimeStep)
 
std::string ToString () const
 
virtual ~MinMaxCurvatureFlowImageFilter ()
 
- 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_TimeStep {0.05}
 

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::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 min/max curvature flow.

MinMaxCurvatureFlowImageFilter 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 = F_{\mbox{minmax}} |\nabla I| \]

where \( F_{\mbox{minmax}} = \max(\kappa,0) \) if \( \mbox{Avg}_{\mbox{stencil}}(x) \) is less than or equal to \( T_{threshold} \) and \( \min(\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 the average intensity obtained in the direction perpendicular to the gradient at point \( x \) at the extrema of the local neighborhood.

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

Warning
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, however for dimensions greater than 3D, an expensive brute-force search is used to compute the local threshold.

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

See also
MinMaxCurvatureFlowFunction
CurvatureFlowImageFilter
BinaryMinMaxCurvatureFlowImageFilter
itk::simple::MinMaxCurvatureFlow for the procedural interface
itk::MinMaxCurvatureFlowImageFilter for the Doxygen on the original ITK class.

Definition at line 65 of file sitkMinMaxCurvatureFlowImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 123 of file sitkMinMaxCurvatureFlowImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 77 of file sitkMinMaxCurvatureFlowImageFilter.h.

◆ Self

Definition at line 67 of file sitkMinMaxCurvatureFlowImageFilter.h.

Constructor & Destructor Documentation

◆ ~MinMaxCurvatureFlowImageFilter()

virtual itk::simple::MinMaxCurvatureFlowImageFilter::~MinMaxCurvatureFlowImageFilter ( )
virtual

Destructor

◆ MinMaxCurvatureFlowImageFilter()

itk::simple::MinMaxCurvatureFlowImageFilter::MinMaxCurvatureFlowImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

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

◆ Execute() [2/2]

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 107 of file sitkMinMaxCurvatureFlowImageFilter.h.

◆ GetNumberOfIterations()

uint32_t itk::simple::MinMaxCurvatureFlowImageFilter::GetNumberOfIterations ( ) const
inline

Definition at line 94 of file sitkMinMaxCurvatureFlowImageFilter.h.

◆ GetStencilRadius()

int itk::simple::MinMaxCurvatureFlowImageFilter::GetStencilRadius ( ) const
inline

Set/Get the stencil radius.

Definition at line 104 of file sitkMinMaxCurvatureFlowImageFilter.h.

◆ GetTimeStep()

double itk::simple::MinMaxCurvatureFlowImageFilter::GetTimeStep ( ) const
inline

Definition at line 86 of file sitkMinMaxCurvatureFlowImageFilter.h.

◆ SetNumberOfIterations()

Self& itk::simple::MinMaxCurvatureFlowImageFilter::SetNumberOfIterations ( uint32_t  NumberOfIterations)
inline

Definition at line 90 of file sitkMinMaxCurvatureFlowImageFilter.h.

◆ SetStencilRadius()

Self& itk::simple::MinMaxCurvatureFlowImageFilter::SetStencilRadius ( int  StencilRadius)
inline

Set/Get the stencil radius.

Definition at line 99 of file sitkMinMaxCurvatureFlowImageFilter.h.

◆ SetTimeStep()

Self& itk::simple::MinMaxCurvatureFlowImageFilter::SetTimeStep ( double  TimeStep)
inline

Definition at line 82 of file sitkMinMaxCurvatureFlowImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 127 of file sitkMinMaxCurvatureFlowImageFilter.h.

Member Data Documentation

◆ m_InPlace

bool itk::simple::MinMaxCurvatureFlowImageFilter::m_InPlace {false}
private

Definition at line 141 of file sitkMinMaxCurvatureFlowImageFilter.h.

◆ m_MemberFactory

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

Definition at line 129 of file sitkMinMaxCurvatureFlowImageFilter.h.

◆ m_NumberOfIterations

uint32_t itk::simple::MinMaxCurvatureFlowImageFilter::m_NumberOfIterations {5u}
private

Definition at line 136 of file sitkMinMaxCurvatureFlowImageFilter.h.

◆ m_StencilRadius

int itk::simple::MinMaxCurvatureFlowImageFilter::m_StencilRadius {2}
private

Definition at line 138 of file sitkMinMaxCurvatureFlowImageFilter.h.

◆ m_TimeStep

double itk::simple::MinMaxCurvatureFlowImageFilter::m_TimeStep {0.05}
private

Definition at line 133 of file sitkMinMaxCurvatureFlowImageFilter.h.


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