#include <itkGeodesicActiveContourLevelSetFunction.h>

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 [20].

See also: LevelSetFunction; SegmentationLevelSetImageFunction; GeodesicActiveContourLevelSetImageFilter

Definition at line 73 of file itkGeodesicActiveContourLevelSetFunction.h.

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

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

Public Types
using	ConstPointer = SmartPointer<const Self>

using	FeatureImageType = TFeatureImageType

using	FeatureScalarType

using	Pointer = SmartPointer<Self>

using	Self = GeodesicActiveContourLevelSetFunction

using	Superclass = SegmentationLevelSetFunction<TImageType, TFeatureImageType>

using	VectorImageType

Public Types inherited from itk::SegmentationLevelSetFunction< TImageType, TImageType >
using	ConstPointer

using	ContinuousIndexType

using	FeatureImageType

using	FeatureScalarType

typedef Vector< float, Self::ImageDimension >	FloatOffsetType

using	FloatOffsetType

typedef TImageType	ImageType

using	ImageType

using	IndexType

using	InterpolatorType

typedef ConstNeighborhoodIterator< TImageType, DefaultBoundaryConditionType >	NeighborhoodType

using	NeighborhoodType

typedef double	PixelRealType

using	PixelRealType

using	Pointer

typedef typename ConstNeighborhoodIterator< TImageType >::RadiusType	RadiusType

using	RadiusType

typedef PixelType	ScalarValueType

using	ScalarValueType

using	Self

using	Superclass

using	VectorImageType

using	VectorInterpolatorType

typedef FixedArray< ScalarValueType, Self::ImageDimension >	VectorType

using	VectorType

Public Types inherited from itk::LevelSetFunction< TImageType >
using	ConstPointer = SmartPointer<const Self>

using	FloatOffsetType

using	ImageType

using	NeighborhoodScalesType

using	NeighborhoodType

using	PixelRealType

using	PixelType

using	Pointer = SmartPointer<Self>

using	RadiusType

using	ScalarValueType = PixelType

using	Self = LevelSetFunction

using	Superclass = FiniteDifferenceFunction<TImageType>

using	TimeStepType = double

using	VectorType = FixedArray<ScalarValueType, Self::ImageDimension>

Public Types inherited from itk::FiniteDifferenceFunction< TImageType >
using	ConstPointer = SmartPointer<const Self>

using	DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition<ImageType>

using	FloatOffsetType = Vector<float, Self::ImageDimension>

using	ImageType = TImageType

using	NeighborhoodScalesType = Vector<PixelRealType, Self::ImageDimension>

using	NeighborhoodType = ConstNeighborhoodIterator<TImageType, DefaultBoundaryConditionType>

using	PixelRealType = double

using	PixelType = typename ImageType::PixelType

using	Pointer = SmartPointer<Self>

using	RadiusType = typename ConstNeighborhoodIterator<TImageType>::RadiusType

using	Self = FiniteDifferenceFunction

using	Superclass = LightObject

using	TimeStepType = double

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = LightObject

Public Member Functions
void	CalculateAdvectionImage () override

void	CalculateSpeedImage () override

virtual::itk::LightObject::Pointer	CreateAnother () const

ScalarValueType	CurvatureSpeed (const NeighborhoodType &neighborhood, const FloatOffsetType &offset, GlobalDataStruct *gd) const override

const char *	GetNameOfClass () const override

void	Initialize (const RadiusType &r) override


void	SetDerivativeSigma (const double v)

double	GetDerivativeSigma ()

Public Member Functions inherited from itk::SegmentationLevelSetFunction< TImageType, TImageType >
virtual void	AllocateAdvectionImage ()

virtual void	AllocateSpeedImage ()

const char *	GetNameOfClass () const override

void	Initialize (const RadiusType &r) override

virtual void	ReverseExpansionDirection ()

virtual const FeatureImageType *	GetFeatureImage () const

virtual void	SetFeatureImage (const FeatureImageType *f)

virtual ImageType *	GetSpeedImage ()

void	SetSpeedImage (ImageType *s)

virtual VectorImageType *	GetAdvectionImage () 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)

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)

PixelType	ComputeUpdate (const NeighborhoodType &it, void *globalData, const FloatOffsetType &=FloatOffsetType(0.0)) override

virtual::itk::LightObject::Pointer	CreateAnother () const

void *	GetGlobalDataPointer () const override

bool	GetUseMinimalCurvature () const

virtual ScalarValueType	LaplacianSmoothingSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const

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 RadiusType &	GetRadius () const

void	GetScaleCoefficients (PixelRealType vals[ImageDimension]) const

virtual void	InitializeIteration ()

void	SetRadius (const RadiusType &r)

void	SetScaleCoefficients (const PixelRealType vals[ImageDimension])

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

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 constexpr unsigned int	ImageDimension = Superclass::ImageDimension

Static Public Attributes inherited from itk::SegmentationLevelSetFunction< TImageType, TImageType >
static constexpr unsigned int	ImageDimension

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

Static Public Attributes inherited from itk::FiniteDifferenceFunction< TImageType >
static constexpr unsigned int	ImageDimension = ImageType::ImageDimension

Protected Member Functions
	GeodesicActiveContourLevelSetFunction ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~GeodesicActiveContourLevelSetFunction () override=default

Protected Member Functions inherited from itk::SegmentationLevelSetFunction< TImageType, TImageType >
VectorType	AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const override

ScalarValueType	PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const override

	SegmentationLevelSetFunction ()

	~SegmentationLevelSetFunction () override=default

Protected Member Functions inherited from itk::LevelSetFunction< TImageType >
	LevelSetFunction ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~LevelSetFunction () override=default

Protected Member Functions inherited from itk::FiniteDifferenceFunction< TImageType >
	FiniteDifferenceFunction ()

	~FiniteDifferenceFunction () override=default

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, TImageType >
VectorImageType::Pointer	m_AdvectionImage

FeatureImageType::ConstPointer	m_FeatureImage

InterpolatorType::Pointer	m_Interpolator

ImageType::Pointer	m_SpeedImage

VectorInterpolatorType::Pointer	m_VectorInterpolator

Protected Attributes inherited from itk::LevelSetFunction< TImageType >
ScalarValueType	m_AdvectionWeight {}

OffsetValueType	m_Center { 0 }

ScalarValueType	m_CurvatureWeight {}

ScalarValueType	m_EpsilonMagnitude {}

ScalarValueType	m_LaplacianSmoothingWeight {}

ScalarValueType	m_PropagationWeight {}

bool	m_UseMinimalCurvature { false }

OffsetValueType	m_xStride [Self::ImageDimension] {}

std::slice	x_slice [Self::ImageDimension]

Protected Attributes inherited from itk::FiniteDifferenceFunction< TImageType >
RadiusType	m_Radius {}

PixelRealType	m_ScaleCoefficients [ImageDimension] {}

Protected Attributes inherited from itk::LightObject
std::atomic< 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

◆ ConstPointer

template<typename TImageType, typename TFeatureImageType = TImageType>

using itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::ConstPointer = SmartPointer<const Self>

Definition at line 83 of file itkGeodesicActiveContourLevelSetFunction.h.

◆ FeatureImageType

template<typename TImageType, typename TFeatureImageType = TImageType>

using itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::FeatureImageType = TFeatureImageType

Definition at line 84 of file itkGeodesicActiveContourLevelSetFunction.h.

◆ FeatureScalarType

template<typename TImageType, typename TFeatureImageType = TImageType>

using itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::FeatureScalarType

Definition at line 69 of file itkSegmentationLevelSetFunction.h.

◆ Pointer

template<typename TImageType, typename TFeatureImageType = TImageType>

using itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::Pointer = SmartPointer<Self>

Definition at line 82 of file itkGeodesicActiveContourLevelSetFunction.h.

◆ Self

template<typename TImageType, typename TFeatureImageType = TImageType>

using itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::Self = GeodesicActiveContourLevelSetFunction

Standard class type aliases.

Definition at line 80 of file itkGeodesicActiveContourLevelSetFunction.h.

◆ Superclass

template<typename TImageType, typename TFeatureImageType = TImageType>

using itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::Superclass = SegmentationLevelSetFunction<TImageType, TFeatureImageType>

Definition at line 81 of file itkGeodesicActiveContourLevelSetFunction.h.

◆ VectorImageType

template<typename TImageType, typename TFeatureImageType = TImageType>

using itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::VectorImageType

Define an image type for the advection field.

Definition at line 78 of file itkSegmentationLevelSetFunction.h.

Constructor & Destructor Documentation

◆ GeodesicActiveContourLevelSetFunction()

template<typename TImageType, typename TFeatureImageType = TImageType>

itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::GeodesicActiveContourLevelSetFunction ( )

inlineprotected

Definition at line 147 of file itkGeodesicActiveContourLevelSetFunction.h.

◆ ~GeodesicActiveContourLevelSetFunction()

template<typename TImageType, typename TFeatureImageType = TImageType>

itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::~GeodesicActiveContourLevelSetFunction ( )

overrideprotecteddefault

Member Function Documentation

◆ CalculateAdvectionImage()

template<typename TImageType, typename TFeatureImageType = TImageType>

void itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::CalculateAdvectionImage ( )

overridevirtual

Compute the advection field from feature image.

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

◆ CalculateSpeedImage()

template<typename TImageType, typename TFeatureImageType = TImageType>

void itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::CalculateSpeedImage ( )

overridevirtual

Compute speed image from feature image.

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

◆ CreateAnother()

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.

◆ CurvatureSpeed()

template<typename TImageType, typename TFeatureImageType = TImageType>

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.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 115 of file itkGeodesicActiveContourLevelSetFunction.h.

◆ GetDerivativeSigma()

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 130 of file itkGeodesicActiveContourLevelSetFunction.h.

◆ GetNameOfClass()

template<typename TImageType, typename TFeatureImageType = TImageType>

const char * itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

◆ Initialize()

template<typename TImageType, typename TFeatureImageType = TImageType>

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::LevelSetFunction< TImageType >.

Definition at line 137 of file itkGeodesicActiveContourLevelSetFunction.h.

◆ New()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

static

Method for creation through the object factory.

◆ PrintSelf()

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

◆ SetDerivativeSigma()

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 125 of file itkGeodesicActiveContourLevelSetFunction.h.

Member Data Documentation

◆ ImageDimension

template<typename TImageType, typename TFeatureImageType = TImageType>

unsigned int itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Extract some parameters from the superclass.

Definition at line 103 of file itkGeodesicActiveContourLevelSetFunction.h.

◆ m_DerivativeSigma

template<typename TImageType, typename TFeatureImageType = TImageType>

double itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::m_DerivativeSigma {}

private

Definition at line 162 of file itkGeodesicActiveContourLevelSetFunction.h.

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

itkGeodesicActiveContourLevelSetFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ FeatureImageType

◆ FeatureScalarType

◆ Pointer

◆ Self

◆ Superclass

◆ VectorImageType

Constructor & Destructor Documentation

◆ GeodesicActiveContourLevelSetFunction()

◆ ~GeodesicActiveContourLevelSetFunction()

Member Function Documentation

◆ CalculateAdvectionImage()

◆ CalculateSpeedImage()

◆ CreateAnother()

◆ CurvatureSpeed()

◆ GetDerivativeSigma()

◆ GetNameOfClass()

◆ Initialize()

◆ New()

◆ PrintSelf()

◆ SetDerivativeSigma()

Member Data Documentation

◆ ImageDimension

◆ m_DerivativeSigma