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

#include <itkCurvatureFlowFunction.h>

Inheritance diagram for itk::CurvatureFlowFunction< TImage >:

Collaboration diagram for itk::CurvatureFlowFunction< TImage >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef ZeroFluxNeumannBoundaryCondition < ImageType >	DefaultBoundaryConditionType
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 Member Functions
virtual TimeStepType	ComputeGlobalTimeStep (void *GlobalData) const
const NeighborhoodScalesType	ComputeNeighborhoodScales () const
virtual PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	Delete ()
virtual void *	GetGlobalDataPointer () const
virtual const char *	GetNameOfClass () const
const RadiusType &	GetRadius () const
virtual int	GetReferenceCount () const
const TimeStepType &	GetTimeStep () const
virtual void	InitializeIteration ()
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)
void	SetScaleCoefficients (PixelRealType vals[ImageDimension])
void	SetTimeStep (const TimeStepType &t)
virtual void	UnRegister () const

Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = Superclass::ImageDimension

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	CurvatureFlowFunction ()
	~CurvatureFlowFunction ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes
RadiusType	m_Radius
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
PixelRealType	m_ScaleCoefficients [ImageDimension]

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

Private Attributes
TimeStepType	m_TimeStep

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.

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

Definition at line 66 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.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.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 65 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 64 of file itkCurvatureFlowFunction.h.

template<class TImage>

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

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Definition at line 63 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 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::MinMaxCurvatureFlowFunction< TImage >, and itk::BinaryMinMaxCurvatureFlowFunction< 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 67 of file itkCurvatureFlowFunction.h.

Constructor & Destructor Documentation

template<class TImage >

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

protected

A global data type for this class of equations. Used to store values that are needed in calculating the time step.

Constructor

Definition at line 30 of file itkCurvatureFlowFunction.txx.

template<class TImage>

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

inlineprotected

Definition at line 136 of file itkCurvatureFlowFunction.h.

template<class TImage>

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

private

Member Function Documentation

void itk::LightObject::BreakOnError ( )

staticinherited

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

Definition at line 149 of file itkLightObject.cxx.

template<class TImage >

CurvatureFlowFunction< TImage >::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.

Compute the global time step

Implements itk::FiniteDifferenceFunction< TImage >.

Definition at line 53 of file itkCurvatureFlowFunction.txx.

const NeighborhoodScalesType itk::FiniteDifferenceFunction< TImage >::ComputeNeighborhoodScales ( ) const

inherited

Compute the scales that weight the neighborhood during difference operations to properly account for spacing and neighborhood radius

template<class TImage >

CurvatureFlowFunction< TImage >::PixelType itk::CurvatureFlowFunction< TImage >::ComputeUpdate	(	const NeighborhoodType &	it,
		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.

Update the solution at pixels which lies on the data boundary.

Implements itk::FiniteDifferenceFunction< TImage >.

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

Definition at line 84 of file itkCurvatureFlowFunction.txx.

References itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel(), itk::Neighborhood< TPixel, VDimension, TAllocator >::GetStride(), and itk::Neighborhood< TPixel, VDimension, TAllocator >::Size().

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

void itk::LightObject::Delete ( )

virtualinherited

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.

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

Definition at line 88 of file itkLightObject.cxx.

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

inlineinherited

Returns the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations.

Definition at line 145 of file itkFiniteDifferenceFunction.h.

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

template<class TImage>

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

inline

Get the time step parameter

Definition at line 108 of file itkCurvatureFlowFunction.h.

virtual void itk::FiniteDifferenceFunction< TImage >::InitializeIteration ( )

inlinevirtualinherited

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::VectorGradientNDAnisotropicDiffusionFunction< TImage >, and itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >.

Definition at line 117 of file itkFiniteDifferenceFunction.h.

Referenced by itk::AnisotropicDiffusionImageFilter< TInputImage, TOutputImage >::InitializeIteration().

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

Reimplemented in itk::MinMaxCurvatureFlowFunction< TImage >.

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

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

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

protectedvirtualinherited

Methods invoked by 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.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::LightObject.

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

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::LightObject::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented in itk::ExceptionObject::ReferenceCountedExceptionData, and itk::Object.

Definition at line 160 of file itkLightObject.cxx.

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

void itk::FiniteDifferenceFunction< TImage >::SetRadius ( const RadiusType & r )