#include <itkShapeDetectionLevelSetFunction.h>

Detailed Description

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

This function is used in the ShapeDetectionLevelSetImageFilter 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.

ShapeDetectionLevelSetFunction 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 image 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}) \]

Note that there is no advection term in this function.

This implementation is based on [71].

See also: LevelSetFunction; SegmentationLevelSetImageFunction; ShapeDetectionLevelSetImageFilter

Definition at line 68 of file itkShapeDetectionLevelSetFunction.h.

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

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

Public Types
using	ConstPointer = SmartPointer<const Self>

using	FeatureImageType = TFeatureImageType

using	FeatureScalarType

typedef Vector< float, Self::ImageDimension >	FloatOffsetType

typedef TImageType	ImageType

typedef ConstNeighborhoodIterator< TImageType, DefaultBoundaryConditionType >	NeighborhoodType

using	Pointer = SmartPointer<Self>

typedef typename ConstNeighborhoodIterator< TImageType >::RadiusType	RadiusType

typedef PixelType	ScalarValueType

using	Self = ShapeDetectionLevelSetFunction

using	Superclass = SegmentationLevelSetFunction<TImageType, TFeatureImageType>

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

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

virtual void	AllocateSpeedImage ()

virtual void	CalculateAdvectionImage ()

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

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
	ShapeDetectionLevelSetFunction ()

	~ShapeDetectionLevelSetFunction () 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 ()

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::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::ConstPointer = SmartPointer<const Self>

Definition at line 78 of file itkShapeDetectionLevelSetFunction.h.

◆ FeatureImageType

template<typename TImageType, typename TFeatureImageType = TImageType>

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

Definition at line 79 of file itkShapeDetectionLevelSetFunction.h.

◆ FeatureScalarType

template<typename TImageType, typename TFeatureImageType = TImageType>

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

Definition at line 69 of file itkSegmentationLevelSetFunction.h.

◆ FloatOffsetType

template<typename TImageType, typename TFeatureImageType = TImageType>

A floating point offset from an image grid location. Used for interpolation among grid values in a neighborhood.

◆ ImageType

template<typename TImageType, typename TFeatureImageType = TImageType>

Extract some parameters from the image type

◆ NeighborhoodType

template<typename TImageType, typename TFeatureImageType = TImageType>

The type of data structure that is passed to this function object to evaluate at a pixel that does not lie on a data set boundary.

◆ Pointer

template<typename TImageType, typename TFeatureImageType = TImageType>

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

Definition at line 77 of file itkShapeDetectionLevelSetFunction.h.

◆ RadiusType

template<typename TImageType, typename TFeatureImageType = TImageType>

Neighborhood radius type

◆ ScalarValueType

template<typename TImageType, typename TFeatureImageType = TImageType>

◆ Self

template<typename TImageType, typename TFeatureImageType = TImageType>

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

Standard class type aliases.

Definition at line 75 of file itkShapeDetectionLevelSetFunction.h.

◆ Superclass

template<typename TImageType, typename TFeatureImageType = TImageType>

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

Definition at line 76 of file itkShapeDetectionLevelSetFunction.h.

Constructor & Destructor Documentation

◆ ShapeDetectionLevelSetFunction()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

inlineprotected

Definition at line 122 of file itkShapeDetectionLevelSetFunction.h.

◆ ~ShapeDetectionLevelSetFunction()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

overrideprotecteddefault

Member Function Documentation

◆ CalculateSpeedImage()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

overridevirtual

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 Propagation speed term. See LevelSetFunction for more information.

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

◆ CreateAnother()

template<typename TImageType, typename TFeatureImageType = TImageType>

virtual::itk::LightObject::Pointer itk::ShapeDetectionLevelSetFunction< 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::LevelSetFunction< TImageType >.

◆ CurvatureSpeed()

template<typename TImageType, typename TFeatureImageType = TImageType>

ScalarValueType itk::ShapeDetectionLevelSetFunction< 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 104 of file itkShapeDetectionLevelSetFunction.h.

◆ GetNameOfClass()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ Initialize()

template<typename TImageType, typename TFeatureImageType = TImageType>

void itk::ShapeDetectionLevelSetFunction< 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, TImageType >.

Definition at line 112 of file itkShapeDetectionLevelSetFunction.h.

◆ New()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

static

Method for creation through the object factory.

Member Data Documentation

◆ ImageDimension

template<typename TImageType, typename TFeatureImageType = TImageType>

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

staticconstexpr

Extract some parameters from the superclass.

Definition at line 97 of file itkShapeDetectionLevelSetFunction.h.

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

itkShapeDetectionLevelSetFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ FeatureImageType

◆ FeatureScalarType

◆ FloatOffsetType

◆ ImageType

◆ NeighborhoodType

◆ Pointer

◆ RadiusType

◆ ScalarValueType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ShapeDetectionLevelSetFunction()

◆ ~ShapeDetectionLevelSetFunction()

Member Function Documentation

◆ CalculateSpeedImage()

◆ CreateAnother()

◆ CurvatureSpeed()

◆ GetNameOfClass()

◆ Initialize()

◆ New()

Member Data Documentation

◆ ImageDimension