ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType > Class Template Reference

#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 Pointer = SmartPointer< Self >
 
using Self = CannySegmentationLevelSetFunction
 
using Superclass = SegmentationLevelSetFunction< TImageType, TFeatureImageType >
 
- Public Types inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = typename InterpolatorType::ContinuousIndexType
 
using FeatureImageType = TFeatureImageType
 
using FeatureScalarType = typename FeatureImageType::PixelType
 
using IndexType = typename ImageType::IndexType
 
using InterpolatorType = LinearInterpolateImageFunction< ImageType >
 
using Pointer = SmartPointer< Self >
 
using Self = SegmentationLevelSetFunction
 
using Superclass = LevelSetFunction< TImageType >
 
using VectorImageType = Image< VectorType, Self::ImageDimension >
 
using VectorInterpolatorType = VectorLinearInterpolateImageFunction< VectorImageType >
 
- Public Types inherited from itk::LevelSetFunction< TImageType >
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
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
 
ImageTypeGetCannyImage ()
 
const char * GetNameOfClass () const override
 
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, TFeatureImageType >
virtual void AllocateAdvectionImage ()
 
virtual void AllocateSpeedImage ()
 
const char * GetNameOfClass () const override
 
void Initialize (const RadiusType &r) override
 
virtual void ReverseExpansionDirection ()
 
virtual const FeatureImageTypeGetFeatureImage () const
 
virtual void SetFeatureImage (const FeatureImageType *f)
 
virtual ImageTypeGetSpeedImage ()
 
void SetSpeedImage (ImageType *s)
 
virtual VectorImageTypeGetAdvectionImage () 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 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 RadiusTypeGetRadius () 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 Pointer CreateAnother () 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, TFeatureImageType >
static constexpr unsigned int ImageDimension = Superclass::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, TFeatureImageType >
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, TFeatureImageType >
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.

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

Constructor & Destructor Documentation

◆ CannySegmentationLevelSetFunction()

template<typename TImageType , typename TFeatureImageType = TImageType>
itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::CannySegmentationLevelSetFunction ( )
inlineprotected

◆ ~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 148 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 158 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, TFeatureImageType >.

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

◆ GetCannyImage()

template<typename TImageType , typename TFeatureImageType = TImageType>
ImageType* itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetCannyImage ( )
inline

Definition at line 116 of file itkCannySegmentationLevelSetFunction.h.

◆ GetNameOfClass()

template<typename TImageType , typename TFeatureImageType = TImageType>
const char* itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetNameOfClass ( ) const
overridevirtual

◆ GetThreshold()

template<typename TImageType , typename TFeatureImageType = TImageType>
ScalarValueType itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetThreshold ( ) const
inline

Definition at line 71 of file itkCannySegmentationLevelSetFunction.h.

◆ GetVariance()

template<typename TImageType , typename TFeatureImageType = TImageType>
double itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetVariance ( ) const
inline

Definition at line 84 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 106 of file itkCannySegmentationLevelSetFunction.h.

◆ New()

template<typename TImageType , typename TFeatureImageType = TImageType>
static Pointer itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::New ( )
static

Method for creation through the object factory.

◆ SetThreshold()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetThreshold ( ScalarValueType  v)
inline

Definition at line 66 of file itkCannySegmentationLevelSetFunction.h.

◆ SetVariance()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetVariance ( double  v)
inline

Definition at line 79 of file itkCannySegmentationLevelSetFunction.h.

Member Data Documentation

◆ ImageDimension

template<typename TImageType , typename TFeatureImageType = TImageType>
constexpr unsigned int itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::ImageDimension = Superclass::ImageDimension
staticconstexpr

Extract some parameters from the superclass.

Definition at line 62 of file itkCannySegmentationLevelSetFunction.h.

◆ m_Canny

template<typename TImageType , typename TFeatureImageType = TImageType>
CannyEdgeDetectionImageFilter<ImageType, ImageType>::Pointer itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Canny {}
private

Definition at line 137 of file itkCannySegmentationLevelSetFunction.h.

◆ m_Caster

template<typename TImageType , typename TFeatureImageType = TImageType>
CastImageFilter<FeatureImageType, ImageType>::Pointer itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Caster {}
private

Definition at line 141 of file itkCannySegmentationLevelSetFunction.h.

◆ m_Distance

template<typename TImageType , typename TFeatureImageType = TImageType>
DanielssonDistanceMapImageFilter<ImageType, ImageType>::Pointer itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Distance {}
private

Definition at line 139 of file itkCannySegmentationLevelSetFunction.h.

◆ m_Threshold

template<typename TImageType , typename TFeatureImageType = TImageType>
double itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Threshold {}
private

Definition at line 135 of file itkCannySegmentationLevelSetFunction.h.

◆ m_Variance

template<typename TImageType , typename TFeatureImageType = TImageType>
ScalarValueType itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Variance {}
private

Definition at line 134 of file itkCannySegmentationLevelSetFunction.h.


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