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

#include <itkShapePriorSegmentationLevelSetFunction.h>

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

Classes

struct  ShapePriorGlobalDataStruct
 

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FeatureImageType = TFeatureImageType
 
using Pointer = SmartPointer< Self >
 
using Self = ShapePriorSegmentationLevelSetFunction
 
using ShapeFunctionPointer = typename ShapeFunctionType::ConstPointer
 
using ShapeFunctionType = ShapeSignedDistanceFunction< double, Self::ImageDimension >
 
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

TimeStepType ComputeGlobalTimeStep (void *gd) const override
 
PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *gd, const FloatOffsetType &=FloatOffsetType(0.0)) override
 
void * GetGlobalDataPointer () const override
 
virtual const char * GetNameOfClass () const
 
void ReleaseGlobalDataPointer (void *GlobalData) const override
 
void SetShapePriorWeight (const ScalarValueType p)
 
ScalarValueType GetShapePriorWeight () const
 
void SetShapeFunction (const ShapeFunctionType *ptr)
 
const ShapeFunctionTypeGetShapeFunction () const
 
- Public Member Functions inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
virtual void AllocateAdvectionImage ()
 
virtual void AllocateSpeedImage ()
 
virtual void CalculateAdvectionImage ()
 
virtual void CalculateSpeedImage ()
 
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)
 
virtual ScalarValueType ComputeMeanCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
virtual ScalarValueType ComputeMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
virtual ScalarValueType CurvatureSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=nullptr) const
 
bool GetUseMinimalCurvature () const
 
virtual ScalarValueType LaplacianSmoothingSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
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
 
 itkTypeMacroNoParent (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 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
 
 ShapePriorSegmentationLevelSetFunction ()
 
 ~ShapePriorSegmentationLevelSetFunction () 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 ()
 

Private Attributes

ShapeFunctionPointer m_ShapeFunction {}
 
ScalarValueType m_ShapePriorWeight {}
 

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
 

Detailed Description

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

This function is used in ShapePriorSegmentationLevelSetFilter to segment structures in an image based on user supplied edge potential map and shape model.

This class extends the basic LevelSetFunction with a shape prior term as developed in [1].

\( \zeta( \phi^{*} - \phi) \)

where \( \phi^{*} \) is the signed distance function from a target shape and \( \zeta \) is a scalar constant.

The target shape signed distance function is supplied through a ShapeSignedDistanceFunction object.

See also
LevelSetFunction
SegmentationLevelSetImageFunction
ShapeSignedDistanceFunction
REFERENCES
[1] Leventon, M.E. et al. "Statistical Shape Influence in Geodesic Active Contours", CVPR 2000.

Definition at line 55 of file itkShapePriorSegmentationLevelSetFunction.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TImageType , typename TFeatureImageType = TImageType>
using itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ConstPointer = SmartPointer<const Self>

Definition at line 65 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ FeatureImageType

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

Definition at line 66 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ Pointer

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

Definition at line 64 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ Self

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

Standard class type aliases.

Definition at line 62 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ ShapeFunctionPointer

template<typename TImageType , typename TFeatureImageType = TImageType>
using itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ShapeFunctionPointer = typename ShapeFunctionType::ConstPointer

Definition at line 92 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ ShapeFunctionType

template<typename TImageType , typename TFeatureImageType = TImageType>
using itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ShapeFunctionType = ShapeSignedDistanceFunction<double, Self::ImageDimension>

ShapeFunction type alias support

Definition at line 91 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ Superclass

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

Definition at line 63 of file itkShapePriorSegmentationLevelSetFunction.h.

Constructor & Destructor Documentation

◆ ShapePriorSegmentationLevelSetFunction()

template<typename TImageType , typename TFeatureImageType = TImageType>
itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ShapePriorSegmentationLevelSetFunction ( )
protected

◆ ~ShapePriorSegmentationLevelSetFunction()

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

Member Function Documentation

◆ ComputeGlobalTimeStep()

template<typename TImageType , typename TFeatureImageType = TImageType>
TimeStepType itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ComputeGlobalTimeStep ( void *  gd) const
overridevirtual

Compute global time step from the global data structure.

Reimplemented from itk::LevelSetFunction< TImageType >.

◆ ComputeUpdate()

template<typename TImageType , typename TFeatureImageType = TImageType>
PixelType itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ComputeUpdate ( const NeighborhoodType neighborhood,
void *  gd,
const FloatOffsetType = FloatOffsetType(0.0) 
)
overridevirtual

Compute the equation value with the additional shape prior term.

Reimplemented from itk::LevelSetFunction< TImageType >.

◆ GetGlobalDataPointer()

template<typename TImageType , typename TFeatureImageType = TImageType>
void* itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetGlobalDataPointer ( ) const
inlineoverridevirtual

Returns a pointer to a global data structure for computing time step.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 140 of file itkShapePriorSegmentationLevelSetFunction.h.

References itk::NumericTraits< T >::ZeroValue().

◆ GetNameOfClass()

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

◆ GetShapeFunction()

template<typename TImageType , typename TFeatureImageType = TImageType>
const ShapeFunctionType* itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetShapeFunction ( ) const
inline

The ShapeFunction encapsulates the signed distance to the shape used to influence the evolution of the level set.

Definition at line 115 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ GetShapePriorWeight()

template<typename TImageType , typename TFeatureImageType = TImageType>
ScalarValueType itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetShapePriorWeight ( ) const
inline

Zeta. The ShapePriorWeight scales the shape prior term values.

Definition at line 101 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

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

◆ ReleaseGlobalDataPointer()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ReleaseGlobalDataPointer ( void *  GlobalData) const
inlineoverridevirtual

Release the global data structure.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 153 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ SetShapeFunction()

template<typename TImageType , typename TFeatureImageType = TImageType>
void itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetShapeFunction ( const ShapeFunctionType ptr)
inline

The ShapeFunction encapsulates the signed distance to the shape used to influence the evolution of the level set.

Definition at line 110 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ SetShapePriorWeight()

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

Zeta. The ShapePriorWeight scales the shape prior term values.

Definition at line 96 of file itkShapePriorSegmentationLevelSetFunction.h.

Member Data Documentation

◆ ImageDimension

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

Extract some parameters from the superclass.

Definition at line 88 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ m_ShapeFunction

template<typename TImageType , typename TFeatureImageType = TImageType>
ShapeFunctionPointer itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_ShapeFunction {}
private

Definition at line 166 of file itkShapePriorSegmentationLevelSetFunction.h.

◆ m_ShapePriorWeight

template<typename TImageType , typename TFeatureImageType = TImageType>
ScalarValueType itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_ShapePriorWeight {}
private

Definition at line 167 of file itkShapePriorSegmentationLevelSetFunction.h.


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