#include <itkCurvatureFlowFunction.h>

Inheritance diagram for itk::CurvatureFlowFunction< TImage >:

Collaboration diagram for itk::CurvatureFlowFunction< TImage >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::FloatOffsetType	FloatOffsetType
typedef Superclass::ImageType	ImageType
typedef Superclass::NeighborhoodScalesType	NeighborhoodScalesType
typedef Superclass::NeighborhoodType	NeighborhoodType
typedef Superclass::PixelRealType	PixelRealType
typedef Superclass::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef Superclass::RadiusType	RadiusType
typedef PixelType	ScalarValueType
typedef CurvatureFlowFunction	Self
typedef FiniteDifferenceFunction < TImage >	Superclass
typedef Superclass::TimeStepType	TimeStepType
Public Types inherited from itk::FiniteDifferenceFunction< TImage >
typedef ZeroFluxNeumannBoundaryCondition < ImageType >	DefaultBoundaryConditionType
Public Types inherited from itk::LightObject

Public Member Functions
virtual TimeStepType	ComputeGlobalTimeStep (void *GlobalData) const
virtual PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void *	GetGlobalDataPointer () const
virtual const char *	GetNameOfClass () const
const TimeStepType &	GetTimeStep () const
virtual void	ReleaseGlobalDataPointer (void *GlobalData) const
void	SetTimeStep (const TimeStepType &t)
Public Member Functions inherited from itk::FiniteDifferenceFunction< TImage >
const NeighborhoodScalesType	ComputeNeighborhoodScales () const
const RadiusType &	GetRadius () const
virtual void	InitializeIteration ()
void	SetRadius (const RadiusType &r)
void	SetScaleCoefficients (PixelRealType vals[ImageDimension])
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::FiniteDifferenceFunction< TImage >

Protected Member Functions
	CurvatureFlowFunction ()
	~CurvatureFlowFunction ()
Protected Member Functions inherited from itk::FiniteDifferenceFunction< TImage >
	FiniteDifferenceFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const
	~FiniteDifferenceFunction ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
	CurvatureFlowFunction (const Self &)
void	operator= (const Self &)

Private Attributes
TimeStepType	m_TimeStep

Additional Inherited Members
Protected Attributes inherited from itk::FiniteDifferenceFunction< TImage >
RadiusType	m_Radius
PixelRealType	m_ScaleCoefficients [ImageDimension]
Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Detailed Description

template<class TImage>
class itk::CurvatureFlowFunction< TImage >

This class encapsulate the finite difference equation which drives a curvature flow denoising algorithm.

This class uses a zero flux Neumann boundary condition when computing derivatives near the data boundary.

This class operates as part of the finite difference solver hierarchy.

See also:: CurvatureFlowImageFilter; ZeroFluxNeumannBoundaryCondition

Definition at line 43 of file itkCurvatureFlowFunction.h.

Member Typedef Documentation

template<class TImage >

typedef SmartPointer< const Self > itk::CurvatureFlowFunction< TImage >::ConstPointer

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Reimplemented in itk::BinaryMinMaxCurvatureFlowFunction< TImage >, and itk::MinMaxCurvatureFlowFunction< TImage >.

Definition at line 51 of file itkCurvatureFlowFunction.h.

template<class TImage >

typedef Superclass::FloatOffsetType itk::CurvatureFlowFunction< TImage >::FloatOffsetType

A floating point offset from an image grid location. Used for interpolation among grid values in a neighborhood.

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Reimplemented in itk::MinMaxCurvatureFlowFunction< TImage >, and itk::BinaryMinMaxCurvatureFlowFunction< TImage >.

Definition at line 68 of file itkCurvatureFlowFunction.h.

template<class TImage >

typedef Superclass::ImageType itk::CurvatureFlowFunction< TImage >::ImageType

Inherit some parameters from the superclass type.

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Reimplemented in itk::BinaryMinMaxCurvatureFlowFunction< TImage >, and itk::MinMaxCurvatureFlowFunction< TImage >.

Definition at line 58 of file itkCurvatureFlowFunction.h.

template<class TImage >

typedef Superclass::NeighborhoodScalesType itk::CurvatureFlowFunction< TImage >::NeighborhoodScalesType

The type of data structure that holds the scales with which the neighborhood is weighted to properly account for spacing and neighborhood radius.

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Definition at line 67 of file itkCurvatureFlowFunction.h.

template<class TImage >

typedef Superclass::NeighborhoodType itk::CurvatureFlowFunction< TImage >::NeighborhoodType

The type of data structure that is passed to this function object to evaluate at a pixel that does not lie on a data set boundary.

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Reimplemented in itk::MinMaxCurvatureFlowFunction< TImage >, and itk::BinaryMinMaxCurvatureFlowFunction< TImage >.

Definition at line 66 of file itkCurvatureFlowFunction.h.

template<class TImage >

typedef Superclass::PixelRealType itk::CurvatureFlowFunction< TImage >::PixelRealType

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Definition at line 65 of file itkCurvatureFlowFunction.h.

template<class TImage >

typedef Superclass::PixelType itk::CurvatureFlowFunction< TImage >::PixelType

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Reimplemented in itk::MinMaxCurvatureFlowFunction< TImage >, and itk::BinaryMinMaxCurvatureFlowFunction< TImage >.

Definition at line 62 of file itkCurvatureFlowFunction.h.

template<class TImage >

typedef SmartPointer< Self > itk::CurvatureFlowFunction< TImage >::Pointer

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Reimplemented in itk::BinaryMinMaxCurvatureFlowFunction< TImage >, and itk::MinMaxCurvatureFlowFunction< TImage >.

Definition at line 50 of file itkCurvatureFlowFunction.h.

template<class TImage >

typedef Superclass::RadiusType itk::CurvatureFlowFunction< TImage >::RadiusType

Neighborhood radius type

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Reimplemented in itk::MinMaxCurvatureFlowFunction< TImage >, and itk::BinaryMinMaxCurvatureFlowFunction< TImage >.

Definition at line 63 of file itkCurvatureFlowFunction.h.

template<class TImage >

typedef PixelType itk::CurvatureFlowFunction< TImage >::ScalarValueType

Definition at line 64 of file itkCurvatureFlowFunction.h.

template<class TImage >

typedef CurvatureFlowFunction itk::CurvatureFlowFunction< TImage >::Self

Standard class typedefs.

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Reimplemented in itk::BinaryMinMaxCurvatureFlowFunction< TImage >, and itk::MinMaxCurvatureFlowFunction< TImage >.

Definition at line 48 of file itkCurvatureFlowFunction.h.

template<class TImage >

typedef FiniteDifferenceFunction< TImage > itk::CurvatureFlowFunction< TImage >::Superclass

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Reimplemented in itk::BinaryMinMaxCurvatureFlowFunction< TImage >, and itk::MinMaxCurvatureFlowFunction< TImage >.

Definition at line 49 of file itkCurvatureFlowFunction.h.

template<class TImage >

typedef Superclass::TimeStepType itk::CurvatureFlowFunction< TImage >::TimeStepType

Define the TimeStepType to always be double.

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Definition at line 69 of file itkCurvatureFlowFunction.h.

Constructor & Destructor Documentation

template<class TImage >

itk::CurvatureFlowFunction< TImage >::CurvatureFlowFunction ( )

protected

template<class TImage >

itk::CurvatureFlowFunction< TImage >::~CurvatureFlowFunction ( )

inlineprotected

Definition at line 140 of file itkCurvatureFlowFunction.h.

template<class TImage >

itk::CurvatureFlowFunction< TImage >::CurvatureFlowFunction ( const Self & )

private

Member Function Documentation

template<class TImage >

virtual TimeStepType itk::CurvatureFlowFunction< TImage >::ComputeGlobalTimeStep ( void * GlobalData ) const

virtual

Computes the time step for an update given a global data structure. The data used in the computation may take different forms depending on the nature of the equations. This global data cannot be kept in the instance of the equation object itself since the equation object must remain stateless for thread safety. The global data is therefore managed for each thread by the finite difference solver filters.

Currently, this function returns the user specified constant time step.

Todo:: compute timestep based on CFL condition.

Implements itk::FiniteDifferenceFunction< TImage >.

template<class TImage >

virtual PixelType itk::CurvatureFlowFunction< TImage >::ComputeUpdate	(	const NeighborhoodType &	neighborhood,
		void *	globalData,
		const FloatOffsetType &	offset = `FloatOffsetType(0.0)`
	)

virtual

This method computes the solution update for each pixel that does not lie on a the data set boundary.

Implements itk::FiniteDifferenceFunction< TImage >.

Reimplemented in itk::MinMaxCurvatureFlowFunction< TImage >, and itk::BinaryMinMaxCurvatureFlowFunction< TImage >.

template<class TImage >

virtual::itk::LightObject::Pointer itk::CurvatureFlowFunction< TImage >::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::LightObject.

Reimplemented in itk::BinaryMinMaxCurvatureFlowFunction< TImage >, and itk::MinMaxCurvatureFlowFunction< TImage >.

template<class TImage >

virtual void* itk::CurvatureFlowFunction< TImage >::GetGlobalDataPointer ( ) const

inlinevirtual

Returns a pointer to a global data structure that is passed to this object from the solver at each calculation. The idea is that the solver holds the state of any global values needed to calculate the time step, while the equation object performs the actual calculations. The global data should also be initialized in this method.

Implements itk::FiniteDifferenceFunction< TImage >.

Definition at line 91 of file itkCurvatureFlowFunction.h.

template<class TImage >

virtual const char* itk::CurvatureFlowFunction< TImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods)

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Reimplemented in itk::BinaryMinMaxCurvatureFlowFunction< TImage >, and itk::MinMaxCurvatureFlowFunction< TImage >.

template<class TImage >

const TimeStepType& itk::CurvatureFlowFunction< TImage >::GetTimeStep ( ) const

inline

Get the time step parameter

Definition at line 111 of file itkCurvatureFlowFunction.h.

template<class TImage >

static Pointer itk::CurvatureFlowFunction< TImage >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::LightObject.

Reimplemented in itk::BinaryMinMaxCurvatureFlowFunction< TImage >, and itk::MinMaxCurvatureFlowFunction< TImage >.

template<class TImage >

void itk::CurvatureFlowFunction< TImage >::operator= ( const Self & )

private

Mutex lock to protect modification to the reference count

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Reimplemented in itk::MinMaxCurvatureFlowFunction< TImage >, and itk::BinaryMinMaxCurvatureFlowFunction< TImage >.

template<class TImage >

virtual void itk::CurvatureFlowFunction< TImage >::ReleaseGlobalDataPointer ( void * GlobalData ) const

inlinevirtual

When the finite difference solver filter has finished using a global data pointer, it passes it to this method, which frees the memory. The solver cannot free the memory because it does not know the type to which the pointer points.

Implements itk::FiniteDifferenceFunction< TImage >.

Definition at line 103 of file itkCurvatureFlowFunction.h.

template<class TImage >

void itk::CurvatureFlowFunction< TImage >::SetTimeStep ( const TimeStepType & t )

inline

Set the time step parameter

Definition at line 107 of file itkCurvatureFlowFunction.h.