#include <itkCannySegmentationLevelSetFunction.h>

Detailed Description

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

A refinement of the standard level-set function which computes a speed term and advection term based on pseudo-Canny edges. See CannySegmentationLevelSetImageFilter for complete information.

Definition at line 35 of file itkCannySegmentationLevelSetFunction.h.

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

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

Public Types
using	ConstPointer = SmartPointer<const Self>

using	FeatureImageType = TFeatureImageType

using	FeatureScalarType

using	Pointer = SmartPointer<Self>

using	Self = CannySegmentationLevelSetFunction

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

virtual void	CalculateDistanceImage ()

void	CalculateSpeedImage () override

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

ImageType *	GetCannyImage ()

virtual const char *	GetNameOfClass () const

void	Initialize (const RadiusType &r) override


void	SetThreshold (ScalarValueType v)

ScalarValueType	GetThreshold () const


void	SetVariance (double v)

double	GetVariance () const

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

virtual void	AllocateSpeedImage ()

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

virtual ScalarValueType	CurvatureSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=nullptr) 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
	CannySegmentationLevelSetFunction ()

	~CannySegmentationLevelSetFunction () 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 Member Functions
template<typename DummyImagePointerType>
void	AssignCannyInput (typename FeatureImageType::Pointer &feature, DummyImagePointerType &)

void	AssignCannyInput (typename FeatureImageType::Pointer &feature, typename FeatureImageType::Pointer &)

Private Attributes
CannyEdgeDetectionImageFilter< ImageType, ImageType >::Pointer	m_Canny {}

CastImageFilter< FeatureImageType, ImageType >::Pointer	m_Caster {}

DanielssonDistanceMapImageFilter< ImageType, ImageType >::Pointer	m_Distance {}

double	m_Threshold {}

ScalarValueType	m_Variance {}

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

Definition at line 45 of file itkCannySegmentationLevelSetFunction.h.

◆ FeatureImageType

template<typename TImageType, typename TFeatureImageType = TImageType>

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

Definition at line 46 of file itkCannySegmentationLevelSetFunction.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::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::Pointer = SmartPointer<Self>

Definition at line 44 of file itkCannySegmentationLevelSetFunction.h.

◆ Self

template<typename TImageType, typename TFeatureImageType = TImageType>

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

Standard class type aliases.

Definition at line 42 of file itkCannySegmentationLevelSetFunction.h.

◆ Superclass

template<typename TImageType, typename TFeatureImageType = TImageType>

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

Definition at line 43 of file itkCannySegmentationLevelSetFunction.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

◆ CannySegmentationLevelSetFunction()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

inlineprotected

Definition at line 124 of file itkCannySegmentationLevelSetFunction.h.

◆ ~CannySegmentationLevelSetFunction()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

overrideprotecteddefault

Member Function Documentation

◆ AssignCannyInput() [1/2]

template<typename TImageType, typename TFeatureImageType = TImageType>

template<typename DummyImagePointerType>

void itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::AssignCannyInput	(	typename FeatureImageType::Pointer &	feature,
		DummyImagePointerType &	)

inlineprivate

If FeatureImageType != ImageType, use the CastImageFilter to match them.

Definition at line 149 of file itkCannySegmentationLevelSetFunction.h.

◆ AssignCannyInput() [2/2]

template<typename TImageType, typename TFeatureImageType = TImageType>

void itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::AssignCannyInput	(	typename FeatureImageType::Pointer &	feature,
		typename FeatureImageType::Pointer &	)

inlineprivate

If FeatureImageType == ImageType, assign directly to the Canny filter

Definition at line 159 of file itkCannySegmentationLevelSetFunction.h.

◆ CalculateAdvectionImage()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

overridevirtual

Compute the advection image. The Advection Image is the gradient image attenuated with the distance to the canny edges.

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

◆ CalculateDistanceImage()

template<typename TImageType, typename TFeatureImageType = TImageType>

virtual void itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::CalculateDistanceImage ( )

virtual

Compute the distance image. This is the distance to the canny edges.

◆ CalculateSpeedImage()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

overridevirtual

Compute the Speed Image. The Speed Image is the distance to the canny edges.

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

◆ CreateAnother()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

◆ GetCannyImage()

template<typename TImageType, typename TFeatureImageType = TImageType>

ImageType * itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetCannyImage ( )

inline

Definition at line 118 of file itkCannySegmentationLevelSetFunction.h.

◆ GetNameOfClass()

template<typename TImageType, typename TFeatureImageType = TImageType>

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

virtual

See also: LightObject::GetNameOfClass()

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

◆ GetThreshold()

template<typename TImageType, typename TFeatureImageType = TImageType>

ScalarValueType itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetThreshold ( ) const

inline

Definition at line 72 of file itkCannySegmentationLevelSetFunction.h.

◆ GetVariance()

template<typename TImageType, typename TFeatureImageType = TImageType>

double itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetVariance ( ) const

inlinenodiscard

Definition at line 86 of file itkCannySegmentationLevelSetFunction.h.

◆ Initialize()

template<typename TImageType, typename TFeatureImageType = TImageType>

void itk::CannySegmentationLevelSetFunction< 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 108 of file itkCannySegmentationLevelSetFunction.h.