itk::NormalVectorFunctionBase< TSparseImageType > Class Template Reference

#include <itkNormalVectorFunctionBase.h>

Inheritance diagram for itk::NormalVectorFunctionBase< TSparseImageType >:

[legend]

Collaboration diagram for itk::NormalVectorFunctionBase< TSparseImageType >:

[legend]

List of all members.

Detailed Description

template<class TSparseImageType>
class itk::NormalVectorFunctionBase< TSparseImageType >

This class defines the common functionality for Sparse Image neighborhoods of unit vectors.

: This class is derived from the FiniteDifferenceSparseImageFunction class and adds the functionality needed to process unit normal vector neighborhoods.

: This class is the parent class of the NormalVectorDiffusionFunction class which defines all the necessary functionality for performing diffusion operations on unit vectors stored in sparse images. Other (non-diffusion) filters (such as median filtering) on unit vectors can also be derived from this base class.

PARAMETERS: This function class has a time step parameter which is returned by the ComputeGloablTimeStep method. Unlike other finite difference function classes, this class does not use the maximum change magnitude to compute the time step, it returns this predetermined time step.

Definition at line 50 of file itkNormalVectorFunctionBase.h.


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef ZeroFluxNeumannBoundaryCondition < ImageType >	DefaultBoundaryConditionType
typedef Superclass::FloatOffsetType	FloatOffsetType
typedef TSparseImageType	ImageType
typedef Superclass::IndexType	IndexType
typedef Vector< PixelRealType, itkGetStaticConstMacro(ImageDimension)>	NeighborhoodScalesType
typedef Superclass::NeighborhoodType	NeighborhoodType
typedef NodeType::NodeDataType	NodeDataType
typedef SparseImageType::NodeType	NodeType
typedef NodeType::NodeValueType	NodeValueType
typedef NodeType::NodeDataType	NormalVectorType
typedef double	PixelRealType
typedef Superclass::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef Superclass::RadiusType	RadiusType
typedef NormalVectorFunctionBase	Self
typedef Superclass::SparseImageType	SparseImageType
typedef FiniteDifferenceSparseImageFunction < TSparseImageType >	Superclass
typedef Superclass::TimeStepType	TimeStepType
Public Member Functions
virtual TimeStepType	ComputeGlobalTimeStep (void *) const
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 const char *	GetNameOfClass () const
const RadiusType &	GetRadius () const
virtual int	GetReferenceCount () const
TimeStepType	GetTimeStep () const
virtual void	InitializeIteration ()
	itkStaticConstMacro (ImageDimension, unsigned int, ImageType::ImageDimension)
	itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
virtual void	PrecomputeSparseUpdate (NeighborhoodType &) const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	SetRadius (const RadiusType &r)
virtual void	SetReferenceCount (int)
void	SetTimeStep (const TimeStepType &ts)
virtual void	UnRegister () const

virtual void *	GetGlobalDataPointer () const
virtual void	ReleaseGlobalDataPointer (void *) const

void	SetScaleCoefficients (PixelRealType vals[ImageDimension])
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
	NormalVectorFunctionBase ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	~NormalVectorFunctionBase ()

virtual void	PrintHeader (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]

Member Typedef Documentation

template<class TSparseImageType>

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

Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 58 of file itkNormalVectorFunctionBase.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::NormalVectorFunctionBase< TSparseImageType >::FloatOffsetType

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

Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 70 of file itkNormalVectorFunctionBase.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 Superclass::IndexType itk::NormalVectorFunctionBase< TSparseImageType >::IndexType

The index type for the sparse image.

Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 71 of file itkNormalVectorFunctionBase.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::NormalVectorFunctionBase< 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::FiniteDifferenceSparseImageFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 69 of file itkNormalVectorFunctionBase.h.

template<class TSparseImageType>

typedef NodeType::NodeDataType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::NodeDataType [inherited]

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::NormalVectorFunctionBase< TSparseImageType >::NodeType

The node type for the sparse image.

Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 75 of file itkNormalVectorFunctionBase.h.

template<class TSparseImageType>

typedef NodeType::NodeValueType itk::NormalVectorFunctionBase< TSparseImageType >::NodeValueType

The basic floating point type for the variables.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 78 of file itkNormalVectorFunctionBase.h.

template<class TSparseImageType>

typedef NodeType::NodeDataType itk::NormalVectorFunctionBase< TSparseImageType >::NormalVectorType

The vector type for the normals.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 81 of file itkNormalVectorFunctionBase.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 [inherited]

Typedefs from the superclass.

Reimplemented from itk::FiniteDifferenceFunction< TSparseImageType >.

Definition at line 63 of file itkFiniteDifferenceSparseImageFunction.h.

template<class TSparseImageType>

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

Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 57 of file itkNormalVectorFunctionBase.h.

template<class TSparseImageType>

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

Neighborhood radius type

Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 68 of file itkNormalVectorFunctionBase.h.

template<class TSparseImageType>

typedef NormalVectorFunctionBase itk::NormalVectorFunctionBase< TSparseImageType >::Self

Standard class typedef.

Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 55 of file itkNormalVectorFunctionBase.h.

template<class TSparseImageType>

typedef Superclass::SparseImageType itk::NormalVectorFunctionBase< TSparseImageType >::SparseImageType

Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 72 of file itkNormalVectorFunctionBase.h.

template<class TSparseImageType>

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

Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 56 of file itkNormalVectorFunctionBase.h.

template<class TSparseImageType>

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

Typedefs from the superclass.

Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

Definition at line 67 of file itkNormalVectorFunctionBase.h.

Constructor & Destructor Documentation

template<class TSparseImageType>

itk::NormalVectorFunctionBase< TSparseImageType >::NormalVectorFunctionBase ( ) [protected]

template<class TSparseImageType>

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

Definition at line 102 of file itkNormalVectorFunctionBase.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 TSparseImageType>

virtual TimeStepType itk::NormalVectorFunctionBase< TSparseImageType >::ComputeGlobalTimeStep ( void * ) const [inline, virtual]

For the global time step, we return the time step parameter.

Implements itk::FiniteDifferenceFunction< TSparseImageType >.

Definition at line 89 of file itkNormalVectorFunctionBase.h.

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, inherited]`

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, inherited]`

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.

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

virtual void* itk::NormalVectorFunctionBase< TSparseImageType >::GetGlobalDataPointer ( ) const [inline, virtual]

Globaldata methods are not needed in this class.

Implements itk::FiniteDifferenceFunction< TSparseImageType >.

Definition at line 84 of file itkNormalVectorFunctionBase.h.

template<class TSparseImageType>

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

Run-time type information (and related methods)

Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

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

template<class TSparseImageType>

TimeStepType itk::NormalVectorFunctionBase< TSparseImageType >::GetTimeStep ( ) const [inline]

Returns the time step.

Definition at line 97 of file itkNormalVectorFunctionBase.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.

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

Save image dimension.

template<class TSparseImageType>

itk::NormalVectorFunctionBase< TSparseImageType >::itkStaticConstMacro	(	ImageDimension	,
		unsigned	int,
		Superclass::ImageDimension
	)

Image dimension derived from the superclass.

Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

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

Method for creation through the object factory.

template<class TSparseImageType>

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

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< itk::ProcessObject >::Print(), and itk::SmartPointer< itk::MutualInformationImageToImageMetric >::Print().

virtual void itk::LightObject::PrintHeader	(	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.

template<class TSparseImageType>

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

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >.

virtual void itk::LightObject::PrintTrailer	(	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.

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

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

Reimplemented in itk::Object.

template<class TSparseImageType>

virtual void itk::NormalVectorFunctionBase< TSparseImageType >::ReleaseGlobalDataPointer ( void * ) const [inline, virtual]

Globaldata methods are not needed in this class.

Implements itk::FiniteDifferenceFunction< TSparseImageType >.

Definition at line 85 of file itkNormalVectorFunctionBase.h.

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.

template<class TSparseImageType>

void itk::NormalVectorFunctionBase< TSparseImageType >::SetTimeStep ( const TimeStepType & ts ) [inline]

Sets the time step.

Definition at line 93 of file itkNormalVectorFunctionBase.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< 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:

itkNormalVectorFunctionBase.h

itk::NormalVectorFunctionBase< TSparseImageType > Class Template Reference

Detailed Description

template<class TSparseImageType> class itk::NormalVectorFunctionBase< TSparseImageType >

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TSparseImageType>
class itk::NormalVectorFunctionBase< TSparseImageType >