itk::FiniteDifferenceSparseImageFunction< TSparseImageType > Class Template Reference

This is the base class for function classes that can be used with filters derived from FiniteDifferenceSparseImageFilter. More...

#include <itkFiniteDifferenceSparseImageFunction.h>

Inheritance diagram for itk::FiniteDifferenceSparseImageFunction< TSparseImageType >:

[legend]

Collaboration diagram for itk::FiniteDifferenceSparseImageFunction< TSparseImageType >:

[legend]

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef ZeroFluxNeumannBoundaryCondition < ImageType >	DefaultBoundaryConditionType
typedef Superclass::FloatOffsetType	FloatOffsetType
typedef TSparseImageType	ImageType
typedef SparseImageType::IndexType	IndexType
typedef Vector< PixelRealType, itkGetStaticConstMacro(ImageDimension)>	NeighborhoodScalesType
typedef Superclass::NeighborhoodType	NeighborhoodType
typedef NodeType::NodeDataType	NodeDataType
typedef SparseImageType::NodeType	NodeType
typedef double	PixelRealType
typedef Superclass::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef Superclass::RadiusType	RadiusType
typedef FiniteDifferenceSparseImageFunction	Self
typedef Superclass::ImageType	SparseImageType
typedef FiniteDifferenceFunction < TSparseImageType >	Superclass
typedef Superclass::TimeStepType	TimeStepType
Public Member Functions
virtual TimeStepType	ComputeGlobalTimeStep (void *GlobalData) const =0
const NeighborhoodScalesType	ComputeNeighborhoodScales () const
virtual NodeDataType	ComputeSparseUpdate (NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) const =0
virtual PixelType	ComputeUpdate (const NeighborhoodType &, void *, const FloatOffsetType &)
virtual Pointer	CreateAnother () const
virtual void	Delete ()
virtual void *	GetGlobalDataPointer () const =0
virtual const char *	GetNameOfClass () const
const RadiusType &	GetRadius () const
virtual int	GetReferenceCount () const
virtual void	InitializeIteration ()
virtual void	PrecomputeSparseUpdate (NeighborhoodType &) const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
virtual void	ReleaseGlobalDataPointer (void *GlobalData) const =0
void	SetRadius (const RadiusType &r)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const


void	SetScaleCoefficients (PixelRealType vals[ImageDimension])
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()
Static Public Attributes
static const unsigned int	ImageDimension = Superclass::ImageDimension
Protected Member Functions
	FiniteDifferenceSparseImageFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const
	~FiniteDifferenceSparseImageFunction ()
Protected Attributes
RadiusType	m_Radius
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
PixelRealType	m_ScaleCoefficients [ImageDimension]

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
typedef int	InternalReferenceCountType

Detailed Description

template<class TSparseImageType>
class itk::FiniteDifferenceSparseImageFunction< TSparseImageType >

This is the base class for function classes that can be used with filters derived from FiniteDifferenceSparseImageFilter.

This class is derived from FiniteDifferenceFunction. It is designed to: work with neighborhoods of pointers instead of actual data. Towards this purpose ComputeUpdate method is no longer used and is replaced by the ComputeSparseUpdate method. ComputeSparseUpdate assumes that the pointers are associated with structures that have the member variable m_Data. The pointers would normally originate from a SparseImage object.

The PrecomputeSparseUpdate method can be defined to do a first pass of: computations which then can be used by ComputeSparseUpdate. If PrecomputeSparseUpdate is used then the m_PrecomputeFlag should be set in the FiniteDifferenceSparseImageFilter class. The precomputation step can be used to speed up computation by avoiding repetitions. See the NormalVectorDiffusionFunction for an example.

Definition at line 45 of file itkFiniteDifferenceSparseImageFunction.h.

Member Typedef Documentation

template<class TSparseImageType >

typedef SmartPointer<const Self> itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::ConstPointer

Reimplemented from itk::FiniteDifferenceFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, and itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 54 of file itkFiniteDifferenceSparseImageFunction.h.

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

The default boundary condition for finite difference functions that is used unless overridden in the Evaluate() method.

Definition at line 92 of file itkFiniteDifferenceFunction.h.

template<class TSparseImageType >

typedef Superclass::FloatOffsetType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::FloatOffsetType

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

Reimplemented from itk::FiniteDifferenceFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, and itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 67 of file itkFiniteDifferenceSparseImageFunction.h.

typedef TSparseImageType itk::FiniteDifferenceFunction< TSparseImageType >::ImageType [inherited]

Extract some parameters from the image type

Definition at line 76 of file itkFiniteDifferenceFunction.h.

template<class TSparseImageType >

typedef SparseImageType::IndexType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::IndexType

The index type for the sparse image.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, and itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 71 of file itkFiniteDifferenceSparseImageFunction.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

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

Definition at line 139 of file itkLightObject.h.

typedef Vector<PixelRealType,itkGetStaticConstMacro(ImageDimension)> itk::FiniteDifferenceFunction< TSparseImageType >::NeighborhoodScalesType [inherited]

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

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 103 of file itkFiniteDifferenceFunction.h.

template<class TSparseImageType >

typedef Superclass::NeighborhoodType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::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< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, and itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 66 of file itkFiniteDifferenceSparseImageFunction.h.

template<class TSparseImageType >

typedef NodeType::NodeDataType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::NodeDataType

The type for the variables of NodeType. Scalar or vector.

Definition at line 77 of file itkFiniteDifferenceSparseImageFunction.h.

template<class TSparseImageType >

typedef SparseImageType::NodeType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::NodeType

The actual type of nodes stored the sparse image.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, and itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 74 of file itkFiniteDifferenceSparseImageFunction.h.

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

Definition at line 81 of file itkFiniteDifferenceFunction.h.

template<class TSparseImageType >

typedef Superclass::PixelType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::PixelType

Typedefs from the superclass.

Reimplemented from itk::FiniteDifferenceFunction< TSparseImageType >.

Definition at line 63 of file itkFiniteDifferenceSparseImageFunction.h.

template<class TSparseImageType >

typedef SmartPointer<Self> itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::Pointer

Reimplemented from itk::FiniteDifferenceFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, and itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 53 of file itkFiniteDifferenceSparseImageFunction.h.

template<class TSparseImageType >

typedef Superclass::RadiusType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::RadiusType

Neighborhood radius type

Reimplemented from itk::FiniteDifferenceFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, and itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 65 of file itkFiniteDifferenceSparseImageFunction.h.

template<class TSparseImageType >

typedef FiniteDifferenceSparseImageFunction itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::Self

Standard class typedef.

Reimplemented from itk::FiniteDifferenceFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, and itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 51 of file itkFiniteDifferenceSparseImageFunction.h.

template<class TSparseImageType >

typedef Superclass::ImageType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::SparseImageType

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, and itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 68 of file itkFiniteDifferenceSparseImageFunction.h.

template<class TSparseImageType >

typedef FiniteDifferenceFunction<TSparseImageType> itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::Superclass

Reimplemented from itk::FiniteDifferenceFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, and itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 52 of file itkFiniteDifferenceSparseImageFunction.h.

template<class TSparseImageType >

typedef Superclass::TimeStepType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::TimeStepType

Define the TimeStepType to always be double.

Reimplemented from itk::FiniteDifferenceFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, and itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 64 of file itkFiniteDifferenceSparseImageFunction.h.

Constructor & Destructor Documentation

template<class TSparseImageType >

itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::FiniteDifferenceSparseImageFunction ( ) [inline, protected]

Definition at line 110 of file itkFiniteDifferenceSparseImageFunction.h.

template<class TSparseImageType >

itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::~FiniteDifferenceSparseImageFunction ( ) [inline, protected]

Definition at line 111 of file itkFiniteDifferenceSparseImageFunction.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.

virtual TimeStepType itk::FiniteDifferenceFunction< TSparseImageType >::ComputeGlobalTimeStep ( void * GlobalData ) const [pure virtual, inherited]

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.

Implemented in itk::NormalVectorFunctionBase< TSparseImageType >.

const NeighborhoodScalesType itk::FiniteDifferenceFunction< TSparseImageType >::ComputeNeighborhoodScales ( ) const [inherited]

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

template<class TSparseImageType >

virtual NodeDataType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::ComputeSparseUpdate	(	NeighborhoodType &	neighborhood,
		void *	globalData,
		const FloatOffsetType &	offset = `FloatOffsetType(0.0)`
	)			const `[pure virtual]`

The update called from the FiniteDifferenceSparseImageFilter. This function replaces the ComputeUpdate function.

Implemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

template<class TSparseImageType >

virtual PixelType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::ComputeUpdate	(	const NeighborhoodType &	,
		void *	,
		const FloatOffsetType &
	)			`[inline, virtual]`

This function is not called from the FiniteDifferenceSparseImageFilter class because we need to work with neighborhoods of pointers to data variables instead of neighborhoods of data directly. This function is replaced by the ComputeSparseUpdate function.

Implements itk::FiniteDifferenceFunction< TSparseImageType >.

Definition at line 83 of file itkFiniteDifferenceSparseImageFunction.h.

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.

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.

virtual void* itk::FiniteDifferenceFunction< TSparseImageType >::GetGlobalDataPointer ( ) const [pure virtual, inherited]

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.

Implemented in itk::NormalVectorFunctionBase< TSparseImageType >.

template<class TSparseImageType >

virtual const char* itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods)

Reimplemented from itk::FiniteDifferenceFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, and itk::NormalVectorFunctionBase< TSparseImageType >.

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

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

Definition at line 146 of file itkFiniteDifferenceFunction.h.

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

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

virtual void itk::FiniteDifferenceFunction< TSparseImageType >::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.

Definition at line 118 of file itkFiniteDifferenceFunction.h.

static Pointer itk::LightObject::New ( ) [static, inherited]

Method for creation through the object factory.

Referenced by itk::RegionBasedLevelSetFunctionSharedData< TInputImage, TFeatureImage, TSingleData >::SetFunctionCount().

template<class TSparseImageType >

virtual void itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::PrecomputeSparseUpdate ( NeighborhoodType & ) const [inline, virtual]

This function provides support for a 2 step update computation that avoids repetitive computation. FiniteDifferenceSparseImageFilter first calls this function for all active pixels in the SparseImage class, then calls ComputeSparseUpdate for the same set of pixels. This is used in NormalVectorDiffusionFunction to calculate flux variables which are then used to compute the updates. Intermediate variables such as the flux in the above examples are stored in the nodes of the SparseImage itself. Therefore, this function will have to know about the NodeType it is dealing with. This function does nothing by default.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 107 of file itkFiniteDifferenceSparseImageFunction.h.

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

Cause the object to print itself out.

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

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

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

template<class TSparseImageType >

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

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::FiniteDifferenceFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, and itk::NormalVectorFunctionBase< TSparseImageType >.

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

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

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

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

Reimplemented in itk::Object.

virtual void itk::FiniteDifferenceFunction< TSparseImageType >::ReleaseGlobalDataPointer ( void * GlobalData ) const [pure virtual, inherited]

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.

Implemented in itk::NormalVectorFunctionBase< TSparseImageType >.

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

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

Definition at line 141 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< TSparseImageType >::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 152 of file itkFiniteDifferenceFunction.h.

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

Decrease the reference count (release by another object).

Reimplemented in itk::Object.

Member Data Documentation

template<class TSparseImageType >

const unsigned int itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::ImageDimension = Superclass::ImageDimension [static]

The image dimension.

Reimplemented from itk::FiniteDifferenceFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, and itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 60 of file itkFiniteDifferenceSparseImageFunction.h.

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

Definition at line 203 of file itkFiniteDifferenceFunction.h.

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

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

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

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

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

Definition at line 204 of file itkFiniteDifferenceFunction.h.

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

itkFiniteDifferenceSparseImageFunction.h

itk::FiniteDifferenceSparseImageFunction< TSparseImageType > Class Template Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

template<class TSparseImageType> class itk::FiniteDifferenceSparseImageFunction< TSparseImageType >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TSparseImageType>
class itk::FiniteDifferenceSparseImageFunction< TSparseImageType >