ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions
itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType > Class Template Reference

#include <itkSegmentationLevelSetFunction.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
InterpolatorType::ContinuousIndexType 
ContinuousIndexType
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::NeighborhoodType 
NeighborhoodType
typedef Superclass::PixelRealType PixelRealType
typedef SmartPointer< SelfPointer
typedef Superclass::RadiusType RadiusType
typedef Superclass::ScalarValueType ScalarValueType
typedef
SegmentationLevelSetFunction 
Self
typedef LevelSetFunction
< TImageType > 
Superclass
typedef Image< VectorType,
itkGetStaticConstMacro(ImageDimension) > 
VectorImageType
typedef
VectorLinearInterpolateImageFunction
< VectorImageType
VectorInterpolatorType
typedef Superclass::VectorType VectorType
- Public Types inherited from itk::LevelSetFunction< TImageType >
typedef
Superclass::NeighborhoodScalesType 
NeighborhoodScalesType
typedef Superclass::PixelType PixelType
typedef double TimeStepType
- Public Types inherited from itk::FiniteDifferenceFunction< TImageType >
typedef
ZeroFluxNeumannBoundaryCondition
< ImageType
DefaultBoundaryConditionType
- Public Types inherited from itk::LightObject

Public Member Functions

virtual void AllocateAdvectionImage ()
virtual void AllocateSpeedImage ()
virtual void CalculateAdvectionImage ()
virtual void CalculateSpeedImage ()
virtual const char * GetNameOfClass () const
virtual void Initialize (const RadiusType &r)
virtual void ReverseExpansionDirection ()
virtual const FeatureImageTypeGetFeatureImage () const
virtual void SetFeatureImage (const FeatureImageType *f)
virtual ImageTypeGetSpeedImage ()
void SetSpeedImage (ImageType *s)
virtual VectorImageTypeGetAdvectionImage () const
void SetAdvectionImage (VectorImageType *s)
- Public Member Functions inherited from itk::LevelSetFunction< TImageType >
virtual ScalarValueType Compute3DMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual ScalarValueType ComputeCurvatureTerm (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual TimeStepType ComputeGlobalTimeStep (void *GlobalData) const
virtual ScalarValueType ComputeMeanCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual ScalarValueType ComputeMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &=FloatOffsetType(0.0))
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual ScalarValueType CurvatureSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual void * GetGlobalDataPointer () const
bool GetUseMinimalCurvature () const
virtual ScalarValueType LaplacianSmoothingSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual void ReleaseGlobalDataPointer (void *GlobalData) const
void SetUseMinimalCurvature (bool b)
void UseMinimalCurvatureOff ()
void UseMinimalCurvatureOn ()
virtual void SetAdvectionWeight (const ScalarValueType a)
ScalarValueType GetAdvectionWeight () const
virtual void SetPropagationWeight (const ScalarValueType p)
ScalarValueType GetPropagationWeight () const
virtual void SetCurvatureWeight (const ScalarValueType c)
ScalarValueType GetCurvatureWeight () const
void SetLaplacianSmoothingWeight (const ScalarValueType c)
ScalarValueType GetLaplacianSmoothingWeight () const
void SetEpsilonMagnitude (const ScalarValueType e)
ScalarValueType GetEpsilonMagnitude () const
- Public Member Functions inherited from itk::FiniteDifferenceFunction< TImageType >
const NeighborhoodScalesType ComputeNeighborhoodScales () const
const RadiusTypeGetRadius () const
virtual void InitializeIteration ()
void SetRadius (const RadiusType &r)
void SetScaleCoefficients (PixelRealType vals[ImageDimension])
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const
virtual void Register () const
virtual void SetReferenceCount (int)
virtual void UnRegister () const

Static Public Attributes

static const unsigned int ImageDimension = Superclass::ImageDimension
- Static Public Attributes inherited from itk::LevelSetFunction< TImageType >
- Static Public Attributes inherited from itk::FiniteDifferenceFunction< TImageType >

Protected Member Functions

virtual VectorType AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const
virtual ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const
 SegmentationLevelSetFunction ()
virtual ~SegmentationLevelSetFunction ()
- Protected Member Functions inherited from itk::LevelSetFunction< TImageType >
 LevelSetFunction ()
void PrintSelf (std::ostream &s, Indent indent) const
virtual ~LevelSetFunction ()
- Protected Member Functions inherited from itk::FiniteDifferenceFunction< TImageType >
 FiniteDifferenceFunction ()
 ~FiniteDifferenceFunction ()
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

Protected Attributes

VectorImageType::Pointer m_AdvectionImage
FeatureImageType::ConstPointer m_FeatureImage
InterpolatorType::Pointer m_Interpolator
ImageType::Pointer m_SpeedImage
Functor::VectorCast< typename
VectorInterpolatorType::OutputType,
VectorType
m_VectorCast
VectorInterpolatorType::Pointer m_VectorInterpolator
- Protected Attributes inherited from itk::LevelSetFunction< TImageType >
ScalarValueType m_AdvectionWeight
OffsetValueType m_Center
ScalarValueType m_CurvatureWeight
ScalarValueType m_EpsilonMagnitude
ScalarValueType m_PropagationWeight
bool m_UseMinimalCurvature
OffsetValueType m_xStride [itkGetStaticConstMacro(ImageDimension)]
std::slice x_slice [itkGetStaticConstMacro(ImageDimension)]
ScalarValueType m_LaplacianSmoothingWeight
- Protected Attributes inherited from itk::FiniteDifferenceFunction< TImageType >
RadiusType m_Radius
PixelRealType m_ScaleCoefficients [ImageDimension]
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock

Private Member Functions

void operator= (const Self &)
 SegmentationLevelSetFunction (const Self &)

Additional Inherited Members

- Static Public Member Functions inherited from itk::LevelSetFunction< TImageType >
static double GetMaximumCurvatureTimeStep ()
static double GetMaximumPropagationTimeStep ()
static Pointer New ()
static void SetMaximumCurvatureTimeStep (double n)
static void SetMaximumPropagationTimeStep (double n)
- Static Protected Member Functions inherited from itk::LevelSetFunction< TImageType >
static VectorType InitializeZeroVectorConstant ()
- Static Protected Attributes inherited from itk::LevelSetFunction< TImageType >
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 47 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

Continuous index type recognized by the interpolator

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

Definition at line 86 of file itkSegmentationLevelSetFunction.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
template<class TImageType , class TFeatureImageType = TImageType>
typedef LinearInterpolateImageFunction< ImageType > itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::InterpolatorType

Define a scalar interpolator

Definition at line 80 of file itkSegmentationLevelSetFunction.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 63 of file itkSegmentationLevelSetFunction.h.

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
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 83 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 70 of file itkSegmentationLevelSetFunction.h.


Constructor & Destructor Documentation

template<class TImageType , class TFeatureImageType = TImageType>
virtual itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::~SegmentationLevelSetFunction ( )
inlineprotectedvirtual

Definition at line 166 of file itkSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::SegmentationLevelSetFunction ( )
inlineprotected

Definition at line 167 of file itkSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::SegmentationLevelSetFunction ( const Self )
private

Member Function Documentation

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

Advection field. Returns a vector from the computed advectionfield.

Reimplemented from itk::LevelSetFunction< TImageType >.

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

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.

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

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::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, and itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 122 of file itkSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::CalculateSpeedImage ( )
inlinevirtual
template<class TImageType , class TFeatureImageType = TImageType>
virtual VectorImageType* itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetAdvectionImage ( ) const
inlinevirtual

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

Definition at line 102 of file itkSegmentationLevelSetFunction.h.

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

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

Definition at line 89 of file itkSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
virtual const char* itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetNameOfClass ( ) const
virtual
template<class TImageType , class TFeatureImageType = TImageType>
virtual ImageType* itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetSpeedImage ( )
inlinevirtual

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

Definition at line 96 of file itkSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::Initialize ( const RadiusType r)
virtual
template<class TImageType , class TFeatureImageType = TImageType>
void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::operator= ( const Self )
private
template<class TImageType , class TFeatureImageType = TImageType>
virtual ScalarValueType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::PropagationSpeed ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct gd 
) const
protectedvirtual

Returns the propagation speed from the precalculated speed image.

Reimplemented from itk::LevelSetFunction< TImageType >.

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

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

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

Definition at line 91 of file itkSegmentationLevelSetFunction.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


Member Data Documentation

template<class TImageType , class TFeatureImageType = TImageType>
const unsigned int itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::ImageDimension = Superclass::ImageDimension
static
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.

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 175 of file itkSegmentationLevelSetFunction.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.

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.


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