Main Page Groups Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Concepts

itk::ScalarAnisotropicDiffusionFunction< TImage > Class Template Reference
[Finite Difference Functions, Image Enhancement Filters]

#include <itkScalarAnisotropicDiffusionFunction.h>

Inheritance diagram for itk::ScalarAnisotropicDiffusionFunction< TImage >:

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

[legend]List of all members.

Detailed Description

template<class TImage>
class itk::ScalarAnisotropicDiffusionFunction< TImage >

This class forms the base for any anisotropic diffusion function that operates on scalar data (see itkAnisotropicDiffusionFunction). It provides some common functionality used in classes like CurvatureNDAnisotropicDiffusionFunction and GradientNDAnisotropicDiffusionFunction.

See also:

AnisotropicDiffusionFunction

AnisotropicDiffusionImageFilter

VectorAnisotropicDiffusionFunction

Definition at line 39 of file itkScalarAnisotropicDiffusionFunction.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 ScalarAnisotropicDiffusionFunction Self

typedef AnisotropicDiffusionFunction<
TImage > Superclass

typedef Superclass::TimeStepType TimeStepType

Public Member Functions

virtual void CalculateAverageGradientMagnitudeSquared (ImageType *)=0

virtual void CalculateAverageGradientMagnitudeSquared (TImage *)

virtual TimeStepType ComputeGlobalTimeStep (void *) const

virtual PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))=0

virtual Pointer CreateAnother () const

virtual void Delete ()

Set Get the average gradient
magnitude squared *const double & GetAverageGradientMagnitudeSquared () const

const double & GetConductanceParameter () const

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 *) const

void SetAverageGradientMagnitudeSquared (const double &c)

Set Get the conductance parameter
The conductance parameter
*void SetConductanceParameter (const double &c)

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])

Set Get the time step For
this class of anisotropic
diffusion filters the time
step is supplied by the user
and remains fixed for all
updates *void SetTimeStep (const TimeStepType &t)

virtual void UnRegister () const

Static Public Member Functions

static void BreakOnError ()

static Pointer New ()

Protected Member Functions

FiniteDifferenceFunction ()

void PrintSelf (std::ostream &os, Indent indent) const

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

ScalarAnisotropicDiffusionFunction ()

~ScalarAnisotropicDiffusionFunction ()

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::ScalarAnisotropicDiffusionFunction< TImage >::ConstPointer

Reimplemented from itk::AnisotropicDiffusionFunction< TImage >.
Reimplemented in itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::GradientNDAnisotropicDiffusionFunction< TImage >.
Definition at line 48 of file itkScalarAnisotropicDiffusionFunction.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::AnisotropicDiffusionFunction< TImage >::FloatOffsetType [inherited]

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::CurvatureNDAnisotropicDiffusionFunction< TImage >, itk::GradientNDAnisotropicDiffusionFunction< TImage >, itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >.
Definition at line 155 of file itkAnisotropicDiffusionFunction.h.

template<class TImage>

typedef Superclass::ImageType itk::ScalarAnisotropicDiffusionFunction< TImage >::ImageType

Inherit some parameters from the superclass type.
Reimplemented from itk::AnisotropicDiffusionFunction< TImage >.
Reimplemented in itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::GradientNDAnisotropicDiffusionFunction< TImage >.
Definition at line 55 of file itkScalarAnisotropicDiffusionFunction.h.

template<class TImage>

typedef Superclass::NeighborhoodType itk::ScalarAnisotropicDiffusionFunction< 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::AnisotropicDiffusionFunction< TImage >.
Reimplemented in itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::GradientNDAnisotropicDiffusionFunction< TImage >.
Definition at line 58 of file itkScalarAnisotropicDiffusionFunction.h.

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

Definition at line 82 of file itkFiniteDifferenceFunction.h.

template<class TImage>

typedef Superclass::PixelType itk::ScalarAnisotropicDiffusionFunction< TImage >::PixelType

Reimplemented from itk::AnisotropicDiffusionFunction< TImage >.
Reimplemented in itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::GradientNDAnisotropicDiffusionFunction< TImage >.
Definition at line 56 of file itkScalarAnisotropicDiffusionFunction.h.

template<class TImage>

typedef SmartPointer<Self> itk::ScalarAnisotropicDiffusionFunction< TImage >::Pointer

Reimplemented from itk::AnisotropicDiffusionFunction< TImage >.
Reimplemented in itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::GradientNDAnisotropicDiffusionFunction< TImage >.
Definition at line 47 of file itkScalarAnisotropicDiffusionFunction.h.

template<class TImage>

typedef Superclass::RadiusType itk::ScalarAnisotropicDiffusionFunction< TImage >::RadiusType

Neighborhood radius type
Reimplemented from itk::AnisotropicDiffusionFunction< TImage >.
Reimplemented in itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::GradientNDAnisotropicDiffusionFunction< TImage >.
Definition at line 57 of file itkScalarAnisotropicDiffusionFunction.h.

template<class TImage>

typedef ScalarAnisotropicDiffusionFunction itk::ScalarAnisotropicDiffusionFunction< TImage >::Self

Standard class typedefs.
Reimplemented from itk::AnisotropicDiffusionFunction< TImage >.
Reimplemented in itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::GradientNDAnisotropicDiffusionFunction< TImage >.
Definition at line 45 of file itkScalarAnisotropicDiffusionFunction.h.

template<class TImage>

typedef AnisotropicDiffusionFunction<TImage> itk::ScalarAnisotropicDiffusionFunction< TImage >::Superclass

Reimplemented from itk::AnisotropicDiffusionFunction< TImage >.
Reimplemented in itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::GradientNDAnisotropicDiffusionFunction< TImage >.
Definition at line 46 of file itkScalarAnisotropicDiffusionFunction.h.

template<class TImage>

typedef Superclass::TimeStepType itk::ScalarAnisotropicDiffusionFunction< TImage >::TimeStepType

Define the TimeStepType to always be double.
Reimplemented from itk::AnisotropicDiffusionFunction< TImage >.
Reimplemented in itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::GradientNDAnisotropicDiffusionFunction< TImage >.
Definition at line 59 of file itkScalarAnisotropicDiffusionFunction.h.

Constructor & Destructor Documentation

template<class TImage>

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

Definition at line 68 of file itkScalarAnisotropicDiffusionFunction.h.

template<class TImage>

itk::ScalarAnisotropicDiffusionFunction< TImage >::~ScalarAnisotropicDiffusionFunction ( ) [inline, protected]

Definition at line 69 of file itkScalarAnisotropicDiffusionFunction.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 void itk::AnisotropicDiffusionFunction< TImage >::CalculateAverageGradientMagnitudeSquared ( ImageType * ) [pure virtual, inherited]

This method is called before each iteration. It calculates a scalar value that is the average of the gradient magnitude squared at each pixel in the output image (intermediate solution). The average gradient magnitude value is typically used in the anisotropic diffusion equations to calibrate the conductance term.

template<class TImage>

virtual void itk::ScalarAnisotropicDiffusionFunction< TImage >::CalculateAverageGradientMagnitudeSquared ( TImage * ) [virtual]

template<class TImage>

virtual TimeStepType itk::AnisotropicDiffusionFunction< TImage >::ComputeGlobalTimeStep ( void * ) const [inline, virtual, inherited]

Returns the time step supplied by the user. We don't need to use the global data supplied since we are returning a fixed value.
Implements itk::FiniteDifferenceFunction< TImage >.
Definition at line 192 of file itkAnisotropicDiffusionFunction.h.

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

Implemented in itk::BinaryMinMaxCurvatureFlowFunction< TImage >, itk::CurvatureFlowFunction< TImage >, itk::MinMaxCurvatureFlowFunction< TImage >, itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, itk::GradientNDAnisotropicDiffusionFunction< TImage >, itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::VectorGradientNDAnisotropicDiffusionFunction< 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>

Set Get the average gradient magnitude squared* const double& itk::AnisotropicDiffusionFunction< TImage >::GetAverageGradientMagnitudeSquared ( ) const [inline, inherited]

Definition at line 184 of file itkAnisotropicDiffusionFunction.h.

template<class TImage>

const double& itk::AnisotropicDiffusionFunction< TImage >::GetConductanceParameter ( ) const [inline, inherited]

Definition at line 179 of file itkAnisotropicDiffusionFunction.h.

template<class TImage>

virtual void* itk::AnisotropicDiffusionFunction< TImage >::GetGlobalDataPointer ( ) const [inline, virtual, inherited]

The anisotropic diffusion classes don't use this particular parameter so it's safe to return a null value.
Implements itk::FiniteDifferenceFunction< TImage >.
Definition at line 197 of file itkAnisotropicDiffusionFunction.h.

template<class TImage>

virtual const char* itk::ScalarAnisotropicDiffusionFunction< TImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).
Reimplemented from itk::AnisotropicDiffusionFunction< TImage >.
Reimplemented in itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::GradientNDAnisotropicDiffusionFunction< 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::AnisotropicDiffusionFunction< TImage >::GetTimeStep ( ) const [inline, inherited]

Definition at line 172 of file itkAnisotropicDiffusionFunction.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::ScalarAnisotropicDiffusionFunction< TImage >::itkStaticConstMacro ( ImageDimension ,

unsigned int,

Superclass::ImageDimension

)

Inherit some parameters from the superclass type.
Reimplemented from itk::AnisotropicDiffusionFunction< TImage >.
Reimplemented in itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::GradientNDAnisotropicDiffusionFunction< TImage >.

void itk::LightObject::Print ( std::ostream & os,

Indent indent = 0

) const [inherited]

Cause the object to print itself out.

template<class TImage>

void itk::ScalarAnisotropicDiffusionFunction< TImage >::PrintSelf ( std::ostream & os,

Indent indent

) const [inline, protected]

Reimplemented from itk::AnisotropicDiffusionFunction< TImage >.
Reimplemented in itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::GradientNDAnisotropicDiffusionFunction< TImage >.
Definition at line 70 of file itkScalarAnisotropicDiffusionFunction.h.
References HardConnectedComponentImageFilter::PrintSelf().

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::AnisotropicDiffusionFunction< TImage >::ReleaseGlobalDataPointer ( void * ) const [inline, virtual, inherited]

Does nothing. No global data is used in this class of equations.
Implements itk::FiniteDifferenceFunction< TImage >.
Definition at line 201 of file itkAnisotropicDiffusionFunction.h.

template<class TImage>

void itk::AnisotropicDiffusionFunction< TImage >::SetAverageGradientMagnitudeSquared ( const double & c ) [inline, inherited]

Definition at line 186 of file itkAnisotropicDiffusionFunction.h.

template<class TImage>

Set Get the conductance parameter The conductance parameter* void itk::AnisotropicDiffusionFunction< TImage >::SetConductanceParameter ( const double & c ) [inline, inherited]

Definition at line 177 of file itkAnisotropicDiffusionFunction.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>

Set Get the time step For this class of anisotropic diffusion filters the time step is supplied by the user and remains fixed for all updates* void itk::AnisotropicDiffusionFunction< TImage >::SetTimeStep ( const TimeStepType & t ) [inline, inherited]

Definition at line 170 of file itkAnisotropicDiffusionFunction.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]

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

itkScalarAnisotropicDiffusionFunction.h

Generated at Sun Jul 9 21:19:41 2006 for ITK by


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 ScalarAnisotropicDiffusionFunction	Self
typedef AnisotropicDiffusionFunction< TImage >	Superclass
typedef Superclass::TimeStepType	TimeStepType
Public Member Functions
virtual void	CalculateAverageGradientMagnitudeSquared (ImageType *)=0
virtual void	CalculateAverageGradientMagnitudeSquared (TImage *)
virtual TimeStepType	ComputeGlobalTimeStep (void *) const
virtual PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))=0
virtual Pointer	CreateAnother () const
virtual void	Delete ()
Set Get the average gradient magnitude squared *const double &	GetAverageGradientMagnitudeSquared () const
const double &	GetConductanceParameter () const
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 *) const
void	SetAverageGradientMagnitudeSquared (const double &c)
Set Get the conductance parameter The conductance parameter *void	SetConductanceParameter (const double &c)
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])
Set Get the time step For this class of anisotropic diffusion filters the time step is supplied by the user and remains fixed for all updates *void	SetTimeStep (const TimeStepType &t)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()
Protected Member Functions
	FiniteDifferenceFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	ScalarAnisotropicDiffusionFunction ()
	~ScalarAnisotropicDiffusionFunction ()
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

itk::ScalarAnisotropicDiffusionFunction< TImage > Class Template Reference [Finite Difference Functions, Image Enhancement Filters]

Detailed Description

template<class TImage> class itk::ScalarAnisotropicDiffusionFunction< TImage >

Public Types

Public Member Functions

Static Public Member Functions