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

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

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

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.

Public Types

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

Public Member Functions

virtual VectorType AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
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 void Delete ()
virtual const char * GetNameOfClass () const
const RadiusType & GetRadius () const
virtual int GetReferenceCount () const
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 ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual void Register () const
virtual void ReleaseGlobalDataPointer (void *GlobalData) const
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)
ScalarValueType GetAdvectionWeight () const
virtual void SetAdvectionWeight (const ScalarValueType a)
ScalarValueType GetCurvatureWeight () const
virtual void SetCurvatureWeight (const ScalarValueType c)
ScalarValueType GetEpsilonMagnitude () const
void SetEpsilonMagnitude (const ScalarValueType e)
virtual void * GetGlobalDataPointer () const
ScalarValueType GetLaplacianSmoothingWeight () const
void SetLaplacianSmoothingWeight (const ScalarValueType c)
ScalarValueType GetPropagationWeight () const
virtual void SetPropagationWeight (const ScalarValueType p)
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

 LevelSetFunction ()
void PrintSelf (std::ostream &s, Indent indent) const
virtual ~LevelSetFunction ()
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

ScalarValueType m_AdvectionWeight
::vcl_size_t m_Center
ScalarValueType m_CurvatureWeight
ScalarValueType m_EpsilonMagnitude
ScalarValueType m_LaplacianSmoothingWeight
ScalarValueType m_PropagationWeight
RadiusType m_Radius
volatile int m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
PixelRealType m_ScaleCoefficients [ImageDimension]
bool m_UseMinimalCurvature
::vcl_size_t m_xStride [itkGetStaticConstMacro(ImageDimension)]
std::slice x_slice [itkGetStaticConstMacro(ImageDimension)]

Static Protected Attributes

static double m_DT
static double m_WaveDT
static VectorType m_ZeroVectorConstant

Classes

struct  GlobalDataStruct

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 >, and itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 72 of file itkLevelSetFunction.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>
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 >, and itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

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 >, and itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

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 >, and itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 89 of file itkLevelSetFunction.h.

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

Definition at line 82 of file itkFiniteDifferenceFunction.h.

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

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

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

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 >, and itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

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 >, and itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

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 >, and itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

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 >, and itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

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 >, and itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

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

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

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

Definition at line 122 of file itkLevelSetFunction.h.

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

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

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]

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.

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>
ScalarValueType itk::LevelSetFunction< TImageType >::GetAdvectionWeight (  )  const [inline]

Definition at line 150 of file itkLevelSetFunction.h.

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

Definition at line 164 of file itkLevelSetFunction.h.

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

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

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]

Definition at line 171 of file itkLevelSetFunction.h.

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

Definition at line 272 of file itkLevelSetFunction.h.

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

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 >, and itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

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

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>
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::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

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]

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

template<class TImageType>
itk::FiniteDifferenceFunction< TImageType >::itkStaticConstMacro ( ImageDimension  ,
unsigned  int,
ImageType::ImageDimension   
) [inherited]

Save image dimension.

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 >, and itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

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>
static 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 >, and itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >.

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

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

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

virtual void itk::LightObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

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::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 128 of file itkLevelSetFunction.h.

virtual void itk::LightObject::Register (  )  const [virtual, inherited]

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

Reimplemented in itk::Object.

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

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.

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>
static 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>
static 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::FiniteDifferenceFunction< TImageType >::SetRadius ( const RadiusType &  r  )  [inline, inherited]

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

Definition at line 138 of file itkFiniteDifferenceFunction.h.

virtual void itk::LightObject::SetReferenceCount ( int   )  [virtual, inherited]

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

Reimplemented in itk::Object.

template<class TImageType>
void itk::FiniteDifferenceFunction< TImageType >::SetScaleCoefficients ( PixelRealType  vals[ImageDimension]  )  [inline, inherited]

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

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

Definition at line 246 of file itkLevelSetFunction.h.

virtual void itk::LightObject::UnRegister (  )  const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented in itk::Object.

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>
RadiusType itk::FiniteDifferenceFunction< TImageType >::m_Radius [protected, inherited]

Definition at line 195 of file itkFiniteDifferenceFunction.h.

volatile int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 122 of file itkLightObject.h.

template<class TImageType>
PixelRealType itk::FiniteDifferenceFunction< TImageType >::m_ScaleCoefficients[ImageDimension] [protected, inherited]

Definition at line 196 of file itkFiniteDifferenceFunction.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 Sun Sep 23 18:31:30 2007 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000