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

itk::LevelSetFunction< TImageType > Class Template Reference
[Finite Difference FunctionsFunctions]

The LevelSetFunction class is a generic function object which can be used to create a level set method filter when combined with an appropriate finite difference image filter. (See FiniteDifferenceImageFilter.). More...

#include <itkLevelSetFunction.h>

Inheritance diagram for itk::LevelSetFunction< TImageType >:

Inheritance graph
[legend]
Collaboration diagram for itk::LevelSetFunction< TImageType >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef LevelSetFunction Self
typedef FiniteDifferenceFunction<
TImageType
Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef double TimeStepType
typedef Superclass::ImageType ImageType
typedef Superclass::PixelType PixelType
typedef PixelType ScalarValueType
typedef Superclass::RadiusType RadiusType
typedef Superclass::NeighborhoodType NeighborhoodType
typedef Superclass::FloatOffsetType FloatOffsetType
typedef FixedArray< ScalarValueType,
itkGetStaticConstMacro(ImageDimension) 
VectorType )

Public Member Functions

virtual const char * GetNameOfClass () const
 itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
virtual VectorType AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual ScalarValueType CurvatureSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual ScalarValueType LaplacianSmoothingSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &=FloatOffsetType(0.0))
virtual TimeStepType ComputeGlobalTimeStep (void *GlobalData) const
virtual void Initialize (const RadiusType &r)
virtual void ReleaseGlobalDataPointer (void *GlobalData) const
virtual ScalarValueType ComputeMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual ScalarValueType Compute3DMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual void SetAdvectionWeight (const ScalarValueType a)
ScalarValueType GetAdvectionWeight () const
virtual void SetPropagationWeight (const ScalarValueType p)
ScalarValueType GetPropagationWeight () const
virtual void SetCurvatureWeight (const ScalarValueType c)
ScalarValueType GetCurvatureWeight () const
void SetLaplacianSmoothingWeight (const ScalarValueType c)
ScalarValueType GetLaplacianSmoothingWeight () const
void SetEpsilonMagnitude (const ScalarValueType e)
ScalarValueType GetEpsilonMagnitude () const
virtual void * GetGlobalDataPointer () const
virtual ScalarValueType ComputeCurvatureTerm (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual ScalarValueType ComputeMeanCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
void SetUseMinimalCurvature (bool b)
bool GetUseMinimalCurvature () const
void UseMinimalCurvatureOn ()
void UseMinimalCurvatureOff ()

Static Public Member Functions

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

Protected Member Functions

 LevelSetFunction ()
virtual ~LevelSetFunction ()
void PrintSelf (std::ostream &s, Indent indent) const

Static Protected Member Functions

VectorType InitializeZeroVectorConstant ()

Protected Attributes

std::slice x_slice [itkGetStaticConstMacro(ImageDimension)]
::vcl_size_t m_Center
::vcl_size_t m_xStride [itkGetStaticConstMacro(ImageDimension)]
bool m_UseMinimalCurvature
ScalarValueType m_EpsilonMagnitude
ScalarValueType m_AdvectionWeight
ScalarValueType m_PropagationWeight
ScalarValueType m_CurvatureWeight
ScalarValueType m_LaplacianSmoothingWeight

Static Protected Attributes

double m_WaveDT
double m_DT
VectorType m_ZeroVectorConstant

Detailed Description

template<class TImageType>
class itk::LevelSetFunction< TImageType >

The LevelSetFunction class is a generic function object which can be used to create a level set method filter when combined with an appropriate finite difference image filter. (See FiniteDifferenceImageFilter.).

LevelSetFunction implements a generic level set function. This function is an expanded form of the basic equation developed in [1].

$\phi_{t} + \alpha \stackrel{\rightharpoonup}{A}(\mathbf{x})\cdot\nabla\phi + \beta P(\mathbf{x})\mid\nabla\phi\mid = \gamma Z(\mathbf{x})\kappa\mid\nabla\phi\mid$

where $ \stackrel{\rightharpoonup}{A} $ is an advection term, $ P $ is a propagation (growth) term, and $ Z $ is a spatial modifier term for the mean curvature $ \kappa $. $ \alpha $, $ \beta $, and $ \gamma $ are all scalar constants.

Terms in the equation above are supplied through virtual methods, which must be subclassed to complete an implementation. Terms can be eliminated from the equation by setting the corresponding constants to zero. A wide variety of level set methods can be implemented by subclassing this basic equation.

In ITK, the usual sign convention is that the INSIDE of a surface contains NEGATIVE values and the OUTSIDE of the surface contains POSITIVE values.

Warning:
You MUST call Initialize() in the constructor of subclasses of this object to set it up properly to do level-set Calculations. The argument that you pass Initialize is the radius of the neighborhood needed to perform the calculations. If your subclass does not do any additional neighborhood processing, then the default radius should be 1 in each direction.
REFERENCES
[1] Sethian, J.A. Level Set Methods. Cambridge University Press. 1996.

Definition at line 64 of file itkLevelSetFunction.h.


Member Typedef Documentation

template<class TImageType>
typedef SmartPointer<const Self> itk::LevelSetFunction< TImageType >::ConstPointer
 

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >, itk::LevelSetFunctionWithRefitTerm< OutputImageType, SparseImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 72 of file itkLevelSetFunction.h.

template<class TImageType>
typedef Superclass::FloatOffsetType itk::LevelSetFunction< TImageType >::FloatOffsetType
 

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

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >, itk::LevelSetFunctionWithRefitTerm< OutputImageType, SparseImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 90 of file itkLevelSetFunction.h.

template<class TImageType>
typedef Superclass::ImageType itk::LevelSetFunction< TImageType >::ImageType
 

Extract some parameters from the image type

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >, itk::LevelSetFunctionWithRefitTerm< OutputImageType, SparseImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 85 of file itkLevelSetFunction.h.

template<class TImageType>
typedef Superclass::NeighborhoodType itk::LevelSetFunction< TImageType >::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::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >, itk::LevelSetFunctionWithRefitTerm< OutputImageType, SparseImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 89 of file itkLevelSetFunction.h.

template<class TImageType>
typedef Superclass::PixelType itk::LevelSetFunction< TImageType >::PixelType
 

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 86 of file itkLevelSetFunction.h.

template<class TImageType>
typedef SmartPointer<Self> itk::LevelSetFunction< TImageType >::Pointer
 

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >, itk::LevelSetFunctionWithRefitTerm< OutputImageType, SparseImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 71 of file itkLevelSetFunction.h.

template<class TImageType>
typedef Superclass::RadiusType itk::LevelSetFunction< TImageType >::RadiusType
 

Neighborhood radius type

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 88 of file itkLevelSetFunction.h.

template<class TImageType>
typedef PixelType itk::LevelSetFunction< TImageType >::ScalarValueType
 

Reimplemented in itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >, itk::LevelSetFunctionWithRefitTerm< OutputImageType, SparseImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 87 of file itkLevelSetFunction.h.

template<class TImageType>
typedef LevelSetFunction itk::LevelSetFunction< TImageType >::Self
 

Standard class typedefs.

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >, itk::LevelSetFunctionWithRefitTerm< OutputImageType, SparseImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 69 of file itkLevelSetFunction.h.

template<class TImageType>
typedef FiniteDifferenceFunction<TImageType> itk::LevelSetFunction< TImageType >::Superclass
 

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >, itk::LevelSetFunctionWithRefitTerm< OutputImageType, SparseImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 70 of file itkLevelSetFunction.h.

template<class TImageType>
typedef double itk::LevelSetFunction< TImageType >::TimeStepType
 

Convenient typedefs.

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

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

Definition at line 84 of file itkLevelSetFunction.h.

template<class TImageType>
typedef FixedArray<ScalarValueType, itkGetStaticConstMacro(ImageDimension) itk::LevelSetFunction< TImageType >::VectorType)
 

The vector type that will be used in the calculations.

Reimplemented in itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 94 of file itkLevelSetFunction.h.


Constructor & Destructor Documentation

template<class TImageType>
itk::LevelSetFunction< TImageType >::LevelSetFunction  )  [inline, protected]
 

Definition at line 293 of file itkLevelSetFunction.h.

template<class TImageType>
virtual itk::LevelSetFunction< TImageType >::~LevelSetFunction  )  [inline, protected, virtual]
 

Definition at line 301 of file itkLevelSetFunction.h.


Member Function Documentation

template<class TImageType>
virtual VectorType itk::LevelSetFunction< TImageType >::AdvectionField const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct = 0
const [inline, virtual]
 

Advection field. Default implementation returns a vector of zeros.

Reimplemented in itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 122 of file itkLevelSetFunction.h.

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

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

template<class TImageType>
virtual TimeStepType itk::LevelSetFunction< TImageType >::ComputeGlobalTimeStep void *  GlobalData  )  const [virtual]
 

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 >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >, and itk::LevelSetFunctionWithRefitTerm< OutputImageType, SparseImageType >.

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

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

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

Compute the equation value.

Implements itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

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

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

Reimplemented in itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 135 of file itkLevelSetFunction.h.

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

Alpha. Scales all advection term values.

Definition at line 150 of file itkLevelSetFunction.h.

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

Gamma. Scales all curvature weight values

Definition at line 164 of file itkLevelSetFunction.h.

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

Epsilon.

Definition at line 178 of file itkLevelSetFunction.h.

template<class TImageType>
virtual void* itk::LevelSetFunction< TImageType >::GetGlobalDataPointer  )  const [inline, virtual]
 

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 >, and itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 202 of file itkLevelSetFunction.h.

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

Weight of the laplacian smoothing term

Definition at line 171 of file itkLevelSetFunction.h.

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

Set/Get the maximum constraint for the curvature term factor in the time step calculation. Changing this value from the default is not recommended or necessary, but can be used to speed up the surface evolution at the risk of creating an unstable solution.

Definition at line 272 of file itkLevelSetFunction.h.

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

Set/Get the maximum constraint for the scalar/vector term factor of the time step calculation. Changing this value from the default is not recommended or necessary, but can be used to speed up the surface evolution at the risk of creating an unstable solution.

Definition at line 286 of file itkLevelSetFunction.h.

template<class TImageType>
virtual const char* itk::LevelSetFunction< TImageType >::GetNameOfClass  )  const [virtual]
 

Run-time type information (and related methods)

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >, itk::LevelSetFunctionWithRefitTerm< OutputImageType, SparseImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

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

Beta. Scales all propagation term values.

Definition at line 157 of file itkLevelSetFunction.h.

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

Definition at line 250 of file itkLevelSetFunction.h.

template<class TImageType>
virtual void itk::LevelSetFunction< TImageType >::Initialize const RadiusType r  )  [virtual]
 

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 in itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

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

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

template<class TImageType>
itk::LevelSetFunction< TImageType >::itkStaticConstMacro ImageDimension  ,
unsigned  int,
Superclass::ImageDimension 
 

Extract some parameters from the superclass.

Reimplemented in itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

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

Laplacian smoothing speed. Can be used to spatially modify the effects of laplacian smoothing of the level set function

Definition at line 142 of file itkLevelSetFunction.h.

template<class TImageType>
Pointer itk::LevelSetFunction< TImageType >::New  )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::LightObject.

Reimplemented in itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >, and itk::LevelSetFunctionWithRefitTerm< OutputImageType, SparseImageType >.

template<class TImageType>
void itk::LevelSetFunction< TImageType >::PrintSelf std::ostream &  s,
Indent  indent
const [protected, virtual]
 

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >, and itk::LevelSetFunctionWithRefitTerm< OutputImageType, SparseImageType >.

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

Propagation speed. This term controls surface expansion/contraction. Default implementation returns zero.

Reimplemented in itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< OutputImageType, SparseImageType >, and itk::SegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 128 of file itkLevelSetFunction.h.

template<class TImageType>
virtual void itk::LevelSetFunction< TImageType >::ReleaseGlobalDataPointer void *  GlobalData  )  const [inline, virtual]
 

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

Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >.

Definition at line 221 of file itkLevelSetFunction.h.

template<class TImageType>
virtual void itk::LevelSetFunction< TImageType >::SetAdvectionWeight const ScalarValueType  a  )  [inline, virtual]
 

Alpha. Scales all advection term values.

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

Definition at line 148 of file itkLevelSetFunction.h.

template<class TImageType>
virtual void itk::LevelSetFunction< TImageType >::SetCurvatureWeight const ScalarValueType  c  )  [inline, virtual]
 

Gamma. Scales all curvature weight values

Definition at line 162 of file itkLevelSetFunction.h.

template<class TImageType>
void itk::LevelSetFunction< TImageType >::SetEpsilonMagnitude const ScalarValueType  e  )  [inline]
 

Epsilon.

Definition at line 176 of file itkLevelSetFunction.h.

template<class TImageType>
void itk::LevelSetFunction< TImageType >::SetLaplacianSmoothingWeight const ScalarValueType  c  )  [inline]
 

Weight of the laplacian smoothing term

Definition at line 169 of file itkLevelSetFunction.h.

template<class TImageType>
void itk::LevelSetFunction< TImageType >::SetMaximumCurvatureTimeStep double  n  )  [inline, static]
 

Set/Get the maximum constraint for the curvature term factor in the time step calculation. Changing this value from the default is not recommended or necessary, but can be used to speed up the surface evolution at the risk of creating an unstable solution.

Definition at line 268 of file itkLevelSetFunction.h.

template<class TImageType>
void itk::LevelSetFunction< TImageType >::SetMaximumPropagationTimeStep double  n  )  [inline, static]
 

Set/Get the maximum constraint for the scalar/vector term factor of the time step calculation. Changing this value from the default is not recommended or necessary, but can be used to speed up the surface evolution at the risk of creating an unstable solution.

Definition at line 282 of file itkLevelSetFunction.h.

template<class TImageType>
virtual void itk::LevelSetFunction< TImageType >::SetPropagationWeight const ScalarValueType  p  )  [inline, virtual]
 

Beta. Scales all propagation term values.

Definition at line 155 of file itkLevelSetFunction.h.

template<class TImageType>
void itk::LevelSetFunction< TImageType >::SetUseMinimalCurvature bool  b  )  [inline]
 

Definition at line 246 of file itkLevelSetFunction.h.

template<class TImageType>
void itk::LevelSetFunction< TImageType >::UseMinimalCurvatureOff  )  [inline]
 

Definition at line 258 of file itkLevelSetFunction.h.

template<class TImageType>
void itk::LevelSetFunction< TImageType >::UseMinimalCurvatureOn  )  [inline]
 

Definition at line 254 of file itkLevelSetFunction.h.


Member Data Documentation

template<class TImageType>
ScalarValueType itk::LevelSetFunction< TImageType >::m_AdvectionWeight [protected]
 

Alpha.

Definition at line 330 of file itkLevelSetFunction.h.

template<class TImageType>
:: vcl_size_t itk::LevelSetFunction< TImageType >::m_Center [protected]
 

The offset of the center pixel in the neighborhood.

Definition at line 312 of file itkLevelSetFunction.h.

template<class TImageType>
ScalarValueType itk::LevelSetFunction< TImageType >::m_CurvatureWeight [protected]
 

Gamma.

Definition at line 336 of file itkLevelSetFunction.h.

template<class TImageType>
double itk::LevelSetFunction< TImageType >::m_DT [static, protected]
 

Definition at line 306 of file itkLevelSetFunction.h.

template<class TImageType>
ScalarValueType itk::LevelSetFunction< TImageType >::m_EpsilonMagnitude [protected]
 

Epsilon magnitude controls the lower limit for gradient magnitude.

Definition at line 327 of file itkLevelSetFunction.h.

template<class TImageType>
ScalarValueType itk::LevelSetFunction< TImageType >::m_LaplacianSmoothingWeight [protected]
 

Laplacean smoothing term

Definition at line 339 of file itkLevelSetFunction.h.

template<class TImageType>
ScalarValueType itk::LevelSetFunction< TImageType >::m_PropagationWeight [protected]
 

Beta.

Definition at line 333 of file itkLevelSetFunction.h.

template<class TImageType>
bool itk::LevelSetFunction< TImageType >::m_UseMinimalCurvature [protected]
 

Definition at line 317 of file itkLevelSetFunction.h.

template<class TImageType>
double itk::LevelSetFunction< TImageType >::m_WaveDT [static, protected]
 

Constants used in the time step calculation.

Definition at line 305 of file itkLevelSetFunction.h.

template<class TImageType>
:: vcl_size_t itk::LevelSetFunction< TImageType >::m_xStride[itkGetStaticConstMacro(ImageDimension)] [protected]
 

Stride length along the y-dimension.

Definition at line 315 of file itkLevelSetFunction.h.

template<class TImageType>
VectorType itk::LevelSetFunction< TImageType >::m_ZeroVectorConstant [static, protected]
 

Zero vector constant.

Definition at line 324 of file itkLevelSetFunction.h.

template<class TImageType>
std::slice itk::LevelSetFunction< TImageType >::x_slice[itkGetStaticConstMacro(ImageDimension)] [protected]
 

Slices for the ND neighborhood.

Definition at line 309 of file itkLevelSetFunction.h.


The documentation for this class was generated from the following file:
Generated at Thu May 25 01:37:43 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000