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

itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType > Class Template Reference

#include <itkSegmentationLevelSetFunction.h>

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

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

Collaboration graph
[legend]

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
InterpolatorType::ContinuousIndexType 
ContinuousIndexType
typedef
ZeroFluxNeumannBoundaryCondition
< ImageType
DefaultBoundaryConditionType
typedef TFeatureImageType FeatureImageType
typedef FeatureImageType::PixelType FeatureScalarType
typedef Superclass::FloatOffsetType FloatOffsetType
typedef
Superclass::GlobalDataStruct 
GlobalDataStruct
typedef Superclass::ImageType ImageType
typedef ImageType::IndexType IndexType
typedef
LinearInterpolateImageFunction
< ImageType
InterpolatorType
typedef
Superclass::NeighborhoodScalesType 
NeighborhoodScalesType
typedef
Superclass::NeighborhoodType 
NeighborhoodType
typedef Superclass::PixelRealType PixelRealType
typedef Superclass::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef Superclass::RadiusType RadiusType
typedef Superclass::ScalarValueType ScalarValueType
typedef
SegmentationLevelSetFunction 
Self
typedef LevelSetFunction
< TImageType > 
Superclass
typedef double TimeStepType
typedef Image< VectorType,
itkGetStaticConstMacro(ImageDimension)> 
VectorImageType
typedef
VectorLinearInterpolateImageFunction
< VectorImageType
VectorInterpolatorType
typedef Superclass::VectorType VectorType

Public Member Functions

virtual VectorType AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual void AllocateAdvectionImage ()
virtual void AllocateSpeedImage ()
virtual void CalculateAdvectionImage ()
virtual void CalculateSpeedImage ()
virtual ScalarValueType Compute3DMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual TimeStepType ComputeGlobalTimeStep (void *GlobalData) const
virtual ScalarValueType ComputeMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
const NeighborhoodScalesType ComputeNeighborhoodScales () const
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 RadiusTypeGetRadius () const
virtual int GetReferenceCount () const
virtual void Initialize (const RadiusType &r)
virtual void Initialize (const RadiusType &r)
virtual void InitializeIteration ()
 itkStaticConstMacro (ImageDimension, unsigned int, ImageType::ImageDimension)
 itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
virtual ScalarValueType LaplacianSmoothingSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
void Print (std::ostream &os, Indent indent=0) const
virtual ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual void Register () const
virtual void ReleaseGlobalDataPointer (void *GlobalData) const
virtual void ReverseExpansionDirection ()
void SetRadius (const RadiusType &r)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
virtual ScalarValueType ComputeCurvatureTerm (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual ScalarValueType ComputeMeanCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual VectorImageTypeGetAdvectionImage () const
void SetAdvectionImage (VectorImageType *s)
ScalarValueType GetAdvectionWeight () const
virtual void SetAdvectionWeight (const ScalarValueType a)
ScalarValueType GetCurvatureWeight () const
virtual void SetCurvatureWeight (const ScalarValueType c)
ScalarValueType GetEpsilonMagnitude () const
void SetEpsilonMagnitude (const ScalarValueType e)
virtual const FeatureImageTypeGetFeatureImage () const
virtual void SetFeatureImage (const FeatureImageType *f)
virtual void * GetGlobalDataPointer () const
ScalarValueType GetLaplacianSmoothingWeight () const
void SetLaplacianSmoothingWeight (const ScalarValueType c)
ScalarValueType GetPropagationWeight () const
virtual void SetPropagationWeight (const ScalarValueType p)
virtual ImageTypeGetSpeedImage ()
void SetSpeedImage (ImageType *s)
bool GetUseMinimalCurvature () const
void SetUseMinimalCurvature (bool b)
void UseMinimalCurvatureOff ()
void UseMinimalCurvatureOn ()
void SetScaleCoefficients (PixelRealType vals[ImageDimension])

Static Public Member Functions

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

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

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

Static Protected Member Functions

static VectorType InitializeZeroVectorConstant ()

Protected Attributes

VectorImageType::Pointer m_AdvectionImage
ScalarValueType m_AdvectionWeight
::vcl_size_t m_Center
ScalarValueType m_CurvatureWeight
ScalarValueType m_EpsilonMagnitude
FeatureImageType::ConstPointer m_FeatureImage
InterpolatorType::Pointer m_Interpolator
ScalarValueType m_LaplacianSmoothingWeight
ScalarValueType m_PropagationWeight
RadiusType m_Radius
InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
PixelRealType m_ScaleCoefficients [ImageDimension]
ImageType::Pointer m_SpeedImage
bool m_UseMinimalCurvature
Functor::VectorCast< typename
VectorInterpolatorType::OutputType,
VectorType
m_VectorCast
VectorInterpolatorType::Pointer m_VectorInterpolator
::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


Detailed Description

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

This object defines the API for a class of function objects which perform level set based segmentations. The SegmentationLevelSetImageFilter objects use these SegmentationLevelSetFunction objects to perform the numerical calculations which move a level set front to lock onto image features.
In order to create a working function object, you must subclass the CalculateSpeedImage method to produce a "feature image" that is used by the parent LevelSetFunction class as the PropagationSpeed for its calculations.
See also:
SegmentationLevelSetImageFilter

LevelSetFunction

Definition at line 45 of file itkSegmentationLevelSetFunction.h.


Member Typedef Documentation

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

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

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

Definition at line 92 of file itkFiniteDifferenceFunction.h.

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

template<class TImageType, class TFeatureImageType = TImageType>
typedef FeatureImageType::PixelType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::FeatureScalarType

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

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

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

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

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

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

Definition at line 139 of file itkLightObject.h.

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

Define a scalar interpolator

Definition at line 79 of file itkSegmentationLevelSetFunction.h.

The type of data structure that holds the scales with which the neighborhood is weighted to properly account for spacing and neighborhood radius.

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >.

Definition at line 91 of file itkLevelSetFunction.h.

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

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

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 61 of file itkSegmentationLevelSetFunction.h.

typedef Superclass::PixelType itk::LevelSetFunction< TImageType >::PixelType [inherited]

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

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

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

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

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

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

template<class TImageType, class TFeatureImageType = TImageType>
typedef Image<VectorType, itkGetStaticConstMacro(ImageDimension)> itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::VectorImageType

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

Define a vector interpolator

Definition at line 82 of file itkSegmentationLevelSetFunction.h.

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

The vector type that will be used in the calculations.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 68 of file itkSegmentationLevelSetFunction.h.


Constructor & Destructor Documentation

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

Definition at line 167 of file itkSegmentationLevelSetFunction.h.

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

Definition at line 168 of file itkSegmentationLevelSetFunction.h.


Member Function Documentation

virtual VectorType itk::LevelSetFunction< TImageType >::AdvectionField ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct *  = 0 
) const [inline, virtual, inherited]

Advection field. Default implementation returns a vector of zeros.

Definition at line 124 of file itkLevelSetFunction.h.

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

Advection field. Returns a vector from the computed advectionfield.

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

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

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

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

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

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

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

This method must be defined in a subclass to implement a working function object. This method is called before the solver begins its work to produce the speed image used as the level set function's Advection field term. See LevelSetFunction for more information.

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

Definition at line 122 of file itkSegmentationLevelSetFunction.h.

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

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

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

virtual TimeStepType itk::LevelSetFunction< TImageType >::ComputeGlobalTimeStep ( void *  GlobalData  )  const [virtual, inherited]

Computes the time step for an update given a global data structure. The data used in the computation may take different forms depending on the nature of the equations. This global data cannot be kept in the instance of the equation object itself since the equation object must remain stateless for thread safety. The global data is therefore managed for each thread by the finite difference solver filters.

Implements itk::FiniteDifferenceFunction< TImageType >.

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

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

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

const NeighborhoodScalesType itk::FiniteDifferenceFunction< TImageType >::ComputeNeighborhoodScales (  )  const [inherited]

Compute the scales that weight the neighborhood during difference operations to properly account for spacing and neighborhood radius

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

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.

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

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

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

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

Definition at line 101 of file itkSegmentationLevelSetFunction.h.

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

Alpha. Scales all advection term values.

Definition at line 152 of file itkLevelSetFunction.h.

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

Gamma. Scales all curvature weight values

Definition at line 166 of file itkLevelSetFunction.h.

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

Epsilon.

Definition at line 180 of file itkLevelSetFunction.h.

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

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

Definition at line 88 of file itkSegmentationLevelSetFunction.h.

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

Returns a pointer to a global data structure that is passed to this object from the solver at each calculation. The idea is that the solver holds the state of any global values needed to calculate the time step, while the equation object performs the actual calculations. The global data should also be initialized in this method. Global data can be used for caching any values used or reused by the FunctionObject. Each thread should receive its own global data struct.

Implements itk::FiniteDifferenceFunction< TImageType >.

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

Definition at line 204 of file itkLevelSetFunction.h.

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

Weight of the laplacian smoothing term

Definition at line 173 of file itkLevelSetFunction.h.

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

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 274 of file itkLevelSetFunction.h.

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

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 288 of file itkLevelSetFunction.h.

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

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

Beta. Scales all propagation term values.

Definition at line 159 of file itkLevelSetFunction.h.

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

virtual int itk::LightObject::GetReferenceCount (  )  const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

template<class TImageType, class TFeatureImageType = TImageType>
virtual ImageType* itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetSpeedImage (  )  [inline, virtual]

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

Definition at line 95 of file itkSegmentationLevelSetFunction.h.

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

Definition at line 252 of file itkLevelSetFunction.h.

virtual void itk::LevelSetFunction< TImageType >::Initialize ( const RadiusType &  r  )  [virtual, inherited]

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

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

template<class TImageType, class TFeatureImageType = TImageType>
virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::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.

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

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.

Definition at line 118 of file itkFiniteDifferenceFunction.h.

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

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

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

Save image dimension.

template<class TImageType, class TFeatureImageType = TImageType>
itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::itkStaticConstMacro ( ImageDimension  ,
unsigned  int,
Superclass::ImageDimension   
)

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

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

Definition at line 144 of file itkLevelSetFunction.h.

static Pointer itk::LevelSetFunction< TImageType >::New ( void   )  [static, inherited]

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

Cause the object to print itself out.

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

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

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.

void itk::LevelSetFunction< TImageType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

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

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.

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

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

Definition at line 130 of file itkLevelSetFunction.h.

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

Returns the propagation speed from the precalculated speed image.

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

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

Reimplemented in itk::Object.

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

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

Definition at line 223 of file itkLevelSetFunction.h.

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

Determines whether Positive or Negative speed terms will cause surface expansion. This method flips the sign of all of the speed, advection, etc terms. By convention, filters should be written so that POSITIVE speed terms cause surface expansion. Calling this method will toggle between the standard POSITIVE EXPANSION convention and the nonstandard NEGATIVE EXPANSION convention.

IMPORTANT: When adding terms to the level-set equation through subclassing you may need to override this function so that your new terms will be properly adjusted.

template<class TImageType, class TFeatureImageType = TImageType>
void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetAdvectionImage ( VectorImageType s  ) 

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

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

Alpha. Scales all advection term values.

Definition at line 150 of file itkLevelSetFunction.h.

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

Gamma. Scales all curvature weight values

Definition at line 164 of file itkLevelSetFunction.h.

void itk::LevelSetFunction< TImageType >::SetEpsilonMagnitude ( const ScalarValueType  e  )  [inline, inherited]

Epsilon.

Definition at line 178 of file itkLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetFeatureImage ( const FeatureImageType f  )  [inline, virtual]

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

Definition at line 90 of file itkSegmentationLevelSetFunction.h.

void itk::LevelSetFunction< TImageType >::SetLaplacianSmoothingWeight ( const ScalarValueType  c  )  [inline, inherited]

Weight of the laplacian smoothing term

Definition at line 171 of file itkLevelSetFunction.h.

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

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 270 of file itkLevelSetFunction.h.

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

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 284 of file itkLevelSetFunction.h.

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

Beta. Scales all propagation term values.

Definition at line 157 of file itkLevelSetFunction.h.

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

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

template<class TImageType, class TFeatureImageType = TImageType>
void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetSpeedImage ( ImageType s  ) 

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

void itk::LevelSetFunction< TImageType >::SetUseMinimalCurvature ( bool  b  )  [inline, inherited]

Definition at line 248 of file itkLevelSetFunction.h.

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

Decrease the reference count (release by another object).

Reimplemented in itk::Object.

void itk::LevelSetFunction< TImageType >::UseMinimalCurvatureOff (  )  [inline, inherited]

Definition at line 260 of file itkLevelSetFunction.h.

void itk::LevelSetFunction< TImageType >::UseMinimalCurvatureOn (  )  [inline, inherited]

Definition at line 256 of file itkLevelSetFunction.h.


Member Data Documentation

template<class TImageType, class TFeatureImageType = TImageType>
VectorImageType::Pointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_AdvectionImage [protected]

The image holding the advection field for front propation

Definition at line 152 of file itkSegmentationLevelSetFunction.h.

ScalarValueType itk::LevelSetFunction< TImageType >::m_AdvectionWeight [protected, inherited]

Alpha.

Definition at line 332 of file itkLevelSetFunction.h.

:: vcl_size_t itk::LevelSetFunction< TImageType >::m_Center [protected, inherited]

The offset of the center pixel in the neighborhood.

Definition at line 314 of file itkLevelSetFunction.h.

ScalarValueType itk::LevelSetFunction< TImageType >::m_CurvatureWeight [protected, inherited]

Gamma.

Definition at line 338 of file itkLevelSetFunction.h.

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

Definition at line 308 of file itkLevelSetFunction.h.

ScalarValueType itk::LevelSetFunction< TImageType >::m_EpsilonMagnitude [protected, inherited]

Epsilon magnitude controls the lower limit for gradient magnitude.

Definition at line 329 of file itkLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
FeatureImageType::ConstPointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_FeatureImage [protected]

The image whose features will be used to create a speed image

Definition at line 146 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
InterpolatorType::Pointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Interpolator [protected]

Definition at line 176 of file itkSegmentationLevelSetFunction.h.

ScalarValueType itk::LevelSetFunction< TImageType >::m_LaplacianSmoothingWeight [protected, inherited]

Laplacean smoothing term

Definition at line 341 of file itkLevelSetFunction.h.

ScalarValueType itk::LevelSetFunction< TImageType >::m_PropagationWeight [protected, inherited]

Beta.

Definition at line 335 of file itkLevelSetFunction.h.

RadiusType itk::FiniteDifferenceFunction< TImageType >::m_Radius [protected, inherited]

Definition at line 203 of file itkFiniteDifferenceFunction.h.

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

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

Definition at line 204 of file itkFiniteDifferenceFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
ImageType::Pointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_SpeedImage [protected]

The image holding the speed values for front propagation

Definition at line 149 of file itkSegmentationLevelSetFunction.h.

bool itk::LevelSetFunction< TImageType >::m_UseMinimalCurvature [protected, inherited]

Definition at line 319 of file itkLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
Functor::VectorCast< typename VectorInterpolatorType::OutputType, VectorType > itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_VectorCast [protected]

A casting functor to convert between vector types.

Definition at line 156 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>
VectorInterpolatorType::Pointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_VectorInterpolator [protected]

Definition at line 177 of file itkSegmentationLevelSetFunction.h.

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

Constants used in the time step calculation.

Definition at line 307 of file itkLevelSetFunction.h.

:: vcl_size_t itk::LevelSetFunction< TImageType >::m_xStride[itkGetStaticConstMacro(ImageDimension)] [protected, inherited]

Stride length along the y-dimension.

Definition at line 317 of file itkLevelSetFunction.h.

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

Zero vector constant.

Definition at line 326 of file itkLevelSetFunction.h.

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

Slices for the ND neighborhood.

Definition at line 311 of file itkLevelSetFunction.h.


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

Generated at Tue Sep 15 12:31:57 2009 for ITK by doxygen 1.5.8 written by Dimitri van Heesch, © 1997-2000