itk::CurvatureFlowFunction< TImage > Class Template Reference
[Finite Difference Functions]

#include <itkCurvatureFlowFunction.h>

Inheritance diagram for itk::CurvatureFlowFunction< TImage >:

[legend]Collaboration diagram for itk::CurvatureFlowFunction< TImage >:

[legend]List of all members.

---

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 41 of file itkCurvatureFlowFunction.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef ZeroFluxNeumannBoundaryCondition< ImageType >	DefaultBoundaryConditionType
typedef Superclass::FloatOffsetType	FloatOffsetType
typedef Superclass::ImageType	ImageType
typedef Superclass::NeighborhoodType	NeighborhoodType
typedef double	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 Member Functions
virtual TimeStepType	ComputeGlobalTimeStep (void *GlobalData) const
virtual PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))
virtual Pointer	CreateAnother () const
virtual void	Delete ()
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 *while the equation object performs the actual calculations The global *data should also be initialized in this method *virtual void *	GetGlobalDataPointer () const
virtual const char *	GetNameOfClass () const
const RadiusType &	GetRadius () const
virtual int	GetReferenceCount () const
const TimeStepType &	GetTimeStep () const
virtual void	InitializeIteration ()
	itkStaticConstMacro (ImageDimension, unsigned int, ImageType::ImageDimension)
	itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
virtual void	ReleaseGlobalDataPointer (void *GlobalData) const
void	SetRadius (const RadiusType &r)
virtual void	SetReferenceCount (int)
Set the ScaleCoefficients for the difference *operators The defaults a These can be set to take the image *spacing into account *void	SetScaleCoefficients (PixelRealType vals[ImageDimension])
void	SetTimeStep (const TimeStepType &t)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()
Public Attributes
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
Protected Member Functions
A global data type for this class of equations Used to store *values that are needed in calculating the time step *	CurvatureFlowFunction ()
	FiniteDifferenceFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	~CurvatureFlowFunction ()
Protected Attributes
RadiusType	m_Radius
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
PixelRealType	m_ScaleCoefficients [ImageDimension]
Methods invoked by virtual Print() to print information about the object *including superclasses.Typically not called by the user(use Print()*instead) but used in the hierarchical print process to combine the *output of several classes.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

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 49 of file itkCurvatureFlowFunction.h.

typedef ZeroFluxNeumannBoundaryCondition<ImageType> itk::FiniteDifferenceFunction< TImage >::DefaultBoundaryConditionType [inherited]

The default boundary condition for finite difference functions that is used unless overridden in the Evaluate() method. Definition at line 93 of file itkFiniteDifferenceFunction.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::BinaryMinMaxCurvatureFlowFunction< TImage >, and itk::MinMaxCurvatureFlowFunction< TImage >. Definition at line 64 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 56 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::BinaryMinMaxCurvatureFlowFunction< TImage >, and itk::MinMaxCurvatureFlowFunction< TImage >. Definition at line 63 of file itkCurvatureFlowFunction.h.

typedef double itk::FiniteDifferenceFunction< TImage >::PixelRealType [inherited]

Definition at line 82 of file itkFiniteDifferenceFunction.h.

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

Reimplemented from itk::FiniteDifferenceFunction< TImage >. Reimplemented in itk::BinaryMinMaxCurvatureFlowFunction< TImage >, and itk::MinMaxCurvatureFlowFunction< TImage >. Definition at line 60 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 48 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::BinaryMinMaxCurvatureFlowFunction< TImage >, and itk::MinMaxCurvatureFlowFunction< TImage >. Definition at line 61 of file itkCurvatureFlowFunction.h.

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

Definition at line 62 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 46 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 47 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 65 of file itkCurvatureFlowFunction.h.

---

Constructor & Destructor Documentation

template<class TImage> A global data type for this class of equations Used to store* values that are needed in calculating the time step* itk::CurvatureFlowFunction< TImage >::CurvatureFlowFunction (   )  [protected]

template<class TImage> itk::CurvatureFlowFunction< TImage >::~CurvatureFlowFunction (   )  [inline, protected]

Definition at line 135 of file itkCurvatureFlowFunction.h.

---

Member Function Documentation

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

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::BinaryMinMaxCurvatureFlowFunction< TImage >, and itk::MinMaxCurvatureFlowFunction< TImage >.

virtual Pointer itk::LightObject::CreateAnother (   )  const [virtual, inherited]

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 in itk::Object.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

itk::FiniteDifferenceFunction< TImage >::FiniteDifferenceFunction (   )  [inline, protected, inherited]

Definition at line 182 of file itkFiniteDifferenceFunction.h.

template<class TImage> 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 * while the equation object performs the actual calculations The global* data should also be initialized in this method* virtual void* itk::CurvatureFlowFunction< TImage >::GetGlobalDataPointer (   )  const [inline, virtual]

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

const RadiusType& itk::FiniteDifferenceFunction< TImage >::GetRadius (  void   )  const [inline, inherited]

Returns the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations. Definition at line 142 of file itkFiniteDifferenceFunction.h.

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

template<class TImage> const TimeStepType& itk::CurvatureFlowFunction< TImage >::GetTimeStep (   )  const [inline]

Get the time step parameter Definition at line 107 of file itkCurvatureFlowFunction.h.

virtual void itk::FiniteDifferenceFunction< TImage >::InitializeIteration (   )  [inline, virtual, inherited]

This method allows the function to set its state before each iteration of the finite difference solver (image filter) that uses it. This is a thread-safe time to manipulate the object's state. An example of how this can be used: the Anisotropic diffusion class of FiniteDifferenceFunctions use this method to pre-calculate an average gradient magnitude across the entire image region. This value is set in the function object and used by the ComputeUpdate methods that are called at each pixel as a constant. Reimplemented in itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, itk::GradientNDAnisotropicDiffusionFunction< TImage >, itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >. Definition at line 115 of file itkFiniteDifferenceFunction.h.

itk::FiniteDifferenceFunction< TImage >::itkStaticConstMacro (  ImageDimension  , unsigned  int, ImageType::ImageDimension  )  [inherited]

Save image dimension.

template<class TImage> itk::CurvatureFlowFunction< TImage >::itkStaticConstMacro (  ImageDimension  , unsigned  int, Superclass::ImageDimension  )

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

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

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

void itk::FiniteDifferenceFunction< TImage >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, inherited]

Reimplemented in itk::AnisotropicDiffusionFunction< TImage >, itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, itk::GradientNDAnisotropicDiffusionFunction< TImage >, itk::ScalarAnisotropicDiffusionFunction< TImage >, itk::VectorAnisotropicDiffusionFunction< TImage >, and itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::LightObject::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented in itk::Object.

template<class TImage> virtual void itk::CurvatureFlowFunction< TImage >::ReleaseGlobalDataPointer (  void *  GlobalData  )  const [inline, virtual]

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 99 of file itkCurvatureFlowFunction.h.

void itk::FiniteDifferenceFunction< TImage >::SetRadius (  const RadiusType &  r  )  [inline, inherited]

Sets the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations. Definition at line 137 of file itkFiniteDifferenceFunction.h.

virtual void itk::LightObject::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count on this object. This is a dangerous method, use it with care. Reimplemented in itk::Object.

Set the ScaleCoefficients for the difference* operators The defaults a These can be set to take the image* spacing into account* void itk::FiniteDifferenceFunction< TImage >::SetScaleCoefficients (  PixelRealType  vals[ImageDimension]  )  [inline, inherited]

Definition at line 148 of file itkFiniteDifferenceFunction.h.

template<class TImage> void itk::CurvatureFlowFunction< TImage >::SetTimeStep (  const TimeStepType &  t  )  [inline]

Set the time step parameter Definition at line 103 of file itkCurvatureFlowFunction.h.

virtual void itk::LightObject::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented in itk::Object.

---

Member Data Documentation

RadiusType itk::FiniteDifferenceFunction< TImage >::m_Radius [protected, inherited]

Definition at line 194 of file itkFiniteDifferenceFunction.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

PixelRealType itk::FiniteDifferenceFunction< TImage >::m_ScaleCoefficients[ImageDimension] [protected, inherited]

Definition at line 195 of file itkFiniteDifferenceFunction.h.

Methods invoked by virtual Print () to print information about the object * including superclasses. Typically not called by the user (use Print() * instead) but used in the hierarchical print process to combine the * output of several classes. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

template<class TImage> 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 itk::CurvatureFlowFunction< TImage >::step

Definition at line 84 of file itkCurvatureFlowFunction.h.

---

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

• itkCurvatureFlowFunction.h

---