Orfeo Toolbox  3.16
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
itk::NormalVectorDiffusionFunction< TSparseImageType > Class Template Reference

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

#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
ZeroFluxNeumannBoundaryCondition
< ImageType
DefaultBoundaryConditionType
typedef Superclass::FloatOffsetType FloatOffsetType
typedef TSparseImageType ImageType
typedef Superclass::IndexType IndexType
typedef
Superclass::NeighborhoodScalesType 
NeighborhoodScalesType
typedef
Superclass::NeighborhoodType 
NeighborhoodType
typedef NodeType::NodeDataType NodeDataType
typedef Superclass::NodeType NodeType
typedef Superclass::NodeValueType NodeValueType
typedef
Superclass::NormalVectorType 
NormalVectorType
typedef double PixelRealType
typedef Superclass::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef Superclass::RadiusType RadiusType
typedef
NormalVectorDiffusionFunction 
Self
typedef Superclass::SparseImageType SparseImageType
typedef
NormalVectorFunctionBase
< TSparseImageType > 
Superclass
typedef Superclass::TimeStepType TimeStepType

Public Member Functions

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

Static Public Member Functions

static void BreakOnError ()
static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = Superclass::ImageDimension

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

 NormalVectorDiffusionFunction ()
 ~NormalVectorDiffusionFunction ()
NodeValueType FluxStopFunction (const NodeValueType v) const
virtual void PrintHeader (std::ostream &os, Indent indent) const
void PrintSelf (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]

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 58 of file itkNormalVectorDiffusionFunction.h.


Member Typedef Documentation

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

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

Definition at line 91 of file itkFiniteDifferenceFunction.h.

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 82 of file itkNormalVectorDiffusionFunction.h.

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

Extract some parameters from the image type

Definition at line 75 of file itkFiniteDifferenceFunction.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 83 of file itkNormalVectorDiffusionFunction.h.

typedef int itk::LightObject::InternalReferenceCountType
protectedinherited

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

Definition at line 137 of file itkLightObject.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 81 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 80 of file itkNormalVectorDiffusionFunction.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 76 of file itkFiniteDifferenceSparseImageFunction.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 85 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 86 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 87 of file itkNormalVectorDiffusionFunction.h.

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

Definition at line 80 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 62 of file itkFiniteDifferenceSparseImageFunction.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 79 of file itkNormalVectorDiffusionFunction.h.

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

Standard class typedef.

Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 63 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 75 of file itkNormalVectorDiffusionFunction.h.


Constructor & Destructor Documentation

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

Definition at line 28 of file itkNormalVectorDiffusionFunction.txx.

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

Definition at line 135 of file itkNormalVectorDiffusionFunction.h.

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

Member Function Documentation

void itk::LightObject::BreakOnError ( )
staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

template<class TSparseImageType >
virtual TimeStepType itk::NormalVectorFunctionBase< TSparseImageType >::ComputeGlobalTimeStep ( void *  ) const
inlinevirtualinherited

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

Implements itk::FiniteDifferenceFunction< TSparseImageType >.

Definition at line 88 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 >
NormalVectorDiffusionFunction< TSparseImageType >::NormalVectorType itk::NormalVectorDiffusionFunction< TSparseImageType >::ComputeSparseUpdate ( NeighborhoodType neighborhood,
void *  globalData,
const FloatOffsetType offset 
) const
virtual
template<class TSparseImageType >
virtual PixelType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::ComputeUpdate ( const NeighborhoodType ,
void *  ,
const FloatOffsetType  
)
inlinevirtualinherited

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 82 of file itkFiniteDifferenceSparseImageFunction.h.

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.

void itk::LightObject::Delete ( )
virtualinherited

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.

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

Definition at line 88 of file itkLightObject.cxx.

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 140 of file itkNormalVectorDiffusionFunction.h.

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

This method returns the conductance parameter.

Definition at line 115 of file itkNormalVectorDiffusionFunction.h.

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

This method returns the internal variable FluxStopConstant.

Definition at line 119 of file itkNormalVectorDiffusionFunction.h.

template<class TSparseImageType >
virtual void* itk::NormalVectorFunctionBase< TSparseImageType >::GetGlobalDataPointer ( ) const
inlinevirtualinherited

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::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 97 of file itkNormalVectorDiffusionFunction.h.

const RadiusType& itk::FiniteDifferenceFunction< TSparseImageType >::GetRadius ( void  ) const
inlineinherited

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

Definition at line 145 of file itkFiniteDifferenceFunction.h.

virtual int itk::LightObject::GetReferenceCount ( ) const
inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

template<class TSparseImageType >
TimeStepType itk::NormalVectorFunctionBase< TSparseImageType >::GetTimeStep ( ) const
inlineinherited

Returns the time step.

Definition at line 96 of file itkNormalVectorFunctionBase.h.

virtual void itk::FiniteDifferenceFunction< TSparseImageType >::InitializeIteration ( )
inlinevirtualinherited

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 117 of file itkFiniteDifferenceFunction.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
template<class TSparseImageType >
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 >.

Definition at line 58 of file itkNormalVectorDiffusionFunction.txx.

References itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetCenterPixel(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNext(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPrevious(), itk::Neighborhood< TPixel, VDimension, TAllocator >::GetStride(), and itk::Neighborhood< TPixel, VDimension, TAllocator >::Size().

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

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

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

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.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.

Definition at line 47 of file itkNormalVectorDiffusionFunction.txx.

void itk::LightObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::LightObject::Register ( ) const
virtualinherited

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

Reimplemented in itk::ExceptionObject::ReferenceCountedExceptionData, and itk::Object.

Definition at line 160 of file itkLightObject.cxx.

template<class TSparseImageType >
virtual void itk::NormalVectorFunctionBase< TSparseImageType >::ReleaseGlobalDataPointer ( void *  GlobalData) const
inlinevirtualinherited

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

Definition at line 85 of file itkNormalVectorFunctionBase.h.

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 105 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 93 of file itkNormalVectorDiffusionFunction.h.

void itk::FiniteDifferenceFunction< TSparseImageType >::SetRadius ( const RadiusType r)
inlineinherited

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

Definition at line 140 of file itkFiniteDifferenceFunction.h.

void itk::LightObject::SetReferenceCount ( int  ref)
virtualinherited

Sets the reference count on this object. This is a dangerous method, use it with care.

Sets the reference count (use with care)

Reimplemented in itk::Object.

Definition at line 244 of file itkLightObject.cxx.

void itk::FiniteDifferenceFunction< TSparseImageType >::SetScaleCoefficients ( PixelRealType  vals[ImageDimension])
inlineinherited

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

template<class TSparseImageType >
void itk::NormalVectorFunctionBase< TSparseImageType >::SetTimeStep ( const TimeStepType ts)
inlineinherited

Sets the time step.

Definition at line 92 of file itkNormalVectorFunctionBase.h.

void itk::LightObject::UnRegister ( ) const
virtualinherited

Decrease the reference count (release by another object).

Reimplemented in itk::ExceptionObject::ReferenceCountedExceptionData, and itk::Object.

Definition at line 192 of file itkLightObject.cxx.

Referenced by itk::LightObject::New().


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 72 of file itkNormalVectorDiffusionFunction.h.

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

The conductance parameter used for anisotropic diffusion.

Definition at line 149 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 153 of file itkNormalVectorDiffusionFunction.h.

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

The isotropic/anisotropic filtering choice parameter.

Definition at line 156 of file itkNormalVectorDiffusionFunction.h.

RadiusType itk::FiniteDifferenceFunction< TSparseImageType >::m_Radius
protectedinherited

Definition at line 201 of file itkFiniteDifferenceFunction.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount
mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock
mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

PixelRealType itk::FiniteDifferenceFunction< TSparseImageType >::m_ScaleCoefficients[ImageDimension]
protectedinherited

Definition at line 202 of file itkFiniteDifferenceFunction.h.


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

Generated at Sun Feb 3 2013 02:18:10 for Orfeo Toolbox with doxygen 1.8.1.1