ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
itk::NormalVectorDiffusionFunction< TSparseImageType > Class Template Reference

#include <itkNormalVectorDiffusionFunction.h>

+ Inheritance diagram for itk::NormalVectorDiffusionFunction< TSparseImageType >:
+ Collaboration diagram for itk::NormalVectorDiffusionFunction< TSparseImageType >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef Superclass::FloatOffsetType FloatOffsetType
typedef Superclass::IndexType IndexType
typedef
Superclass::NeighborhoodScalesType 
NeighborhoodScalesType
typedef
Superclass::NeighborhoodType 
NeighborhoodType
typedef Superclass::NodeType NodeType
typedef Superclass::NodeValueType NodeValueType
typedef
Superclass::NormalVectorType 
NormalVectorType
typedef SmartPointer< SelfPointer
typedef Superclass::RadiusType RadiusType
typedef
NormalVectorDiffusionFunction 
Self
typedef Superclass::SparseImageType SparseImageType
typedef
NormalVectorFunctionBase
< TSparseImageType > 
Superclass
typedef Superclass::TimeStepType TimeStepType
- Public Types inherited from itk::NormalVectorFunctionBase< TSparseImageType >
- Public Types inherited from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >
typedef NodeType::NodeDataType NodeDataType
typedef Superclass::PixelType PixelType
- Public Types inherited from itk::FiniteDifferenceFunction< TSparseImageType >
typedef
ZeroFluxNeumannBoundaryCondition
< ImageType
DefaultBoundaryConditionType
typedef TSparseImageType ImageType
typedef double PixelRealType
- Public Types inherited from itk::LightObject

Public Member Functions

virtual NormalVectorType ComputeSparseUpdate (NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset) const
virtual ::itk::LightObject::Pointer CreateAnother (void) const
NodeValueType GetConductanceParameter () const
NodeValueType GetFluxStopConstant () const
virtual const char * GetNameOfClass () const
int GetNormalProcessType () const
virtual void PrecomputeSparseUpdate (NeighborhoodType &it) const
void SetNormalProcessType (int npt)
void SetConductanceParameter (NodeValueType cp)
- Public Member Functions inherited from itk::NormalVectorFunctionBase< TSparseImageType >
virtual TimeStepType ComputeGlobalTimeStep (void *) const
void SetTimeStep (const TimeStepType &ts)
virtual void * GetGlobalDataPointer () const
virtual void ReleaseGlobalDataPointer (void *) const
TimeStepType GetTimeStep () const
- Public Member Functions inherited from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >
virtual PixelType ComputeUpdate (const NeighborhoodType &, void *, const FloatOffsetType &)
- Public Member Functions inherited from itk::FiniteDifferenceFunction< TSparseImageType >
const NeighborhoodScalesType ComputeNeighborhoodScales () const
const RadiusTypeGetRadius () const
virtual void InitializeIteration ()
void SetRadius (const RadiusType &r)
void SetScaleCoefficients (PixelRealType vals[ImageDimension])
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const
virtual void Register () const
virtual void SetReferenceCount (int)
virtual void UnRegister () const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = Superclass::ImageDimension
- Static Public Attributes inherited from itk::NormalVectorFunctionBase< TSparseImageType >
- Static Public Attributes inherited from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >
- Static Public Attributes inherited from itk::FiniteDifferenceFunction< TSparseImageType >

Protected Member Functions

 NormalVectorDiffusionFunction ()
void PrintSelf (std::ostream &os, Indent indent) const
 ~NormalVectorDiffusionFunction ()
NodeValueType FluxStopFunction (const NodeValueType v) const
 NormalVectorFunctionBase ()
 ~NormalVectorFunctionBase ()
 FiniteDifferenceSparseImageFunction ()
 ~FiniteDifferenceSparseImageFunction ()
- Protected Member Functions inherited from itk::FiniteDifferenceFunction< TSparseImageType >
 FiniteDifferenceFunction ()
 ~FiniteDifferenceFunction ()
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

Private Member Functions

 NormalVectorDiffusionFunction (const Self &)
void operator= (const Self &)

Private Attributes

NodeValueType m_ConductanceParameter
NodeValueType m_FluxStopConstant
int m_NormalProcessType

Detailed Description

template<class TSparseImageType>
class itk::NormalVectorDiffusionFunction< TSparseImageType >

This class defines all the necessary functionality for performing isotropic and anisotropic diffusion operations on vector neighborhoods from a sparse image.

This class implements the actual computations for performing isotropic and anisotropic diffusion operations on a neighborhood of unit length vectors. Moreover, this processing is intrinsic to a manifold as specified by the ManifoldNormal member variables in the nodes of the sparse image.
Since the only difference between isotropic and anisotropic diffusion is the exectution of 1 extra line of code, we have implemented both in this class and made the choice between the two depend on a parameter (see below).
PARAMETERS
The choice between is isotropic/anisotropic diffusion is made by the parameter NormalProcessType. A value of 0 corresponds to isotropic diffusion whereas a value of 1 corresponds to anisotropic diffusion. If anisotropic diffusion is chosen, the parameter ConductanceParameter should be set. This conductance parameter determines the level of feature preservation.
IMPORTANT
This class works on SparseImage neighborhoods. Before using this class please read the documentation for SparseImage. Also the documentation for ImplicitManifoldNormalVectorField class will be helpful in understanding how to use this class as a function object.

Definition at line 60 of file itkNormalVectorDiffusionFunction.h.


Member Typedef Documentation

template<class TSparseImageType >
typedef SmartPointer< const Self > itk::NormalVectorDiffusionFunction< TSparseImageType >::ConstPointer
template<class TSparseImageType >
typedef Superclass::FloatOffsetType itk::NormalVectorDiffusionFunction< TSparseImageType >::FloatOffsetType

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

Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 84 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
typedef Superclass::IndexType itk::NormalVectorDiffusionFunction< TSparseImageType >::IndexType

The index type for the sparse image.

Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 85 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
typedef Superclass::NeighborhoodScalesType itk::NormalVectorDiffusionFunction< TSparseImageType >::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< TSparseImageType >.

Definition at line 83 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
typedef Superclass::NeighborhoodType itk::NormalVectorDiffusionFunction< 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::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 82 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
typedef Superclass::NodeType itk::NormalVectorDiffusionFunction< TSparseImageType >::NodeType

The node type for the sparse image.

Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 87 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
typedef Superclass::NodeValueType itk::NormalVectorDiffusionFunction< TSparseImageType >::NodeValueType

The basic floating point type for the variables.

Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 88 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
typedef Superclass::NormalVectorType itk::NormalVectorDiffusionFunction< TSparseImageType >::NormalVectorType

The vector type for the normals.

Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 89 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
typedef SmartPointer< Self > itk::NormalVectorDiffusionFunction< TSparseImageType >::Pointer
template<class TSparseImageType >
typedef Superclass::RadiusType itk::NormalVectorDiffusionFunction< TSparseImageType >::RadiusType

Neighborhood radius type

Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 81 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
typedef NormalVectorDiffusionFunction itk::NormalVectorDiffusionFunction< TSparseImageType >::Self

Standard class typedef.

Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 65 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
typedef Superclass::SparseImageType itk::NormalVectorDiffusionFunction< TSparseImageType >::SparseImageType
template<class TSparseImageType >
typedef NormalVectorFunctionBase< TSparseImageType > itk::NormalVectorDiffusionFunction< TSparseImageType >::Superclass
template<class TSparseImageType >
typedef Superclass::TimeStepType itk::NormalVectorDiffusionFunction< TSparseImageType >::TimeStepType

Typedefs from the superclass.

Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 77 of file itkNormalVectorDiffusionFunction.h.


Constructor & Destructor Documentation

template<class TSparseImageType >
itk::NormalVectorDiffusionFunction< TSparseImageType >::NormalVectorDiffusionFunction ( )
protected
template<class TSparseImageType >
itk::NormalVectorDiffusionFunction< TSparseImageType >::~NormalVectorDiffusionFunction ( )
inlineprotected

Definition at line 138 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
itk::NormalVectorDiffusionFunction< TSparseImageType >::NormalVectorDiffusionFunction ( const Self )
private

Member Function Documentation

template<class TSparseImageType >
virtual NormalVectorType itk::NormalVectorDiffusionFunction< TSparseImageType >::ComputeSparseUpdate ( NeighborhoodType neighborhood,
void *  globalData,
const FloatOffsetType offset 
) const
virtual

The actual update rule for the normal vectors.

Implements itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

template<class TSparseImageType >
virtual::itk::LightObject::Pointer itk::NormalVectorDiffusionFunction< TSparseImageType >::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.

template<class TSparseImageType >
NodeValueType itk::NormalVectorDiffusionFunction< TSparseImageType >::FluxStopFunction ( const NodeValueType  v) const
inlineprotected

The method called in anisotropic diffusion to inhibit diffusion across areas with large curvature.

Definition at line 143 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
NodeValueType itk::NormalVectorDiffusionFunction< TSparseImageType >::GetConductanceParameter ( ) const
inline

This method returns the conductance parameter.

Definition at line 118 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
NodeValueType itk::NormalVectorDiffusionFunction< TSparseImageType >::GetFluxStopConstant ( ) const
inline

This method returns the internal variable FluxStopConstant.

Definition at line 122 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
virtual const char* itk::NormalVectorDiffusionFunction< TSparseImageType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.

template<class TSparseImageType >
int itk::NormalVectorDiffusionFunction< TSparseImageType >::GetNormalProcessType ( ) const
inline

This method returns the isotropic/anisotropic filtering parameter.

Definition at line 99 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
static Pointer itk::NormalVectorDiffusionFunction< TSparseImageType >::New ( )
static

Standard New macro.

Reimplemented from itk::LightObject.

template<class TSparseImageType >
void itk::NormalVectorDiffusionFunction< TSparseImageType >::operator= ( const Self )
private

Mutex lock to protect modification to the reference count

Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.

template<class TSparseImageType >
virtual void itk::NormalVectorDiffusionFunction< TSparseImageType >::PrecomputeSparseUpdate ( NeighborhoodType it) const
virtual

This function is called from LevelSetNormalImageFilter for all of the nodes to compute and store the flux vectors (first derivatives of the normal vectors. ComputeUpdateNormal then takes derivatives of the flux vectors. This way we avoid repeating the same flux computations.

Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

template<class TSparseImageType >
void itk::NormalVectorDiffusionFunction< TSparseImageType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Returns the time step.

Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.

template<class TSparseImageType >
void itk::NormalVectorDiffusionFunction< TSparseImageType >::SetConductanceParameter ( NodeValueType  cp)
inline

This method sets the conductance parameter used in anisotropic filtering. Useful values for processing 2D and 3D shapes are between 0.1 and 0.25. Lower values preserve more shape features, higher values smooth more. As the conductance parameter large, the processing becomes isotropic. Default is 0.

Definition at line 107 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
void itk::NormalVectorDiffusionFunction< TSparseImageType >::SetNormalProcessType ( int  npt)
inline

This method is used to choose between isotropic/anisotropic filtering. A parameter value of 0 indicates isotropic diffusion and is the default. Parameter value 1 is anisotropic diffusion. When using anisotropic diffusion the conductance parameter should also be set.

Definition at line 95 of file itkNormalVectorDiffusionFunction.h.


Member Data Documentation

template<class TSparseImageType >
const unsigned int itk::NormalVectorDiffusionFunction< TSparseImageType >::ImageDimension = Superclass::ImageDimension
static

Image dimension derived from the superclass.

Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 74 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
NodeValueType itk::NormalVectorDiffusionFunction< TSparseImageType >::m_ConductanceParameter
private

The conductance parameter used for anisotropic diffusion.

Definition at line 153 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
NodeValueType itk::NormalVectorDiffusionFunction< TSparseImageType >::m_FluxStopConstant
private

The internal variable used in the FluxStopFunction. It is computed from ConductanceParameter.

Definition at line 157 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
int itk::NormalVectorDiffusionFunction< TSparseImageType >::m_NormalProcessType
private

The isotropic/anisotropic filtering choice parameter.

Definition at line 160 of file itkNormalVectorDiffusionFunction.h.


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