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

itk::CurvesLevelSetFunction< TImageType, TFeatureImageType > Class Template Reference
[Finite Difference Functions]

#include <itkCurvesLevelSetFunction.h>

Inheritance diagram for itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >:

Inheritance graph
[legend]
Collaboration diagram for itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class TImageType, class TFeatureImageType = TImageType>
class itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >

This function is used in CurvesLevelSetImageFilter to segment structures in images based on user supplied edge potential map.

CurvesLevelSetFunction is a subclass of the generic LevelSetFunction.
It is useful for segmentations based on a user supplied edge potential map which has values close to zero in regions near edges (or high image gradient) and values close to one in regions with relatively constant intensity. Typically, the edge potential map is a function of the gradient, for example:

\[ g(I) = 1 / ( 1 + | (\nabla * G)(I)| ) \]

\[ g(I) = \exp^{-|(\nabla * G)(I)|} \]

where $ I $ is image intensity and $ (\nabla * G) $ is the derivative of Gaussian operator.

In this function both the propagation term $ (\nabla * G) $#24
and the curvature spatial modifier term $$ Z(\mathbf{x}) $ are taken directly from the edge potential image. The edge potential image is set via the SetFeatureImage() method. An advection term $ A(\mathbf{x}) $ is constructed from the negative gradient of the edge potential image. This term behaves like a doublet attracting the contour to the edges.
This implementation is based on:
L. Lorigo, O. Faugeras, W.E.L. Grimson, R. Keriven, R. Kikinis, A. Nabavi, and C.-F. Westin, Curves: Curve evolution for vessel segmentation. Medical Image Analysis, 5:195-206, 2001.
See also:
LevelSetFunction

SegmentationLevelSetImageFunction

GeodesicActiveContourLevelSetImageFilter

Definition at line 61 of file itkCurvesLevelSetFunction.h.

Public Types

typedef SmartPointer< const
Self
ConstPointer
typedef InterpolatorType::ContinuousIndexType ContinuousIndexType
typedef ZeroFluxNeumannBoundaryCondition<
ImageType
DefaultBoundaryConditionType
typedef TFeatureImageType FeatureImageType
typedef Superclass::FeatureScalarType FeatureScalarType
typedef SuperSuperclass::FloatOffsetType FloatOffsetType
typedef SuperSuperclass::GlobalDataStruct GlobalDataStruct
typedef Superclass::ImageType ImageType
typedef ImageType::IndexType IndexType
typedef LinearInterpolateImageFunction<
ImageType
InterpolatorType
typedef Superclass::NeighborhoodType NeighborhoodType
typedef double PixelRealType
typedef SuperSuperclass::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef Superclass::RadiusType RadiusType
typedef Superclass::ScalarValueType ScalarValueType
typedef CurvesLevelSetFunction Self
typedef SegmentationLevelSetFunction<
TImageType > 
Superclass
typedef LevelSetFunction<
TImageType > 
SuperSuperclass
typedef double TimeStepType
typedef Superclass::VectorImageType VectorImageType
typedef VectorLinearInterpolateImageFunction<
VectorImageType
VectorInterpolatorType
typedef Superclass::VectorType VectorType

Public Member Functions

virtual void AllocateAdvectionImage ()
virtual void AllocateSpeedImage ()
virtual void CalculateAdvectionImage ()
virtual void CalculateSpeedImage ()
virtual ScalarValueType Compute3DMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual TimeStepType ComputeGlobalTimeStep (void *GlobalData) const
virtual ScalarValueType ComputeMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &=FloatOffsetType(0.0))
virtual Pointer CreateAnother () const
virtual ScalarValueType CurvatureSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual ScalarValueType CurvatureSpeed (const NeighborhoodType &neighborhood, const FloatOffsetType &offset, GlobalDataStruct *gd) const
virtual void Delete ()
virtual const char * GetNameOfClass () const
const RadiusTypeGetRadius () const
virtual int GetReferenceCount () const
virtual void Initialize (const RadiusType &r)
virtual void Initialize (const RadiusType &r)
virtual void InitializeIteration ()
 itkStaticConstMacro (ImageDimension, unsigned int, ImageType::ImageDimension)
 itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
virtual ScalarValueType LaplacianSmoothingSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
void Print (std::ostream &os, Indent indent=0) const
virtual void Register () const
virtual void ReleaseGlobalDataPointer (void *GlobalData) const
virtual void ReverseExpansionDirection ()
void SetRadius (const RadiusType &r)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
virtual ScalarValueType ComputeCurvatureTerm (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual ScalarValueType ComputeMeanCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual VectorImageTypeGetAdvectionImage () const
void SetAdvectionImage (VectorImageType *s)
ScalarValueType GetAdvectionWeight () const
virtual void SetAdvectionWeight (const ScalarValueType a)
ScalarValueType GetCurvatureWeight () const
virtual void SetCurvatureWeight (const ScalarValueType c)
double GetDerivativeSigma ()
void SetDerivativeSigma (const double v)
ScalarValueType GetEpsilonMagnitude () const
void SetEpsilonMagnitude (const ScalarValueType e)
virtual const FeatureImageTypeGetFeatureImage () const
virtual void SetFeatureImage (const FeatureImageType *f)
virtual void * GetGlobalDataPointer () const
ScalarValueType GetLaplacianSmoothingWeight () const
void SetLaplacianSmoothingWeight (const ScalarValueType c)
ScalarValueType GetPropagationWeight () const
virtual void SetPropagationWeight (const ScalarValueType p)
virtual ImageTypeGetSpeedImage ()
void SetSpeedImage (ImageType *s)
bool GetUseMinimalCurvature () const
void SetUseMinimalCurvature (bool b)
void UseMinimalCurvatureOff ()
void UseMinimalCurvatureOn ()
void SetScaleCoefficients (PixelRealType vals[ImageDimension])

Static Public Member Functions

static void BreakOnError ()
static Pointer New ()
static double GetMaximumCurvatureTimeStep ()
static void SetMaximumCurvatureTimeStep (double n)
static double GetMaximumPropagationTimeStep ()
static void SetMaximumPropagationTimeStep (double n)

Protected Member Functions

virtual VectorType AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const
 CurvesLevelSetFunction (const Self &)
 CurvesLevelSetFunction ()
void operator= (const Self &)
void PrintSelf (std::ostream &os, Indent indent) const
virtual ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const
virtual ~CurvesLevelSetFunction ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const

Static Protected Member Functions

static VectorType InitializeZeroVectorConstant ()

Protected Attributes

VectorImageType::Pointer m_AdvectionImage
ScalarValueType m_AdvectionWeight
ScalarValueType m_CurvatureWeight
ScalarValueType m_EpsilonMagnitude
FeatureImageType::ConstPointer m_FeatureImage
InterpolatorType::Pointer m_Interpolator
ScalarValueType m_LaplacianSmoothingWeight
ScalarValueType m_PropagationWeight
RadiusType m_Radius
volatile int m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
PixelRealType m_ScaleCoefficients [ImageDimension]
ImageType::Pointer m_SpeedImage
bool m_UseMinimalCurvature
Functor::VectorCast< typename
VectorInterpolatorType::OutputType,
VectorType
m_VectorCast
VectorInterpolatorType::Pointer m_VectorInterpolator

Static Protected Attributes

static double m_DT
static double m_WaveDT
static VectorType m_ZeroVectorConstant


Member Typedef Documentation

template<class TImageType, class TFeatureImageType = TImageType>
typedef SmartPointer<const Self> itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::ConstPointer

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 70 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef InterpolatorType::ContinuousIndexType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::ContinuousIndexType [inherited]

Continuous index type recognized by the interpolator

Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 84 of file itkSegmentationLevelSetFunction.h.

template<class TImageType>
typedef ZeroFluxNeumannBoundaryCondition<ImageType> itk::FiniteDifferenceFunction< TImageType >::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 TImageType, class TFeatureImageType = TImageType>
typedef TFeatureImageType itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::FeatureImageType

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 71 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef Superclass::FeatureScalarType itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::FeatureScalarType

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 84 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef SuperSuperclass::FloatOffsetType itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::FloatOffsetType

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

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 86 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef SuperSuperclass::GlobalDataStruct itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::GlobalDataStruct

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 87 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef Superclass::ImageType itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::ImageType

Extract some parameters from the superclass.

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 81 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef ImageType::IndexType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::IndexType [inherited]

Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 66 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef LinearInterpolateImageFunction<ImageType> itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::InterpolatorType [inherited]

Define a scalar interpolator

Definition at line 78 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef Superclass::NeighborhoodType itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::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::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 82 of file itkCurvesLevelSetFunction.h.

template<class TImageType>
typedef double itk::FiniteDifferenceFunction< TImageType >::PixelRealType [inherited]

Definition at line 82 of file itkFiniteDifferenceFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef SuperSuperclass::PixelType itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::PixelType

Extract some parameters from the superclass.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 77 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef SmartPointer<Self> itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::Pointer

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 69 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef Superclass::RadiusType itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::RadiusType

Neighborhood radius type

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 85 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef Superclass::ScalarValueType itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::ScalarValueType

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 83 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef CurvesLevelSetFunction itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::Self

Standard class typedefs.

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 66 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef SegmentationLevelSetFunction<TImageType> itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::Superclass

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 67 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef LevelSetFunction<TImageType> itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::SuperSuperclass

Definition at line 68 of file itkCurvesLevelSetFunction.h.

template<class TImageType>
typedef double itk::LevelSetFunction< TImageType >::TimeStepType [inherited]

Convenient typedefs.

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >.

Definition at line 84 of file itkLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef Superclass::VectorImageType itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::VectorImageType

Define an image type for the advection field.

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 88 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef VectorLinearInterpolateImageFunction<VectorImageType> itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::VectorInterpolatorType [inherited]

Define a vector interpolator

Definition at line 81 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
typedef Superclass::VectorType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::VectorType [inherited]

The vector type that will be used in the calculations.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 67 of file itkSegmentationLevelSetFunction.h.


Constructor & Destructor Documentation

template<class TImageType, class TFeatureImageType = TImageType>
itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::CurvesLevelSetFunction (  )  [inline, protected]

Definition at line 116 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
virtual itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::~CurvesLevelSetFunction (  )  [inline, protected, virtual]

Definition at line 127 of file itkCurvesLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::CurvesLevelSetFunction ( const Self  )  [protected]


Member Function Documentation

template<class TImageType, class TFeatureImageType = TImageType>
virtual VectorType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::AdvectionField ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct gd 
) const [protected, virtual, inherited]

Advection field. Returns a vector from the computed advectionfield.

Reimplemented from itk::LevelSetFunction< TImageType >.

template<class TImageType, class TFeatureImageType = TImageType>
virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::AllocateAdvectionImage (  )  [virtual, inherited]

Allocates the image that will be used for the level set function's Advection field term. See LevelSetFunction for more information.

template<class TImageType, class TFeatureImageType = TImageType>
virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::AllocateSpeedImage (  )  [virtual, inherited]

Allocates the image that will be used for the level set function's Propagation Speed term. See LevelSetFunction for more information.

static void itk::LightObject::BreakOnError (  )  [static, inherited]

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

template<class TImageType, class TFeatureImageType = TImageType>
virtual void itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::CalculateAdvectionImage (  )  [virtual]

Compute the advection field from feature image.

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

template<class TImageType, class TFeatureImageType = TImageType>
virtual void itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::CalculateSpeedImage (  )  [virtual]

Compute speed image from feature image.

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

template<class TImageType>
virtual ScalarValueType itk::LevelSetFunction< TImageType >::Compute3DMinimalCurvature ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct gd = 0 
) [virtual, inherited]

template<class TImageType>
virtual ScalarValueType itk::LevelSetFunction< TImageType >::ComputeCurvatureTerm ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct gd = 0 
) [virtual, inherited]

template<class TImageType>
virtual TimeStepType itk::LevelSetFunction< TImageType >::ComputeGlobalTimeStep ( void *  GlobalData  )  const [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.

Implements itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >.

template<class TImageType>
virtual ScalarValueType itk::LevelSetFunction< TImageType >::ComputeMeanCurvature ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct gd = 0 
) [virtual, inherited]

template<class TImageType>
virtual ScalarValueType itk::LevelSetFunction< TImageType >::ComputeMinimalCurvature ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct gd = 0 
) [virtual, inherited]

template<class TImageType>
virtual PixelType itk::LevelSetFunction< TImageType >::ComputeUpdate ( const NeighborhoodType neighborhood,
void *  globalData,
const FloatOffsetType = FloatOffsetType(0.0) 
) [virtual, inherited]

Compute the equation value.

Implements itk::FiniteDifferenceFunction< TImageType >.

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.

template<class TImageType>
virtual ScalarValueType itk::LevelSetFunction< TImageType >::CurvatureSpeed ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct = 0 
) const [inline, virtual, inherited]

Curvature speed. Can be used to spatially modify the effects of curvature . The default implementation returns one.

Definition at line 135 of file itkLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
virtual ScalarValueType itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::CurvatureSpeed ( const NeighborhoodType neighborhood,
const FloatOffsetType offset,
GlobalDataStruct gd 
) const [inline, virtual]

The curvature speed is same as the propagation speed.

Definition at line 101 of file itkCurvesLevelSetFunction.h.

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 TImageType, class TFeatureImageType = TImageType>
virtual VectorImageType* itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetAdvectionImage (  )  const [inline, virtual, inherited]

Get/Set the image used as the advection field in the level set equation

Definition at line 100 of file itkSegmentationLevelSetFunction.h.

template<class TImageType>
ScalarValueType itk::LevelSetFunction< TImageType >::GetAdvectionWeight (  )  const [inline, inherited]

Definition at line 150 of file itkLevelSetFunction.h.

template<class TImageType>
ScalarValueType itk::LevelSetFunction< TImageType >::GetCurvatureWeight (  )  const [inline, inherited]

Definition at line 164 of file itkLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
double itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::GetDerivativeSigma (  )  [inline]

Definition at line 109 of file itkCurvesLevelSetFunction.h.

template<class TImageType>
ScalarValueType itk::LevelSetFunction< TImageType >::GetEpsilonMagnitude (  )  const [inline, inherited]

Definition at line 178 of file itkLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
virtual const FeatureImageType* itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetFeatureImage (  )  const [inline, virtual, inherited]

Set/Get the image which will be used to calculate the speed function.

Definition at line 87 of file itkSegmentationLevelSetFunction.h.

template<class TImageType>
virtual void* itk::LevelSetFunction< TImageType >::GetGlobalDataPointer (  )  const [inline, 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. Global data can be used for caching any values used or reused by the FunctionObject. Each thread should receive its own global data struct.

Implements itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 202 of file itkLevelSetFunction.h.

References itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxAdvectionChange, itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxCurvatureChange, and itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxPropagationChange.

template<class TImageType>
ScalarValueType itk::LevelSetFunction< TImageType >::GetLaplacianSmoothingWeight (  )  const [inline, inherited]

Definition at line 171 of file itkLevelSetFunction.h.

template<class TImageType>
static double itk::LevelSetFunction< TImageType >::GetMaximumCurvatureTimeStep (  )  [inline, static, inherited]

Definition at line 272 of file itkLevelSetFunction.h.

template<class TImageType>
static double itk::LevelSetFunction< TImageType >::GetMaximumPropagationTimeStep (  )  [inline, static, inherited]

Definition at line 286 of file itkLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
virtual const char* itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::GetNameOfClass (  )  const [virtual]

Run-time type information (and related methods)

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

template<class TImageType>
ScalarValueType itk::LevelSetFunction< TImageType >::GetPropagationWeight (  )  const [inline, inherited]

Definition at line 157 of file itkLevelSetFunction.h.

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

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

Definition at line 143 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 TImageType, class TFeatureImageType = TImageType>
virtual ImageType* itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetSpeedImage (  )  [inline, virtual, inherited]

Get/Set the image used as the speed function in the level set equation

Definition at line 94 of file itkSegmentationLevelSetFunction.h.

template<class TImageType>
bool itk::LevelSetFunction< TImageType >::GetUseMinimalCurvature (  )  const [inline, inherited]

Definition at line 250 of file itkLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::Initialize ( const RadiusType r  )  [virtual, inherited]

This method creates the appropriate member variable operators for the level-set calculations. The argument to this function is a the radius necessary for performing the level-set calculations.

Reimplemented from itk::LevelSetFunction< TImageType >.

Referenced by itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSegmentationFunction().

template<class TImageType, class TFeatureImageType = TImageType>
virtual void itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >::Initialize ( const RadiusType r  )  [virtual]

template<class TImageType>
virtual void itk::FiniteDifferenceFunction< TImageType >::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::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >, itk::FastSymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >, itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >, itk::MeanSquareRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >, itk::MIRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >, itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >, itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >, itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, itk::GradientNDAnisotropicDiffusionFunction< TImage >, itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >.

Definition at line 115 of file itkFiniteDifferenceFunction.h.

template<class TImageType>
static VectorType itk::LevelSetFunction< TImageType >::InitializeZeroVectorConstant (  )  [static, protected, inherited]

This method's only purpose is to initialize the zero vector constant.

template<class TImageType>
itk::FiniteDifferenceFunction< TImageType >::itkStaticConstMacro ( ImageDimension  ,
unsigned  int,
ImageType::ImageDimension