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

#include <itkVectorThresholdSegmentationLevelSetFunction.h>

Detailed Description

template<typename TImageType, typename TFeatureImageType>
class itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >

This function is used in VectorThresholdSegmentationLevelSetImageFilter to segment structures in images based on the Mahalanobis distance.

CREDITS
This class was contributed to ITK by Stefan Lindenau https://www.itk.org/pipermail/insight-users/2003-December/005969.html
SegmentationLevelSetFunction is a subclass of the generic LevelSetFunction.
It useful for segmentations based on intensity values in an image. It works by constructing a speed term (feature image) with positive values inside an intensity window (between a low and high threshold) and negative values outside that intensity window. The evolving level set front will lock onto regions that are at the edges of the intensity window.
Image \( f(x) \) is thresholded pixel by pixel using threshold \(T\) according to the following formula.

\[ f(x) = T - MahalanobisDistance(x) \]

See also
SegmentationLevelSetImageFunction
ThresholdSegmentationLevelSetImageFilter
MahalanobisDistanceMembershipFunction

Definition at line 58 of file itkVectorThresholdSegmentationLevelSetFunction.h.

+ Inheritance diagram for itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >:
+ Collaboration diagram for itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using CovarianceMatrixType = typename MahalanobisFunctionType::CovarianceMatrixType
 
using FeatureImagePixelType = typename FeatureImageType::PixelType
 
using FeatureImageType = TFeatureImageType
 
using MahalanobisFunctionPointer = typename MahalanobisFunctionType::Pointer
 
using MahalanobisFunctionType = Statistics::MahalanobisDistanceMembershipFunction< FeatureScalarType >
 
using MeanVectorType = typename MahalanobisFunctionType::MeanVectorType
 
using Pointer = SmartPointer< Self >
 
using Self = VectorThresholdSegmentationLevelSetFunction
 
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 CalculateSpeedImage () override
 
const CovarianceMatrixTypeGetCovariance () const
 
ScalarValueType GetThreshold ()
 
void Initialize (const RadiusType &r) override
 
 itkOverrideGetNameOfClassMacro (VectorThresholdSegmentationLevelSetFunction)
 
void SetCovariance (const CovarianceMatrixType &cov)
 
void SetThreshold (ScalarValueType thr)
 
void SetMean (const MeanVectorType &mean)
 
const MeanVectorTypeGetMean () const
 
- Public Member Functions inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
virtual void AllocateAdvectionImage ()
 
virtual void AllocateSpeedImage ()
 
virtual void CalculateAdvectionImage ()
 
 itkOverrideGetNameOfClassMacro (SegmentationLevelSetFunction)
 
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
 
 itkOverrideGetNameOfClassMacro (LevelSetFunction)
 
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 ()
 
 itkOverrideGetNameOfClassMacro (FiniteDifferenceFunction)
 
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
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
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 constexpr unsigned int NumberOfComponents = FeatureImagePixelType::Dimension
 
- 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

void PrintSelf (std::ostream &os, Indent indent) const override
 
 VectorThresholdSegmentationLevelSetFunction ()
 
 ~VectorThresholdSegmentationLevelSetFunction () 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 ()
 
 ~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 ()
 

Protected Attributes

MahalanobisFunctionPointer m_Mahalanobis {}
 
ScalarValueType m_Threshold {}
 
- 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 {}
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::LevelSetFunction< TImageType >
static VectorType InitializeZeroVectorConstant ()
 
- 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 >
using itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ConstPointer = SmartPointer<const Self>

◆ CovarianceMatrixType

template<typename TImageType , typename TFeatureImageType >
using itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::CovarianceMatrixType = typename MahalanobisFunctionType::CovarianceMatrixType

◆ FeatureImagePixelType

template<typename TImageType , typename TFeatureImageType >
using itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::FeatureImagePixelType = typename FeatureImageType::PixelType

Extract the number of components in the vector pixel type .

Definition at line 87 of file itkVectorThresholdSegmentationLevelSetFunction.h.

◆ FeatureImageType

template<typename TImageType , typename TFeatureImageType >
using itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::FeatureImageType = TFeatureImageType

◆ MahalanobisFunctionPointer

template<typename TImageType , typename TFeatureImageType >
using itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::MahalanobisFunctionPointer = typename MahalanobisFunctionType::Pointer

◆ MahalanobisFunctionType

template<typename TImageType , typename TFeatureImageType >
using itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::MahalanobisFunctionType = Statistics::MahalanobisDistanceMembershipFunction<FeatureScalarType>

◆ MeanVectorType

template<typename TImageType , typename TFeatureImageType >
using itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::MeanVectorType = typename MahalanobisFunctionType::MeanVectorType

◆ Pointer

template<typename TImageType , typename TFeatureImageType >
using itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::Pointer = SmartPointer<Self>

◆ Self

template<typename TImageType , typename TFeatureImageType >
using itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::Self = VectorThresholdSegmentationLevelSetFunction

Standard class type aliases.

Definition at line 65 of file itkVectorThresholdSegmentationLevelSetFunction.h.

◆ Superclass

template<typename TImageType , typename TFeatureImageType >
using itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::Superclass = SegmentationLevelSetFunction<TImageType, TFeatureImageType>

Constructor & Destructor Documentation

◆ VectorThresholdSegmentationLevelSetFunction()

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

Definition at line 146 of file itkVectorThresholdSegmentationLevelSetFunction.h.

References New().

◆ ~VectorThresholdSegmentationLevelSetFunction()

template<typename TImageType , typename TFeatureImageType >
itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::~VectorThresholdSegmentationLevelSetFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ CalculateSpeedImage()

template<typename TImageType , typename TFeatureImageType >
void itk::VectorThresholdSegmentationLevelSetFunction< 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 >.

◆ GetCovariance()

template<typename TImageType , typename TFeatureImageType >
const CovarianceMatrixType& itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetCovariance ( ) const
inline

◆ GetMean()

template<typename TImageType , typename TFeatureImageType >
const MeanVectorType& itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetMean ( ) const
inline

Set/Get mean and covariance

Definition at line 102 of file itkVectorThresholdSegmentationLevelSetFunction.h.

◆ GetThreshold()

template<typename TImageType , typename TFeatureImageType >
ScalarValueType itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetThreshold ( )
inline

◆ Initialize()

template<typename TImageType , typename TFeatureImageType >
void itk::VectorThresholdSegmentationLevelSetFunction< 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 136 of file itkVectorThresholdSegmentationLevelSetFunction.h.

◆ itkOverrideGetNameOfClassMacro()

template<typename TImageType , typename TFeatureImageType >
itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::itkOverrideGetNameOfClassMacro ( VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >  )

Run-time type information (and related methods)

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

template<typename TImageType , typename TFeatureImageType >
void itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineoverrideprotectedvirtual

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

Definition at line 166 of file itkVectorThresholdSegmentationLevelSetFunction.h.

◆ SetCovariance()

template<typename TImageType , typename TFeatureImageType >
void itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetCovariance ( const CovarianceMatrixType cov)
inline

◆ SetMean()

template<typename TImageType , typename TFeatureImageType >
void itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetMean ( const MeanVectorType mean)
inline

Set/Get mean and covariance

Definition at line 97 of file itkVectorThresholdSegmentationLevelSetFunction.h.

◆ SetThreshold()

template<typename TImageType , typename TFeatureImageType >
void itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetThreshold ( ScalarValueType  thr)
inline

Set/Get the threshold value for the MahalanobisDistance

Definition at line 121 of file itkVectorThresholdSegmentationLevelSetFunction.h.

Member Data Documentation

◆ ImageDimension

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

Extract some parameters from the superclass.

Definition at line 84 of file itkVectorThresholdSegmentationLevelSetFunction.h.

◆ m_Mahalanobis

template<typename TImageType , typename TFeatureImageType >
MahalanobisFunctionPointer itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Mahalanobis {}
protected

◆ m_Threshold

template<typename TImageType , typename TFeatureImageType >
ScalarValueType itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Threshold {}
protected

◆ NumberOfComponents

template<typename TImageType , typename TFeatureImageType >
constexpr unsigned int itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::NumberOfComponents = FeatureImagePixelType::Dimension
staticconstexpr

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