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

#include <itkLevelSetFunctionBase.h>

Inheritance diagram for itk::LevelSetFunctionBase:

[legend]Collaboration diagram for itk::LevelSetFunctionBase< TImageType >:

[legend]List of all members.

Public Types
typedef LevelSetFunctionBase	Self
typedef FiniteDifferenceFunction< TImageType >	Superclass
typedef SmartPointer< Self >	Pointer
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::BoundaryNeighborhoodType	BoundaryNeighborhoodType
typedef Superclass::FloatOffsetType	FloatOffsetType
typedef Vector< ScalarValueType, itkGetStaticConstMacro(ImageDimension)	VectorType )
Public Methods
virtual const char *	GetClassName () const
	itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
virtual ScalarValueType	CurvatureSpeed (const NeighborhoodType &neighborhood, const FloatOffsetType &) const
virtual ScalarValueType	CurvatureSpeed (const BoundaryNeighborhoodType &neighborhood, const FloatOffsetType &) const
virtual void	Initialize (const RadiusType &r)=0
virtual VectorType	AdvectionField (const NeighborhoodType &neighborhood, const FloatOffsetType &) const
virtual VectorType	AdvectionField (const BoundaryNeighborhoodType &neighborhood, const FloatOffsetType &) const
virtual ScalarValueType	PropagationSpeed (const NeighborhoodType &neighborhood, const FloatOffsetType) const
virtual ScalarValueType	PropagationSpeed (const BoundaryNeighborhoodType &neighborhood, const FloatOffsetType &) const
void	SetAdvectionWeight (const ScalarValueType a)
ScalarValueType	GetAdvectionWeight () const
void	SetPropagationWeight (const ScalarValueType p)
ScalarValueType	GetPropagationWeight () const
void	SetCurvatureWeight (const ScalarValueType c)
ScalarValueType	GetCurvatureWeight () const
void	SetEpsilonMagnitude (const ScalarValueType e)
ScalarValueType	GetEpsilonMagnitude () const
Protected Methods
	LevelSetFunctionBase ()
	~LevelSetFunctionBase ()
void	PrintSelf (std::ostream &os, Indent indent) const
Static Protected Methods
VectorType	InitializeZeroVectorConstant ()
Protected Attributes
ScalarValueType	m_EpsilonMagnitude
ScalarValueType	m_AdvectionWeight
ScalarValueType	m_PropagationWeight
ScalarValueType	m_CurvatureWeight
Static Protected Attributes
VectorType	m_ZeroVectorConstant

---

Detailed Description

template<class TImageType>
class itk::LevelSetFunctionBase< TImageType >

This class is a base class for the LeveSetFunction object. See LevelSetFunction object for complete information.

Definition at line 34 of file itkLevelSetFunctionBase.h.

---

Member Typedef Documentation

template<class TImageType> typedef Superclass::BoundaryNeighborhoodType itk::LevelSetFunctionBase< TImageType >::BoundaryNeighborhoodType

The type of data structure that is passed to this function object to evaluate at a pixel that lies on a data set boundary. Reimplemented from itk::FiniteDifferenceFunction< TImageType >. Reimplemented in itk::LevelSetFunction< TImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TOutputImage >, and itk::SegmentationLevelSetFunction< TOutputImage >. Definition at line 57 of file itkLevelSetFunctionBase.h. Referenced by itk::LevelSetFunctionBase< TOutputImage >::AdvectionField(), and itk::LevelSetFunctionBase< TOutputImage >::PropagationSpeed().

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

Reimplemented from itk::FiniteDifferenceFunction< TImageType >. Reimplemented in itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TOutputImage >, and itk::SegmentationLevelSetFunction< TOutputImage >. Definition at line 41 of file itkLevelSetFunctionBase.h.

template<class TImageType> typedef Superclass::FloatOffsetType itk::LevelSetFunctionBase< 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::LevelSetFunction< TImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TOutputImage >, and itk::SegmentationLevelSetFunction< TOutputImage >. Definition at line 58 of file itkLevelSetFunctionBase.h. Referenced by itk::LevelSetFunctionBase< TOutputImage >::AdvectionField(), and itk::LevelSetFunctionBase< TOutputImage >::PropagationSpeed().

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

Extract some parameters from the image type Reimplemented from itk::FiniteDifferenceFunction< TImageType >. Reimplemented in itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TOutputImage >, and itk::SegmentationLevelSetFunction< TOutputImage >. Definition at line 51 of file itkLevelSetFunctionBase.h.

template<class TImageType> typedef Superclass::NeighborhoodType itk::LevelSetFunctionBase< 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::LevelSetFunction< TImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TOutputImage >, and itk::SegmentationLevelSetFunction< TOutputImage >. Definition at line 55 of file itkLevelSetFunctionBase.h. Referenced by itk::LevelSetFunctionBase< TOutputImage >::AdvectionField(), and itk::LevelSetFunctionBase< TOutputImage >::PropagationSpeed().

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

Reimplemented from itk::FiniteDifferenceFunction< TImageType >. Reimplemented in itk::LevelSetFunction< TImageType >, and itk::LevelSetFunction< TOutputImage >. Definition at line 52 of file itkLevelSetFunctionBase.h.

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

Reimplemented from itk::FiniteDifferenceFunction< TImageType >. Reimplemented in itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TOutputImage >, and itk::SegmentationLevelSetFunction< TOutputImage >. Definition at line 40 of file itkLevelSetFunctionBase.h.

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

Neighborhood radius type Reimplemented from itk::FiniteDifferenceFunction< TImageType >. Reimplemented in itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TOutputImage >, and itk::SegmentationLevelSetFunction< TOutputImage >. Definition at line 54 of file itkLevelSetFunctionBase.h. Referenced by itk::LevelSetFunctionBase< TOutputImage >::SetEpsilonMagnitude().

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

Reimplemented in itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TOutputImage >, and itk::SegmentationLevelSetFunction< TOutputImage >. Definition at line 53 of file itkLevelSetFunctionBase.h. Referenced by itk::LevelSetFunctionBase< TOutputImage >::GetAdvectionWeight(), itk::LevelSetFunctionBase< TOutputImage >::GetCurvatureWeight(), itk::LevelSetFunctionBase< TOutputImage >::SetAdvectionWeight(), and itk::LevelSetFunctionBase< TOutputImage >::~LevelSetFunctionBase().

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

Standard class typedefs. Reimplemented from itk::FiniteDifferenceFunction< TImageType >. Reimplemented in itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TOutputImage >, and itk::SegmentationLevelSetFunction< TOutputImage >. Definition at line 38 of file itkLevelSetFunctionBase.h.

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

Reimplemented from itk::FiniteDifferenceFunction< TImageType >. Reimplemented in itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TOutputImage >, and itk::SegmentationLevelSetFunction< TOutputImage >. Definition at line 39 of file itkLevelSetFunctionBase.h.

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

Extract some parameters from the image type. Reimplemented from itk::FiniteDifferenceFunction< TImageType >. Reimplemented in itk::LevelSetFunction< TImageType >, and itk::LevelSetFunction< TOutputImage >. Definition at line 50 of file itkLevelSetFunctionBase.h.

template<class TImageType> typedef Vector<ScalarValueType, itkGetStaticConstMacro(ImageDimension) itk::LevelSetFunctionBase< TImageType >::VectorType)

The vector type that will be used in the calculations. Reimplemented in itk::LevelSetFunction< TImageType >, and itk::LevelSetFunction< TOutputImage >. Definition at line 62 of file itkLevelSetFunctionBase.h.

---

Constructor & Destructor Documentation

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

Definition at line 129 of file itkLevelSetFunctionBase.h.

template<class TImageType> itk::LevelSetFunctionBase< TImageType >::~LevelSetFunctionBase (    )  [inline, protected]

Definition at line 135 of file itkLevelSetFunctionBase.h.

---

Member Function Documentation

template<class TImageType> virtual VectorType itk::LevelSetFunctionBase< TImageType >::AdvectionField (  const BoundaryNeighborhoodType &    neighborhood, const FloatOffsetType &    )  const [inline, virtual]

Advection field. Default implementation returns a vector of zeros. Definition at line 68 of file itkLevelSetFunctionBase.h.

template<class TImageType> virtual VectorType itk::LevelSetFunctionBase< TImageType >::AdvectionField (  const NeighborhoodType &    neighborhood, const FloatOffsetType &    )  const [inline, virtual]

Advection field. Default implementation returns a vector of zeros. Definition at line 65 of file itkLevelSetFunctionBase.h.

template<class TImageType> virtual ScalarValueType itk::LevelSetFunctionBase< TImageType >::CurvatureSpeed (  const BoundaryNeighborhoodType &    neighborhood, const FloatOffsetType &    )  const [inline, virtual]

Definition at line 93 of file itkLevelSetFunctionBase.h.

template<class TImageType> virtual ScalarValueType itk::LevelSetFunctionBase< TImageType >::CurvatureSpeed (  const NeighborhoodType &    neighborhood, const FloatOffsetType &    )  const [inline, virtual]

Curvature speed. Can be used to spatially modify the effects of curvature . The default implementation returns one. Definition at line 88 of file itkLevelSetFunctionBase.h.

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

Alpha. Scales all advection term values. Definition at line 101 of file itkLevelSetFunctionBase.h.

template<class TImageType> virtual const char* itk::LevelSetFunctionBase< TImageType >::GetClassName (    )  const [virtual]

Run-time type information (and related methods) Reimplemented from itk::FiniteDifferenceFunction< TImageType >. Reimplemented in itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TOutputImage >, and itk::SegmentationLevelSetFunction< TOutputImage >.

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

Gamma. Scales all curvature weight values Definition at line 115 of file itkLevelSetFunctionBase.h.

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

Epsilon. Definition at line 122 of file itkLevelSetFunctionBase.h.

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

Beta. Scales all propagation term values. Definition at line 108 of file itkLevelSetFunctionBase.h.

template<class TImageType> virtual void itk::LevelSetFunctionBase< TImageType >::Initialize (  const RadiusType &    r )  [pure virtual]

Implemented in itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TOutputImage >, and itk::SegmentationLevelSetFunction< TOutputImage >.

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

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

template<class TImageType> itk::LevelSetFunctionBase< TImageType >::itkStaticConstMacro (  ImageDimension   , unsigned    int, Superclass::ImageDimension    )

The image dimension. Reimplemented in itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TOutputImage >, and itk::SegmentationLevelSetFunction< TOutputImage >.

template<class TImageType> void itk::LevelSetFunctionBase< TImageType >::PrintSelf (  std::ostream &    os, 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::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TImageType >, and itk::LevelSetFunction< TOutputImage >.

template<class TImageType> virtual ScalarValueType itk::LevelSetFunctionBase< TImageType >::PropagationSpeed (  const BoundaryNeighborhoodType &    neighborhood, const FloatOffsetType &    )  const [inline, virtual]

Propagation speed. This term controls surface expansion/contraction. Default implementation returns zero. Reimplemented in itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::SegmentationLevelSetFunction< TOutputImage >. Definition at line 80 of file itkLevelSetFunctionBase.h.

template<class TImageType> virtual ScalarValueType itk::LevelSetFunctionBase< TImageType >::PropagationSpeed (  const NeighborhoodType &    neighborhood, const    FloatOffsetType )  const [inline, virtual]

Propagation speed. This term controls surface expansion/contraction. Default implementation returns zero. Reimplemented in itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::SegmentationLevelSetFunction< TOutputImage >. Definition at line 76 of file itkLevelSetFunctionBase.h.

template<class TImageType> void itk::LevelSetFunctionBase< TImageType >::SetAdvectionWeight (  const ScalarValueType    a )  [inline]

Alpha. Scales all advection term values. Definition at line 99 of file itkLevelSetFunctionBase.h.

template<class TImageType> void itk::LevelSetFunctionBase< TImageType >::SetCurvatureWeight (  const ScalarValueType    c )  [inline]

Gamma. Scales all curvature weight values Definition at line 113 of file itkLevelSetFunctionBase.h.

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

Epsilon. Definition at line 120 of file itkLevelSetFunctionBase.h.

template<class TImageType> void itk::LevelSetFunctionBase< TImageType >::SetPropagationWeight (  const ScalarValueType    p )  [inline]

Beta. Scales all propagation term values. Definition at line 106 of file itkLevelSetFunctionBase.h.

---

Member Data Documentation

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

Alpha. Definition at line 150 of file itkLevelSetFunctionBase.h. Referenced by itk::LevelSetFunctionBase< TOutputImage >::GetEpsilonMagnitude(), and itk::LevelSetFunctionBase< TOutputImage >::SetAdvectionWeight().

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

Gamma. Definition at line 156 of file itkLevelSetFunctionBase.h. Referenced by itk::LevelSetFunctionBase< TOutputImage >::GetEpsilonMagnitude().

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

Epsilon magnitude controls the lower limit for gradient magnitude. Definition at line 147 of file itkLevelSetFunctionBase.h. Referenced by itk::LevelSetFunctionBase< TOutputImage >::GetCurvatureWeight(), itk::LevelSetFunctionBase< TOutputImage >::GetEpsilonMagnitude(), and itk::LevelSetFunctionBase< TOutputImage >::~LevelSetFunctionBase().

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

Beta. Definition at line 153 of file itkLevelSetFunctionBase.h. Referenced by itk::LevelSetFunctionBase< TOutputImage >::GetAdvectionWeight(), itk::LevelSetFunctionBase< TOutputImage >::GetEpsilonMagnitude(), and itk::LevelSetFunctionBase< TOutputImage >::SetPropagationWeight().

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

Zero vector constant. Definition at line 144 of file itkLevelSetFunctionBase.h. Referenced by itk::LevelSetFunctionBase< TOutputImage >::AdvectionField(), and itk::LevelSetFunctionBase< TOutputImage >::~LevelSetFunctionBase().

---

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

• itkLevelSetFunctionBase.h

---