#include <itkShapeDetectionLevelSetFunction.h>

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

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

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: "Shape Modeling with Front Propagation: A Level Set Approach", R. Malladi, J. A. Sethian and B. C. Vermuri. IEEE Trans. on Pattern Analysis and Machine Intelligence, Vol 17, No. 2, pp 158-174, February 1995

See Also: LevelSetFunction; SegmentationLevelSetImageFunction; ShapeDetectionLevelSetImageFilter

Definition at line 72 of file itkShapeDetectionLevelSetFunction.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

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

typedef Superclass::RadiusType	RadiusType

typedef Superclass::ScalarValueType	ScalarValueType

typedef ShapeDetectionLevelSetFunction	Self

typedef SegmentationLevelSetFunction < TImageType, TFeatureImageType >	Superclass

Public Types inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
typedef SmartPointer< const Self >	ConstPointer

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

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

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

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

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

typedef ConstNeighborhoodIterator < TImageType >::RadiusType	RadiusType

typedef FiniteDifferenceFunction	Self

typedef LightObject	Superclass

typedef double	TimeStepType

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

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
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

Public Member Functions inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
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)

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 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 RadiusType &	GetRadius () 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
void	operator= (const Self &)

	ShapeDetectionLevelSetFunction ()

	ShapeDetectionLevelSetFunction (const Self &)

virtual	~ShapeDetectionLevelSetFunction ()

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

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

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

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

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::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::ConstPointer

Definition at line 80 of file itkShapeDetectionLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>

typedef TFeatureImageType itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::FeatureImageType

Definition at line 81 of file itkShapeDetectionLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>

typedef Superclass::FeatureScalarType itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::FeatureScalarType

Definition at line 93 of file itkShapeDetectionLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>

typedef Superclass::FloatOffsetType itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::FloatOffsetType

Definition at line 95 of file itkShapeDetectionLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>

typedef Superclass::GlobalDataStruct itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::GlobalDataStruct

Definition at line 96 of file itkShapeDetectionLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>

typedef Superclass::ImageType itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::ImageType

Extract some parameters from the superclass.

Definition at line 87 of file itkShapeDetectionLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>

typedef Superclass::NeighborhoodType itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::NeighborhoodType

Definition at line 91 of file itkShapeDetectionLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>

typedef SmartPointer< Self > itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::Pointer

Definition at line 79 of file itkShapeDetectionLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>

typedef Superclass::RadiusType itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::RadiusType

Definition at line 94 of file itkShapeDetectionLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>

typedef Superclass::ScalarValueType itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::ScalarValueType

Definition at line 92 of file itkShapeDetectionLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>

typedef ShapeDetectionLevelSetFunction itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::Self

Standard class typedefs.

Definition at line 77 of file itkShapeDetectionLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>

typedef SegmentationLevelSetFunction< TImageType, TFeatureImageType > itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::Superclass

Definition at line 78 of file itkShapeDetectionLevelSetFunction.h.

Constructor & Destructor Documentation

template<typename TImageType , typename TFeatureImageType = TImageType>

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

inlineprotected

Definition at line 119 of file itkShapeDetectionLevelSetFunction.h.

References itk::LevelSetFunction< TImageType >::SetAdvectionWeight(), itk::LevelSetFunction< TImageType >::SetCurvatureWeight(), and itk::LevelSetFunction< TImageType >::SetPropagationWeight().

template<typename TImageType , typename TFeatureImageType = TImageType>

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

inlineprotectedvirtual

Definition at line 126 of file itkShapeDetectionLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType = TImageType>

itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::ShapeDetectionLevelSetFunction ( const Self & )

protected

Member Function Documentation

template<typename TImageType , typename TFeatureImageType = TImageType>

virtual 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, TFeatureImageType >.

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

template<typename TImageType , typename TFeatureImageType = TImageType>

virtual 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 105 of file itkShapeDetectionLevelSetFunction.h.

References itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::PropagationSpeed().

template<typename TImageType , typename TFeatureImageType = TImageType>

virtual const char* itk::ShapeDetectionLevelSetFunction< 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::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, TFeatureImageType >.

Definition at line 109 of file itkShapeDetectionLevelSetFunction.h.

References itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::Initialize(), itk::LevelSetFunction< TImageType >::SetAdvectionWeight(), itk::LevelSetFunction< TImageType >::SetCurvatureWeight(), and itk::LevelSetFunction< TImageType >::SetPropagationWeight().

template<typename TImageType , typename TFeatureImageType = TImageType>

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

static

Method for creation through the object factory.

template<typename TImageType , typename TFeatureImageType = TImageType>

void itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >::operator= ( const Self & )

protected