ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
itk::CurvatureFlowImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkCurvatureFlowImageFilter.h>

+ Inheritance diagram for itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef CurvatureFlowFunction
< OutputImageType
CurvatureFlowFunctionType
typedef
Superclass::FiniteDifferenceFunctionType 
FiniteDifferenceFunctionType
typedef Superclass::InputImageType InputImageType
typedef OutputImageType::Pointer OutputImagePointer
typedef Superclass::OutputImageType OutputImageType
typedef Superclass::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef CurvatureFlowImageFilter Self
typedef
DenseFiniteDifferenceImageFilter
< TInputImage, TOutputImage > 
Superclass
typedef Superclass::TimeStepType TimeStepType

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
virtual TimeStepType GetTimeStep () const
virtual void SetTimeStep (TimeStepType _arg)
 typedef (Concept::Convertible< double, PixelType >) DoubleConvertibleToOutputCheck
 typedef (Concept::Convertible< PixelType, double >) OutputConvertibleToDoubleCheck
 typedef (Concept::DivisionOperators< PixelType >) OutputDivisionOperatorsCheck
 typedef (Concept::MultiplyOperator< double, PixelType, PixelType >) DoubleOutputMultiplyOperatorCheck
 typedef (Concept::MultiplyOperator< int, PixelType, PixelType >) IntOutputMultiplyOperatorCheck
 typedef (Concept::LessThanComparable< PixelType, double >) OutputLessThanDoubleCheck
 typedef (Concept::AdditiveOperators< PixelType, double >) OutputDoubleAdditiveOperatorsCheck

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = Superclass::ImageDimension

Protected Member Functions

virtual void EnlargeOutputRequestedRegion (DataObject *)
virtual void GenerateInputRequestedRegion ()
virtual void InitializeIteration ()
 CurvatureFlowImageFilter ()
 ~CurvatureFlowImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual bool Halt ()

Private Member Functions

 CurvatureFlowImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

TimeStepType m_TimeStep

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >

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 occuring 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.

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 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:
DenseFiniteDifferenceImageFilter
CurvatureFlowFunction
MinMaxCurvatureFlowImageFilter
BinaryMinMaxCurvatureFlowImageFilter

Input/Output Restrictions: TInputImage and TOutputImage must have the same dimension. TOutputImage's pixel type must be a real number type.

Definition at line 90 of file itkCurvatureFlowImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef SmartPointer< const Self > itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef CurvatureFlowFunction< OutputImageType > itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::CurvatureFlowFunctionType

CurvatureFlowFunction type.

Definition at line 120 of file itkCurvatureFlowImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef Superclass::FiniteDifferenceFunctionType itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::FiniteDifferenceFunctionType
template<class TInputImage , class TOutputImage >
typedef Superclass::InputImageType itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::InputImageType

InputImage type.

Reimplemented from itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 105 of file itkCurvatureFlowImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef OutputImageType::Pointer itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::OutputImagePointer
template<class TInputImage , class TOutputImage >
typedef Superclass::OutputImageType itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::OutputImageType
template<class TInputImage , class TOutputImage >
typedef Superclass::PixelType itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::PixelType

The pixel type of the output image will be used in computations. Inherited from the superclass.

Reimplemented from itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 128 of file itkCurvatureFlowImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef SmartPointer< Self > itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::Pointer
template<class TInputImage , class TOutputImage >
typedef CurvatureFlowImageFilter itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::Self
template<class TInputImage , class TOutputImage >
typedef DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::Superclass
template<class TInputImage , class TOutputImage >
typedef Superclass::TimeStepType itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::TimeStepType

The time step type. Inherited from the superclass.

Reimplemented from itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 131 of file itkCurvatureFlowImageFilter.h.


Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::CurvatureFlowImageFilter ( ) [protected]

End concept checking

template<class TInputImage , class TOutputImage >
itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::~CurvatureFlowImageFilter ( ) [inline, protected]

End concept checking

Definition at line 160 of file itkCurvatureFlowImageFilter.h.

template<class TInputImage , class TOutputImage >
itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::CurvatureFlowImageFilter ( const Self ) [private]

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

Reimplemented in itk::MinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, and itk::BinaryMinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual void itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion ( DataObject ) [protected, virtual]

To support streaming, this filter produces a output which is larger than the original requested region. The output is padding by m_NumberOfIterations pixels on edge.

Reimplemented from itk::ProcessObject.

template<class TInputImage , class TOutputImage >
virtual void itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( ) [protected, virtual]

Edge effects are taken care of by padding the output requested region. As such, the input requested region needs to at minimum the same size as the output requested region.

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual const char* itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]
template<class TInputImage , class TOutputImage >
virtual TimeStepType itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::GetTimeStep ( ) const [virtual]

Get the timestep parameter.

template<class TInputImage , class TOutputImage >
virtual bool itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::Halt ( ) [inline, protected, virtual]

Supplies the halting criteria for this class of filters. The algorithm will stop after a user-specified number of iterations.

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 166 of file itkCurvatureFlowImageFilter.h.

template<class TInputImage , class TOutputImage >
virtual void itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::InitializeIteration ( ) [protected, virtual]

Initialize the state of filter and equation before each iteration. Progress feeback is implemented as part of this method.

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::MinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, and itk::BinaryMinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
static Pointer itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::New ( ) [static]
template<class TInputImage , class TOutputImage >
void itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::operator= ( const Self ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::MinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, and itk::BinaryMinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
void itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]
template<class TInputImage , class TOutputImage >
virtual void itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::SetTimeStep ( TimeStepType  _arg) [virtual]

Set the timestep parameter.

template<class TInputImage , class TOutputImage >
itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< double, PixelType )

Begin concept checking This class requires DoubleConvertibleToOutputCheck in the form of ( Concept::Convertible< double, PixelType > )

template<class TInputImage , class TOutputImage >
itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< PixelType, double >  )

This class requires OutputConvertibleToDoubleCheck in the form of ( Concept::Convertible< PixelType, double > )

template<class TInputImage , class TOutputImage >
itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::typedef ( Concept::DivisionOperators< PixelType )

This class requires OutputDivisionOperatorsCheck in the form of ( Concept::DivisionOperators< PixelType > )

template<class TInputImage , class TOutputImage >
itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::typedef ( Concept::MultiplyOperator< double, PixelType, PixelType )

This class requires DoubleOutputMultiplyOperatorCheck in the form of ( Concept::MultiplyOperator< double, PixelType, PixelType > )

template<class TInputImage , class TOutputImage >
itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::typedef ( Concept::MultiplyOperator< int, PixelType, PixelType )

This class requires IntOutputMultiplyOperatorCheck in the form of ( Concept::MultiplyOperator< int, PixelType, PixelType > )

template<class TInputImage , class TOutputImage >
itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::typedef ( Concept::LessThanComparable< PixelType, double >  )

This class requires OutputLessThanDoubleCheck in the form of ( Concept::LessThanComparable< PixelType, double > )

template<class TInputImage , class TOutputImage >
itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::typedef ( Concept::AdditiveOperators< PixelType, double >  )

This class requires OutputDoubleAdditiveOperatorsCheck in the form of ( Concept::AdditiveOperators< PixelType, double > )


Member Data Documentation

template<class TInputImage , class TOutputImage >
const unsigned int itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::ImageDimension = Superclass::ImageDimension [static]

Dimensionality of input and output data is assumed to be the same. It is inherited from the superclass.

Reimplemented from itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::MinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, and itk::BinaryMinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >.

Definition at line 124 of file itkCurvatureFlowImageFilter.h.

template<class TInputImage , class TOutputImage >
TimeStepType itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >::m_TimeStep [private]

Definition at line 197 of file itkCurvatureFlowImageFilter.h.


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