ITK: itk::CurvatureFlowFunction< TImage > Class Template Reference

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

virtual PixelType itk::FiniteDifferenceFunction< TImage >::ComputeUpdate	(	const NeighborhoodType &	neighborhood,
		void *	globalData,
		const FloatOffsetType &	offset = `FloatOffsetType(0.0)`
	)			`[pure virtual, inherited]`

This method is called by a finite difference solver image filter at each pixel that does not lie on a data set boundary. The width of the data set boundary is defined by the width of the neighborhood being evaluated.

The neighborhood argument is the neighborhood data. The globalData argument is a pointer to a data structure that holds values that need to be persistent across calls to this function, but cannot be stored in the function object itself for thread-safety reasons. Examples are values needed to compute the time-step for an iteration of the solver.

See also:: InitializeIteration
ComputeGlobalTimeStep

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.

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.

template<class TImage>

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

Referenced by itk::WeakPointer< itk::ProcessObject >::Print().

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

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

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.

Reimplemented from itk::LightObject.

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

void itk::FiniteDifferenceFunction< TImage >::SetScaleCoefficients ( PixelRealType vals[ImageDimension] ) [inline, inherited]

Set the ScaleCoefficients for the difference operators. The defaults a 1.0. These can be set to take the image spacing into account.

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

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

Definition at line 195 of file itkFiniteDifferenceFunction.h.

volatile 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 196 of file itkFiniteDifferenceFunction.h.

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

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation


	CurvatureFlowFunction ()
	~CurvatureFlowFunction ()
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))=0
virtual PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))
virtual Pointer	CreateAnother () const
virtual void	Delete ()
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)
void	SetScaleCoefficients (PixelRealType vals[ImageDimension])
void	SetTimeStep (const TimeStepType &t)
virtual void	UnRegister () const

virtual void *	GetGlobalDataPointer () const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()
Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
RadiusType	m_Radius
volatile int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
PixelRealType	m_ScaleCoefficients [ImageDimension]

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

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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

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