ITK  6.0.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::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType > Class Template Reference

#include <itkThresholdSegmentationLevelSetFunction.h>

Detailed Description

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

This function is used in ThresholdSegmentationLevelSetImageFilter to segment structures in images based on intensity values.

SegmentationLevelSetFunction is a subclass of the generic LevelSetFunction.
It is 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.

You may optionally add a Laplacian calculation on the image to the threshold-based speed term by setting the EdgeWeight parameter to a non-zero value. The Laplacian term will cause the evolving surface to be more strongly attracted to image edges. Several parameters control a preprocessing FeatureImage smoothing stage applied only to the Laplacian calculation.

Image \( f \) is thresholded pixel by pixel using upper threshold \( U \) and lower threshold \( L \) according to the following formula.
\( f(x) = \left\{ \begin{array}{ll} g(x) - L & \mbox{if $(g)x < (U-L)/2 + L$} \\ U - g(x) & \mbox{otherwise} \end{array} \right. \)
See also
SegmentationLevelSetImageFunction
ThresholdSegmentationLevelSetImageFilter

Definition at line 57 of file itkThresholdSegmentationLevelSetFunction.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FeatureImageType = TFeatureImageType
 
using Pointer = SmartPointer< Self >
 
using Self = ThresholdSegmentationLevelSetFunction
 
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
 
ScalarValueType GetEdgeWeight () const
 
const char * GetNameOfClass () const override
 
ScalarValueType GetSmoothingConductance () const
 
int GetSmoothingIterations () const
 
ScalarValueType GetSmoothingTimeStep () const
 
void Initialize (const RadiusType &r) override
 
void SetEdgeWeight (const ScalarValueType p)
 
void SetSmoothingConductance (const ScalarValueType p)
 
void SetSmoothingIterations (const int p)
 
void SetSmoothingTimeStep (const ScalarValueType i)
 
void SetUpperThreshold (FeatureScalarType f)
 
FeatureScalarType GetUpperThreshold () const
 
void SetLowerThreshold (FeatureScalarType f)
 
FeatureScalarType GetLowerThreshold () const
 
- Public Member Functions inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
virtual void AllocateAdvectionImage ()
 
virtual void AllocateSpeedImage ()
 
virtual void CalculateAdvectionImage ()
 
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

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

ScalarValueType m_EdgeWeight {}
 
FeatureScalarType m_LowerThreshold {}
 
ScalarValueType m_SmoothingConductance {}
 
int m_SmoothingIterations {}
 
ScalarValueType m_SmoothingTimeStep {}
 
FeatureScalarType m_UpperThreshold {}
 
- 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 = TImageType>
using itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ConstPointer = SmartPointer<const Self>

Definition at line 67 of file itkThresholdSegmentationLevelSetFunction.h.

◆ FeatureImageType

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

Definition at line 68 of file itkThresholdSegmentationLevelSetFunction.h.

◆ Pointer

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

Definition at line 66 of file itkThresholdSegmentationLevelSetFunction.h.

◆ Self

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

Standard class type aliases.

Definition at line 64 of file itkThresholdSegmentationLevelSetFunction.h.

◆ Superclass

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

Definition at line 65 of file itkThresholdSegmentationLevelSetFunction.h.

Constructor & Destructor Documentation

◆ ThresholdSegmentationLevelSetFunction()

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

◆ ~ThresholdSegmentationLevelSetFunction()

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

Member Function Documentation

◆ CalculateSpeedImage()

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

◆ GetEdgeWeight()

template<typename TImageType , typename TFeatureImageType = TImageType>
ScalarValueType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetEdgeWeight ( ) const
inline

Definition at line 130 of file itkThresholdSegmentationLevelSetFunction.h.

◆ GetLowerThreshold()

template<typename TImageType , typename TFeatureImageType = TImageType>
FeatureScalarType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetLowerThreshold ( ) const
inline

Set/Get threshold values

Definition at line 102 of file itkThresholdSegmentationLevelSetFunction.h.

◆ GetNameOfClass()

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

◆ GetSmoothingConductance()

template<typename TImageType , typename TFeatureImageType = TImageType>
ScalarValueType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetSmoothingConductance ( ) const
inline

Definition at line 145 of file itkThresholdSegmentationLevelSetFunction.h.

◆ GetSmoothingIterations()

template<typename TImageType , typename TFeatureImageType = TImageType>
int itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetSmoothingIterations ( ) const
inline

Definition at line 160 of file itkThresholdSegmentationLevelSetFunction.h.

◆ GetSmoothingTimeStep()

template<typename TImageType , typename TFeatureImageType = TImageType>
ScalarValueType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetSmoothingTimeStep ( ) const
inline

Definition at line 175 of file itkThresholdSegmentationLevelSetFunction.h.

◆ GetUpperThreshold()

template<typename TImageType , typename TFeatureImageType = TImageType>
FeatureScalarType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetUpperThreshold ( ) const
inline

Set/Get threshold values

Definition at line 92 of file itkThresholdSegmentationLevelSetFunction.h.

◆ Initialize()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< 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 112 of file itkThresholdSegmentationLevelSetFunction.h.

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< 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 197 of file itkThresholdSegmentationLevelSetFunction.h.

◆ SetEdgeWeight()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetEdgeWeight ( const ScalarValueType  p)
inline

Set/Get the weight applied to the edge (Laplacian) attractor in the speed term function. Zero will turn this term off.

Definition at line 124 of file itkThresholdSegmentationLevelSetFunction.h.

◆ SetLowerThreshold()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetLowerThreshold ( FeatureScalarType  f)
inline

Set/Get threshold values

Definition at line 97 of file itkThresholdSegmentationLevelSetFunction.h.

◆ SetSmoothingConductance()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetSmoothingConductance ( const ScalarValueType  p)
inline

Anisotropic diffusion is applied to the FeatureImage before calculating the Laplacian (edge) term. This method sets/gets the smoothing conductance.

Definition at line 139 of file itkThresholdSegmentationLevelSetFunction.h.

◆ SetSmoothingIterations()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetSmoothingIterations ( const int  p)
inline

Anisotropic diffusion is applied to the FeatureImage before calculating the Laplacian (edge) term. This method sets/gets the number of diffusion iterations.

Definition at line 154 of file itkThresholdSegmentationLevelSetFunction.h.

◆ SetSmoothingTimeStep()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetSmoothingTimeStep ( const ScalarValueType  i)
inline

Anisotropic diffusion is applied to the FeatureImage before calculating the Laplacian (edge) term. This method sets/gets the diffusion time step.

Definition at line 169 of file itkThresholdSegmentationLevelSetFunction.h.

◆ SetUpperThreshold()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetUpperThreshold ( FeatureScalarType  f)
inline

Set/Get threshold values

Definition at line 87 of file itkThresholdSegmentationLevelSetFunction.h.

Member Data Documentation

◆ ImageDimension

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

Extract some parameters from the superclass.

Definition at line 83 of file itkThresholdSegmentationLevelSetFunction.h.

◆ m_EdgeWeight

template<typename TImageType , typename TFeatureImageType = TImageType>
ScalarValueType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_EdgeWeight {}
protected

Definition at line 210 of file itkThresholdSegmentationLevelSetFunction.h.

◆ m_LowerThreshold

template<typename TImageType , typename TFeatureImageType = TImageType>
FeatureScalarType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_LowerThreshold {}
protected

Definition at line 209 of file itkThresholdSegmentationLevelSetFunction.h.

◆ m_SmoothingConductance

template<typename TImageType , typename TFeatureImageType = TImageType>
ScalarValueType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_SmoothingConductance {}
protected

Definition at line 211 of file itkThresholdSegmentationLevelSetFunction.h.

◆ m_SmoothingIterations

template<typename TImageType , typename TFeatureImageType = TImageType>
int itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_SmoothingIterations {}
protected

Definition at line 212 of file itkThresholdSegmentationLevelSetFunction.h.

◆ m_SmoothingTimeStep

template<typename TImageType , typename TFeatureImageType = TImageType>
ScalarValueType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_SmoothingTimeStep {}
protected

Definition at line 213 of file itkThresholdSegmentationLevelSetFunction.h.

◆ m_UpperThreshold

template<typename TImageType , typename TFeatureImageType = TImageType>
FeatureScalarType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_UpperThreshold {}
protected

Definition at line 208 of file itkThresholdSegmentationLevelSetFunction.h.


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