ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType > Class Template Reference

#include <itkGeodesicActiveContourLevelSetFunction.h>

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

Detailed Description

template<typename TImageType, typename TFeatureImageType = TImageType>
class itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >

This function is used in GeodesicActiveContourLevelSetImageFilter to segment structures in an image based on a user supplied edge potential map.

IMPORTANT
The LevelSetFunction class contain additional information necessary to gain full understanding of how to use this function.

GeodesicActiveContourLevelSetFunction is a subclass of the generic LevelSetFunction. It is used to segment structures in an image based on a user supplied edge potential map $ g(I) $, which has values close to zero in regions near edges (or high image gradient) and values close to one in regions with relatively constant intensity. Typically, the edge potential map is a function of the gradient, for example:

\[ g(I) = 1 / ( 1 + | (\nabla * G)(I)| ) \]

\[ g(I) = \exp^{-|(\nabla * G)(I)|} \]

where $ I $ is image intensity and $ (\nabla * G) $ is the derivative of Gaussian operator.

The edge potential image is set via the SetFeatureImage() method.

In this function both the propagation term $ P(\mathbf{x}) $ and the curvature spatial modifier term $ Z(\mathbf{x}) $ are taken directly from the edge potential image such that:

\[ P(\mathbf{x}) = g(\mathbf{x}) \]

\[ Z(\mathbf{x}) = g(\mathbf{x}) \]

An advection term $ \mathbf{A}(\mathbf{x}) $ is constructed from the negative gradient of the edge potential image.

\[ \mathbf{A}(\mathbf{x}) = -\nabla g(\mathbf{x}) \]

This term behaves like a doublet attracting the contour to the edges.

This implementation is based on: "Geodesic Active Contours", V. Caselles, R. Kimmel and G. Sapiro. International Journal on Computer Vision, Vol 22, No. 1, pp 61-97, 1997

See Also
LevelSetFunction
SegmentationLevelSetImageFunction
GeodesicActiveContourLevelSetImageFilter

Definition at line 77 of file itkGeodesicActiveContourLevelSetFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef TFeatureImageType FeatureImageType
 
typedef
Superclass::FeatureScalarType 
FeatureScalarType
 
typedef Superclass::FloatOffsetType FloatOffsetType
 
typedef
Superclass::GlobalDataStruct 
GlobalDataStruct
 
typedef Superclass::ImageType ImageType
 
typedef
Superclass::NeighborhoodType 
NeighborhoodType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::RadiusType RadiusType
 
typedef Superclass::ScalarValueType ScalarValueType
 
typedef
GeodesicActiveContourLevelSetFunction 
Self
 
typedef
SegmentationLevelSetFunction
< TImageType,
TFeatureImageType > 
Superclass
 
typedef Superclass::VectorImageType VectorImageType
 
- Public Types inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
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 SmartPointer< const SelfConstPointer
 
typedef Superclass::FloatOffsetType FloatOffsetType
 
typedef Superclass::ImageType ImageType
 
typedef
Superclass::NeighborhoodScalesType 
NeighborhoodScalesType
 
typedef
Superclass::NeighborhoodType 
NeighborhoodType
 
typedef Superclass::PixelRealType PixelRealType
 
typedef Superclass::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::RadiusType RadiusType
 
typedef PixelType ScalarValueType
 
typedef LevelSetFunction Self
 
typedef
FiniteDifferenceFunction
< TImageType > 
Superclass
 
typedef double TimeStepType
 
typedef FixedArray
< ScalarValueType,
itkGetStaticConstMacro(ImageDimension) > 
VectorType
 
- Public Types inherited from itk::FiniteDifferenceFunction< TImageType >
typedef SmartPointer< const SelfConstPointer
 
typedef
ZeroFluxNeumannBoundaryCondition
< ImageType
DefaultBoundaryConditionType
 
typedef Vector< float,
itkGetStaticConstMacro(ImageDimension) > 
FloatOffsetType
 
typedef TImageType ImageType
 
typedef Vector< PixelRealType,
itkGetStaticConstMacro(ImageDimension) > 
NeighborhoodScalesType
 
typedef
ConstNeighborhoodIterator
< TImageType,
DefaultBoundaryConditionType
NeighborhoodType
 
typedef double PixelRealType
 
typedef ImageType::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef
ConstNeighborhoodIterator
< TImageType >::RadiusType 
RadiusType
 
typedef FiniteDifferenceFunction Self
 
typedef LightObject Superclass
 
typedef double TimeStepType
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual void CalculateAdvectionImage () override
 
virtual void CalculateSpeedImage () override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual ScalarValueType CurvatureSpeed (const NeighborhoodType &neighborhood, const FloatOffsetType &offset, GlobalDataStruct *gd) const override
 
virtual const char * GetNameOfClass () const
 
virtual void Initialize (const RadiusType &r) override
 
void SetDerivativeSigma (const double v)
 
double GetDerivativeSigma ()
 
- Public Member Functions inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
virtual void AllocateAdvectionImage ()
 
virtual void AllocateSpeedImage ()
 
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 override
 
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)) override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual ScalarValueType CurvatureSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
virtual void * GetGlobalDataPointer () const override
 
bool GetUseMinimalCurvature () const
 
virtual ScalarValueType LaplacianSmoothingSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
virtual void ReleaseGlobalDataPointer (void *GlobalData) const override
 
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
 
void GetScaleCoefficients (PixelRealType vals[ImageDimension]) 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 noexcept
 

Static Public Member Functions

static Pointer New ()
 
- 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 Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

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

Protected Member Functions

 GeodesicActiveContourLevelSetFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~GeodesicActiveContourLevelSetFunction () override
 
- Protected Member Functions inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
virtual VectorType AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const override
 
virtual ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const override
 
 SegmentationLevelSetFunction ()
 
virtual ~SegmentationLevelSetFunction () override
 
- Protected Member Functions inherited from itk::LevelSetFunction< TImageType >
 LevelSetFunction ()
 
void PrintSelf (std::ostream &s, Indent indent) const override
 
virtual ~LevelSetFunction () override
 
- Protected Member Functions inherited from itk::FiniteDifferenceFunction< TImageType >
 FiniteDifferenceFunction ()
 
 ~FiniteDifferenceFunction () override
 
- 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 ()
 

Private Attributes

double m_DerivativeSigma
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::LevelSetFunction< TImageType >
static VectorType InitializeZeroVectorConstant ()
 
- Protected Attributes inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
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_LaplacianSmoothingWeight
 
ScalarValueType m_PropagationWeight
 
bool m_UseMinimalCurvature
 
OffsetValueType m_xStride [itkGetStaticConstMacro(ImageDimension)]
 
std::slice x_slice [itkGetStaticConstMacro(ImageDimension)]
 
- Protected Attributes inherited from itk::FiniteDifferenceFunction< TImageType >
RadiusType m_Radius
 
PixelRealType m_ScaleCoefficients [ImageDimension]
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 
- Static Protected Attributes inherited from itk::LevelSetFunction< TImageType >
static double m_DT
 
static double m_WaveDT
 
static VectorType m_ZeroVectorConstant
 

Member Typedef Documentation

template<typename TImageType , typename TFeatureImageType = TImageType>
typedef SmartPointer< const Self > itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::ConstPointer

Definition at line 86 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
typedef TFeatureImageType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::FeatureImageType

Definition at line 87 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
typedef Superclass::FeatureScalarType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::FeatureScalarType

Definition at line 99 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
typedef Superclass::FloatOffsetType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::FloatOffsetType

Definition at line 101 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
typedef Superclass::GlobalDataStruct itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::GlobalDataStruct

Definition at line 103 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
typedef Superclass::ImageType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::ImageType

Extract some parameters from the superclass.

Definition at line 93 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
typedef Superclass::NeighborhoodType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::NeighborhoodType

Definition at line 97 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
typedef SmartPointer< Self > itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::Pointer

Definition at line 85 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
typedef Superclass::RadiusType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::RadiusType

Definition at line 100 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
typedef Superclass::ScalarValueType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::ScalarValueType

Definition at line 98 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
typedef GeodesicActiveContourLevelSetFunction itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::Self

Standard class typedefs.

Definition at line 82 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
typedef SegmentationLevelSetFunction< TImageType, TFeatureImageType > itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::Superclass

Definition at line 84 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
typedef Superclass::VectorImageType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::VectorImageType

Definition at line 102 of file itkGeodesicActiveContourLevelSetFunction.h.

Constructor & Destructor Documentation

template<typename TImageType , typename TFeatureImageType = TImageType>
itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::GeodesicActiveContourLevelSetFunction ( )
inlineprotected

Definition at line 140 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
virtual itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::~GeodesicActiveContourLevelSetFunction ( )
inlineoverrideprotectedvirtual

Definition at line 149 of file itkGeodesicActiveContourLevelSetFunction.h.

Member Function Documentation

template<typename TImageType , typename TFeatureImageType = TImageType>
virtual void itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::CalculateAdvectionImage ( )
overridevirtual

Compute the advection field from feature image.

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

template<typename TImageType , typename TFeatureImageType = TImageType>
virtual void itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::CalculateSpeedImage ( )
overridevirtual

Compute speed image from feature image.

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

template<typename TImageType , typename TFeatureImageType = TImageType>
virtual::itk::LightObject::Pointer itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::CreateAnother ( ) const
virtual

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 from itk::LightObject.

template<typename TImageType , typename TFeatureImageType = TImageType>
virtual ScalarValueType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::CurvatureSpeed ( const NeighborhoodType neighborhood,
const FloatOffsetType offset,
GlobalDataStruct gd 
) const
inlineoverridevirtual

The curvature speed is same as the propagation speed.

Definition at line 116 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
double itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::GetDerivativeSigma ( )
inline

Set/Get the sigma for the Gaussian kernel used to compute the gradient of the feature image needed for the advection term of the equation.

Definition at line 126 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
virtual const char* itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

template<typename TImageType , typename TFeatureImageType = TImageType>
virtual void itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::Initialize ( const RadiusType r)
inlineoverridevirtual

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

Definition at line 130 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
static Pointer itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::New ( )
static

Method for creation through the object factory.

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::SetDerivativeSigma ( const double  v)
inline

Set/Get the sigma for the Gaussian kernel used to compute the gradient of the feature image needed for the advection term of the equation.

Definition at line 124 of file itkGeodesicActiveContourLevelSetFunction.h.

Member Data Documentation

template<typename TImageType , typename TFeatureImageType = TImageType>
const unsigned int itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::ImageDimension = Superclass::ImageDimension
static

Extract some parameters from the superclass.

Definition at line 107 of file itkGeodesicActiveContourLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>
double itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::m_DerivativeSigma
private

Definition at line 156 of file itkGeodesicActiveContourLevelSetFunction.h.


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