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

#include <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 FeatureScalarType = typename Superclass::FeatureScalarType
 
using ImageType = typename Superclass::ImageType
 
using MahalanobisFunctionPointer = typename MahalanobisFunctionType::Pointer
 
using MahalanobisFunctionType = Statistics::MahalanobisDistanceMembershipFunction< FeatureScalarType >
 
using MeanVectorType = typename MahalanobisFunctionType::MeanVectorType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename Superclass::RadiusType
 
using ScalarValueType = typename Superclass::ScalarValueType
 
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 FloatOffsetType = typename Superclass::FloatOffsetType
 
using GlobalDataStruct = typename Superclass::GlobalDataStruct
 
using ImageType = typename Superclass::ImageType
 
using IndexType = typename ImageType::IndexType
 
using InterpolatorType = LinearInterpolateImageFunction< ImageType >
 
using NeighborhoodType = typename Superclass::NeighborhoodType
 
using PixelRealType = typename Superclass::PixelRealType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename Superclass::RadiusType
 
using ScalarValueType = typename Superclass::ScalarValueType
 
using Self = SegmentationLevelSetFunction
 
using Superclass = LevelSetFunction< TImageType >
 
using VectorImageType = Image< VectorType, Self::ImageDimension >
 
using VectorInterpolatorType = VectorLinearInterpolateImageFunction< VectorImageType >
 
using VectorType = typename Superclass::VectorType
 
- Public Types inherited from itk::LevelSetFunction< TImageType >
using ConstPointer = SmartPointer< const Self >
 
using FloatOffsetType = typename Superclass::FloatOffsetType
 
using ImageType = typename Superclass::ImageType
 
using NeighborhoodScalesType = typename Superclass::NeighborhoodScalesType
 
using NeighborhoodType = typename Superclass::NeighborhoodType
 
using PixelRealType = typename Superclass::PixelRealType
 
using PixelType = typename Superclass::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename Superclass::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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
virtual const FeatureImageTypeGetFeatureImage () const
 
virtual void SetFeatureImage (const FeatureImageType *f)
 
virtual ImageTypeGetSpeedImage ()
 
void SetSpeedImage (ImageType *s)
 
virtual VectorImageTypeGetAdvectionImage () const
 
void SetAdvectionImage (VectorImageType *s)
 
virtual void CalculateAdvectionImage ()
 
virtual void AllocateSpeedImage ()
 
virtual void AllocateAdvectionImage ()
 
virtual void ReverseExpansionDirection ()
 
- Public Member Functions inherited from itk::LevelSetFunction< TImageType >
virtual VectorType AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
virtual ScalarValueType CurvatureSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=nullptr) const
 
virtual ScalarValueType LaplacianSmoothingSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
virtual ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
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
 
PixelType ComputeUpdate (const NeighborhoodType &it, void *globalData, const FloatOffsetType &=FloatOffsetType(0.0)) override
 
TimeStepType ComputeGlobalTimeStep (void *GlobalData) const override
 
void * GetGlobalDataPointer () const override
 
void ReleaseGlobalDataPointer (void *GlobalData) const override
 
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 Compute3DMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
void SetUseMinimalCurvature (bool b)
 
bool GetUseMinimalCurvature () const
 
void UseMinimalCurvatureOn ()
 
void UseMinimalCurvatureOff ()
 
- 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 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 Pointer New ()
 
static void SetMaximumCurvatureTimeStep (double n)
 
static double GetMaximumCurvatureTimeStep ()
 
static void SetMaximumPropagationTimeStep (double n)
 
static double GetMaximumPropagationTimeStep ()
 
- 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
 
MahalanobisFunctionPointer m_Mahalanobis
 
ScalarValueType m_Threshold
 
void SetMean (const MeanVectorType &mean)
 
const MeanVectorTypeGetMean () const
 
void SetCovariance (const CovarianceMatrixType &cov)
 
const CovarianceMatrixTypeGetCovariance () const
 
void SetThreshold (ScalarValueType thr)
 
ScalarValueType GetThreshold ()
 
void CalculateSpeedImage () override
 
void Initialize (const RadiusType &r) override
 
 VectorThresholdSegmentationLevelSetFunction ()
 
 ~VectorThresholdSegmentationLevelSetFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const override
 
VectorType AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const override
 
 ~SegmentationLevelSetFunction () override=default
 
 SegmentationLevelSetFunction ()
 
- 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 ()
 
- Static Protected Member Functions inherited from itk::LevelSetFunction< TImageType >
static VectorType InitializeZeroVectorConstant ()
 
- Protected Attributes inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
FeatureImageType::ConstPointer m_FeatureImage
 
ImageType::Pointer m_SpeedImage
 
VectorImageType::Pointer m_AdvectionImage
 
InterpolatorType::Pointer m_Interpolator
 
VectorInterpolatorType::Pointer m_VectorInterpolator
 
- Protected Attributes inherited from itk::LevelSetFunction< TImageType >
std::slice x_slice [Self::ImageDimension]
 
OffsetValueType m_Center { 0 }
 
OffsetValueType m_xStride [Self::ImageDimension]
 
bool m_UseMinimalCurvature { false }
 
ScalarValueType m_EpsilonMagnitude
 
ScalarValueType m_AdvectionWeight
 
ScalarValueType m_PropagationWeight
 
ScalarValueType m_CurvatureWeight
 
ScalarValueType m_LaplacianSmoothingWeight
 
- 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_WaveDT
 
static double m_DT
 
static VectorType m_ZeroVectorConstant
 

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.

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

◆ FeatureScalarType

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

◆ ImageType

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

Extract some parameters from the superclass.

Definition at line 78 of file itkVectorThresholdSegmentationLevelSetFunction.h.

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

◆ RadiusType

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

◆ ScalarValueType

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

◆ 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

Set/Get mean and covariance

Definition at line 146 of file itkVectorThresholdSegmentationLevelSetFunction.h.

◆ ~VectorThresholdSegmentationLevelSetFunction()

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

Set/Get mean and covariance

Member Function Documentation

◆ CalculateSpeedImage()

template<typename TImageType , typename TFeatureImageType >
void itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::CalculateSpeedImage ( )
overridevirtual

Set/Get mean and covariance

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

◆ CreateAnother()

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

◆ GetCovariance()

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

Set/Get mean and covariance

Definition at line 114 of file itkVectorThresholdSegmentationLevelSetFunction.h.

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

◆ GetNameOfClass()

template<typename TImageType , typename TFeatureImageType >
virtual const char* itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

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

◆ GetThreshold()

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

Set/Get mean and covariance

Definition at line 127 of file itkVectorThresholdSegmentationLevelSetFunction.h.

◆ Initialize()

template<typename TImageType , typename TFeatureImageType >
void itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::Initialize ( const RadiusType r)
inlineoverridevirtual

Set/Get mean and covariance

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

Definition at line 136 of file itkVectorThresholdSegmentationLevelSetFunction.h.

◆ 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

Set/Get mean and covariance

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

Set/Get mean and covariance

Definition at line 109 of file itkVectorThresholdSegmentationLevelSetFunction.h.

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

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

Set/Get mean and covariance

Definition at line 173 of file itkVectorThresholdSegmentationLevelSetFunction.h.

◆ m_Threshold

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

Set/Get mean and covariance

Definition at line 174 of file itkVectorThresholdSegmentationLevelSetFunction.h.

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