#include <itkShapePriorSegmentationLevelSetFunction.h>

Detailed Description

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

This function is used in ShapePriorSegmentationLevelSetFilter to segment structures in an image based on user supplied edge potential map and shape model.

This class extends the basic LevelSetFunction with a shape prior term as developed in [63].

\( \zeta( \phi^{*} - \phi) \)

where \( \phi^{*} \) is the signed distance function from a target shape and \( \zeta \) is a scalar constant.

The target shape signed distance function is supplied through a ShapeSignedDistanceFunction object.

See also: LevelSetFunction; SegmentationLevelSetImageFunction; ShapeSignedDistanceFunction

Definition at line 51 of file itkShapePriorSegmentationLevelSetFunction.h.

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

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

Classes
struct	ShapePriorGlobalDataStruct

Public Types
using	ConstPointer = SmartPointer<const Self>

using	ContinuousIndexType

using	FeatureImageType = TFeatureImageType

using	FeatureScalarType

typedef Vector< float, Self::ImageDimension >	FloatOffsetType

typedef TImageType	ImageType

using	IndexType

typedef ConstNeighborhoodIterator< TImageType, DefaultBoundaryConditionType >	NeighborhoodType

using	Pointer = SmartPointer<Self>

typedef typename ConstNeighborhoodIterator< TImageType >::RadiusType	RadiusType

typedef PixelType	ScalarValueType

using	Self = ShapePriorSegmentationLevelSetFunction

using	ShapeFunctionPointer = typename ShapeFunctionType::ConstPointer

using	ShapeFunctionType = ShapeSignedDistanceFunction<double, Self::ImageDimension>

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
TimeStepType	ComputeGlobalTimeStep (void *gd) const override

PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *gd, const FloatOffsetType &=FloatOffsetType(0.0)) override

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

void *	GetGlobalDataPointer () const override

const char *	GetNameOfClass () const override

void	ReleaseGlobalDataPointer (void *GlobalData) const override


void	SetShapePriorWeight (const ScalarValueType p)

ScalarValueType	GetShapePriorWeight () const


void	SetShapeFunction (const ShapeFunctionType *ptr)

const ShapeFunctionType *	GetShapeFunction () const

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

virtual void	AllocateSpeedImage ()

virtual void	CalculateAdvectionImage ()

virtual void	CalculateSpeedImage ()

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)

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

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

virtual ScalarValueType	CurvatureSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=nullptr) const

bool	GetUseMinimalCurvature () const

virtual ScalarValueType	LaplacianSmoothingSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) 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 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
void	PrintSelf (std::ostream &os, Indent indent) const override

	ShapePriorSegmentationLevelSetFunction ()

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

	~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
ShapeFunctionPointer	m_ShapeFunction {}

ScalarValueType	m_ShapePriorWeight {}

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

Definition at line 61 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ ContinuousIndexType

template<typename TImageType, typename TFeatureImageType = TImageType>

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

Continuous index type recognized by the interpolator

Definition at line 87 of file itkSegmentationLevelSetFunction.h.

◆ FeatureImageType

template<typename TImageType, typename TFeatureImageType = TImageType>

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

Definition at line 62 of file itkShapePriorSegmentationLevelSetFunction.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

◆ IndexType

template<typename TImageType, typename TFeatureImageType = TImageType>

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

Definition at line 70 of file itkSegmentationLevelSetFunction.h.

◆ 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::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::Pointer = SmartPointer<Self>

Definition at line 60 of file itkShapePriorSegmentationLevelSetFunction.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::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::Self = ShapePriorSegmentationLevelSetFunction

Standard class type aliases.

Definition at line 58 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ ShapeFunctionPointer

template<typename TImageType, typename TFeatureImageType = TImageType>

using itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ShapeFunctionPointer = typename ShapeFunctionType::ConstPointer

Definition at line 88 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ ShapeFunctionType

template<typename TImageType, typename TFeatureImageType = TImageType>

using itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ShapeFunctionType = ShapeSignedDistanceFunction<double, Self::ImageDimension>

ShapeFunction type alias support

Definition at line 87 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ Superclass

template<typename TImageType, typename TFeatureImageType = TImageType>

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

Definition at line 59 of file itkShapePriorSegmentationLevelSetFunction.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

◆ ShapePriorSegmentationLevelSetFunction()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

protected

◆ ~ShapePriorSegmentationLevelSetFunction()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

overrideprotecteddefault

Member Function Documentation

◆ ComputeGlobalTimeStep()

template<typename TImageType, typename TFeatureImageType = TImageType>

TimeStepType itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ComputeGlobalTimeStep ( void * gd ) const

overridevirtual

Compute global time step from the global data structure.

Reimplemented from itk::LevelSetFunction< TImageType >.

◆ ComputeUpdate()

template<typename TImageType, typename TFeatureImageType = TImageType>

PixelType itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ComputeUpdate	(	const NeighborhoodType &	neighborhood,
		void *	gd,
		const FloatOffsetType &	= FloatOffsetType(0.0) )

overridevirtual

Compute the equation value with the additional shape prior term.

Reimplemented from itk::LevelSetFunction< TImageType >.

◆ CreateAnother()

template<typename TImageType, typename TFeatureImageType = TImageType>

virtual::itk::LightObject::Pointer itk::ShapePriorSegmentationLevelSetFunction< 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 >.

◆ GetGlobalDataPointer()

template<typename TImageType, typename TFeatureImageType = TImageType>

void * itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetGlobalDataPointer ( ) const

inlineoverridevirtual

Returns a pointer to a global data structure for computing time step.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 136 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ GetNameOfClass()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ GetShapeFunction()

template<typename TImageType, typename TFeatureImageType = TImageType>

const ShapeFunctionType * itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetShapeFunction ( ) const

inline

The ShapeFunction encapsulates the signed distance to the shape used to influence the evolution of the level set.

Definition at line 111 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ GetShapePriorWeight()

template<typename TImageType, typename TFeatureImageType = TImageType>

ScalarValueType itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetShapePriorWeight ( ) const

inline

Zeta. The ShapePriorWeight scales the shape prior term values.

Definition at line 97 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ New()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

◆ ReleaseGlobalDataPointer()

template<typename TImageType, typename TFeatureImageType = TImageType>

void itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ReleaseGlobalDataPointer ( void * GlobalData ) const

inlineoverridevirtual

Release the global data structure.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 149 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ SetShapeFunction()

template<typename TImageType, typename TFeatureImageType = TImageType>

void itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetShapeFunction ( const ShapeFunctionType * ptr )

inline

The ShapeFunction encapsulates the signed distance to the shape used to influence the evolution of the level set.

Definition at line 106 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ SetShapePriorWeight()

template<typename TImageType, typename TFeatureImageType = TImageType>

void itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetShapePriorWeight ( const ScalarValueType p )

inline

Zeta. The ShapePriorWeight scales the shape prior term values.

Definition at line 92 of file itkShapePriorSegmentationLevelSetFunction.h.

Member Data Documentation

◆ ImageDimension

template<typename TImageType, typename TFeatureImageType = TImageType>

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

staticconstexpr

Extract some parameters from the superclass.

Definition at line 84 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ m_ShapeFunction

template<typename TImageType, typename TFeatureImageType = TImageType>

ShapeFunctionPointer itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_ShapeFunction {}

private

Definition at line 162 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ m_ShapePriorWeight

template<typename TImageType, typename TFeatureImageType = TImageType>

ScalarValueType itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_ShapePriorWeight {}

private

Definition at line 163 of file itkShapePriorSegmentationLevelSetFunction.h.

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

itkShapePriorSegmentationLevelSetFunction.h

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ ContinuousIndexType

◆ FeatureImageType

◆ FeatureScalarType

◆ FloatOffsetType

◆ ImageType

◆ IndexType

◆ NeighborhoodType

◆ Pointer

◆ RadiusType

◆ ScalarValueType

◆ Self

◆ ShapeFunctionPointer

◆ ShapeFunctionType

◆ Superclass

◆ VectorImageType

Constructor & Destructor Documentation

◆ ShapePriorSegmentationLevelSetFunction()

◆ ~ShapePriorSegmentationLevelSetFunction()

Member Function Documentation

◆ ComputeGlobalTimeStep()

◆ ComputeUpdate()

◆ CreateAnother()

◆ GetGlobalDataPointer()

◆ GetNameOfClass()

◆ GetShapeFunction()

◆ GetShapePriorWeight()

◆ New()

◆ PrintSelf()

◆ ReleaseGlobalDataPointer()

◆ SetShapeFunction()

◆ SetShapePriorWeight()

Member Data Documentation

◆ ImageDimension

◆ m_ShapeFunction

◆ m_ShapePriorWeight