ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Types | Private Attributes | List of all members
itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer > Class Template Reference

#include <itkUpdateShiSparseLevelSet.h>

Detailed Description

template<unsigned int VDimension, typename TEquationContainer>
class itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >

Base class for updating the Shi representation of level-set function.

Template Parameters
VDimensionDimension of the input space
TEquationContainerContainer of the system of levelset equations

Definition at line 42 of file itkUpdateShiSparseLevelSet.h.

+ Inheritance diagram for itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >:
+ Collaboration diagram for itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using EquationContainerPointer = typename EquationContainerType::Pointer
 
using EquationContainerType = TEquationContainer
 
using LevelSetInputType = typename LevelSetType::InputType
 
using LevelSetLabelMapPointer = typename LevelSetType::LabelMapPointer
 
using LevelSetLabelMapType = typename LevelSetType::LabelMapType
 
using LevelSetLabelObjectLengthType = typename LevelSetType::LabelObjectLengthType
 
using LevelSetLabelObjectLineType = typename LevelSetType::LabelObjectLineType
 
using LevelSetLabelObjectPointer = typename LevelSetType::LabelObjectPointer
 
using LevelSetLabelObjectType = typename LevelSetType::LabelObjectType
 
using LevelSetLayerConstIterator = typename LevelSetType::LayerConstIterator
 
using LevelSetLayerIterator = typename LevelSetType::LayerIterator
 
using LevelSetLayerMapConstIterator = typename LevelSetType::LayerMapConstIterator
 
using LevelSetLayerMapIterator = typename LevelSetType::LayerMapIterator
 
using LevelSetLayerMapType = typename LevelSetType::LayerMapType
 
using LevelSetLayerType = typename LevelSetType::LayerType
 
using LevelSetOffsetType = typename LevelSetType::OffsetType
 
using LevelSetOutputRealType = typename LevelSetType::OutputRealType
 
using LevelSetOutputType = typename LevelSetType::OutputType
 
using LevelSetPointer = typename LevelSetType::Pointer
 
using LevelSetType = ShiSparseLevelSetImage< ImageDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = UpdateShiSparseLevelSet
 
using Superclass = Object
 
using TermContainerPointer = typename EquationContainerType::TermContainerPointer
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual LevelSetTypeGetModifiableOutputLevelSet ()
 
virtual LevelSetOutputRealType GetRMSChangeAccumulator ()
 
 itkOverrideGetNameOfClassMacro (UpdateShiSparseLevelSet)
 
void Update ()
 
virtual void SetInputLevelSet (LevelSetType *_arg)
 
virtual LevelSetTypeGetModifiableInputLevelSet ()
 
virtual void SetEquationContainer (EquationContainerType *_arg)
 
virtual EquationContainerTypeGetModifiableEquationContainer ()
 
virtual void SetCurrentLevelSetId (IdentifierType _arg)
 
virtual IdentifierType GetCurrentLevelSetId ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
 itkOverrideGetNameOfClassMacro (Object)
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = VDimension
 

Protected Types

using LabelImagePointer = typename LabelImageType::Pointer
 
using LabelImageType = Image< int8_t, ImageDimension >
 
using NeighborhoodIteratorType = ShapedNeighborhoodIterator< LabelImageType >
 

Protected Member Functions

bool Con (const LevelSetInputType &idx, const LevelSetOutputType &currentStatus, const LevelSetOutputRealType &currentUpdate) const
 
void UpdateLayerMinusOne ()
 
void UpdateLayerPlusOne ()
 
 UpdateShiSparseLevelSet ()
 
 ~UpdateShiSparseLevelSet () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- 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

IdentifierType m_CurrentLevelSetId {}
 
EquationContainerPointer m_EquationContainer {}
 
LabelImagePointer m_InternalImage {}
 
LevelSetPointer m_OutputLevelSet {}
 
LevelSetOutputRealType m_RMSChangeAccumulator {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Private Types

using NodePairType = std::pair< LevelSetInputType, LevelSetOutputType >
 

Private Attributes

LevelSetPointer m_InputLevelSet {}
 
LevelSetOffsetType m_Offset {}
 

Member Typedef Documentation

◆ ConstPointer

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::ConstPointer = SmartPointer<const Self>

Definition at line 49 of file itkUpdateShiSparseLevelSet.h.

◆ EquationContainerPointer

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::EquationContainerPointer = typename EquationContainerType::Pointer

Definition at line 84 of file itkUpdateShiSparseLevelSet.h.

◆ EquationContainerType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::EquationContainerType = TEquationContainer

Definition at line 83 of file itkUpdateShiSparseLevelSet.h.

◆ LabelImagePointer

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LabelImagePointer = typename LabelImageType::Pointer
protected

Definition at line 123 of file itkUpdateShiSparseLevelSet.h.

◆ LabelImageType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LabelImageType = Image<int8_t, ImageDimension>
protected

Definition at line 122 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetInputType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetInputType = typename LevelSetType::InputType

Definition at line 62 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetLabelMapPointer

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetLabelMapPointer = typename LevelSetType::LabelMapPointer

Definition at line 67 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetLabelMapType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetLabelMapType = typename LevelSetType::LabelMapType

Definition at line 66 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetLabelObjectLengthType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetLabelObjectLengthType = typename LevelSetType::LabelObjectLengthType

Definition at line 71 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetLabelObjectLineType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetLabelObjectLineType = typename LevelSetType::LabelObjectLineType

Definition at line 72 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetLabelObjectPointer

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetLabelObjectPointer = typename LevelSetType::LabelObjectPointer

Definition at line 70 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetLabelObjectType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetLabelObjectType = typename LevelSetType::LabelObjectType

Definition at line 69 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetLayerConstIterator

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetLayerConstIterator = typename LevelSetType::LayerConstIterator

Definition at line 76 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetLayerIterator

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetLayerIterator = typename LevelSetType::LayerIterator

Definition at line 75 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetLayerMapConstIterator

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetLayerMapConstIterator = typename LevelSetType::LayerMapConstIterator

Definition at line 81 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetLayerMapIterator

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetLayerMapIterator = typename LevelSetType::LayerMapIterator

Definition at line 80 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetLayerMapType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetLayerMapType = typename LevelSetType::LayerMapType

Definition at line 79 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetLayerType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetLayerType = typename LevelSetType::LayerType

Definition at line 74 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetOffsetType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetOffsetType = typename LevelSetType::OffsetType

Definition at line 64 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetOutputRealType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetOutputRealType = typename LevelSetType::OutputRealType

Definition at line 77 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetOutputType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetOutputType = typename LevelSetType::OutputType

Definition at line 63 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetPointer

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetPointer = typename LevelSetType::Pointer

Definition at line 61 of file itkUpdateShiSparseLevelSet.h.

◆ LevelSetType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::LevelSetType = ShiSparseLevelSetImage<ImageDimension>

Definition at line 60 of file itkUpdateShiSparseLevelSet.h.

◆ NeighborhoodIteratorType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::NeighborhoodIteratorType = ShapedNeighborhoodIterator<LabelImageType>
protected

Definition at line 127 of file itkUpdateShiSparseLevelSet.h.

◆ NodePairType

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::NodePairType = std::pair<LevelSetInputType, LevelSetOutputType>
private

Definition at line 151 of file itkUpdateShiSparseLevelSet.h.

◆ Pointer

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::Pointer = SmartPointer<Self>

Definition at line 48 of file itkUpdateShiSparseLevelSet.h.

◆ Self

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::Self = UpdateShiSparseLevelSet

Definition at line 47 of file itkUpdateShiSparseLevelSet.h.

◆ Superclass

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::Superclass = Object

Definition at line 50 of file itkUpdateShiSparseLevelSet.h.

◆ TermContainerPointer

template<unsigned int VDimension, typename TEquationContainer >
using itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::TermContainerPointer = typename EquationContainerType::TermContainerPointer

Definition at line 85 of file itkUpdateShiSparseLevelSet.h.

Constructor & Destructor Documentation

◆ UpdateShiSparseLevelSet()

template<unsigned int VDimension, typename TEquationContainer >
itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::UpdateShiSparseLevelSet ( )
protected

◆ ~UpdateShiSparseLevelSet()

template<unsigned int VDimension, typename TEquationContainer >
itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::~UpdateShiSparseLevelSet ( )
overrideprotecteddefault

Member Function Documentation

◆ Con()

template<unsigned int VDimension, typename TEquationContainer >
bool itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::Con ( const LevelSetInputType idx,
const LevelSetOutputType currentStatus,
const LevelSetOutputRealType currentUpdate 
) const
protected

Return true if there is a pixel from the opposite layer (+1 or -1) moving in the same direction

◆ GetCurrentLevelSetId()

template<unsigned int VDimension, typename TEquationContainer >
virtual IdentifierType itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::GetCurrentLevelSetId ( )
virtual

Set/Get the current level set id

◆ GetModifiableEquationContainer()

template<unsigned int VDimension, typename TEquationContainer >
virtual EquationContainerType* itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::GetModifiableEquationContainer ( )
virtual

Set/Get the Equation container for computing the update

◆ GetModifiableInputLevelSet()

template<unsigned int VDimension, typename TEquationContainer >
virtual LevelSetType* itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::GetModifiableInputLevelSet ( )
virtual

Set/Get the sparse level set image

◆ GetModifiableOutputLevelSet()

template<unsigned int VDimension, typename TEquationContainer >
virtual LevelSetType* itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::GetModifiableOutputLevelSet ( )
virtual

◆ GetRMSChangeAccumulator()

template<unsigned int VDimension, typename TEquationContainer >
virtual LevelSetOutputRealType itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::GetRMSChangeAccumulator ( )
virtual

Set/Get the RMS change for the update

◆ itkOverrideGetNameOfClassMacro()

template<unsigned int VDimension, typename TEquationContainer >
itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::itkOverrideGetNameOfClassMacro ( UpdateShiSparseLevelSet< VDimension, TEquationContainer >  )

Run-time type information

◆ New()

template<unsigned int VDimension, typename TEquationContainer >
static Pointer itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::New ( )
static

Method for creation through object factory

◆ SetCurrentLevelSetId()

template<unsigned int VDimension, typename TEquationContainer >
virtual void itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::SetCurrentLevelSetId ( IdentifierType  _arg)
virtual

Set/Get the current level set id

◆ SetEquationContainer()

template<unsigned int VDimension, typename TEquationContainer >
virtual void itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::SetEquationContainer ( EquationContainerType _arg)
virtual

Set/Get the Equation container for computing the update

◆ SetInputLevelSet()

template<unsigned int VDimension, typename TEquationContainer >
virtual void itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::SetInputLevelSet ( LevelSetType _arg)
virtual

Set/Get the sparse level set image

◆ Update()

template<unsigned int VDimension, typename TEquationContainer >
void itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::Update ( )

Update function for initializing and computing the output level set

◆ UpdateLayerMinusOne()

template<unsigned int VDimension, typename TEquationContainer >
void itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::UpdateLayerMinusOne ( )
protected

Update -1 level set layers by checking the direction of the movement towards +1

◆ UpdateLayerPlusOne()

template<unsigned int VDimension, typename TEquationContainer >
void itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::UpdateLayerPlusOne ( )
protected

Update +1 level set layers by checking the direction of the movement towards -1

Member Data Documentation

◆ ImageDimension

template<unsigned int VDimension, typename TEquationContainer >
constexpr unsigned int itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::ImageDimension = VDimension
staticconstexpr

Definition at line 58 of file itkUpdateShiSparseLevelSet.h.

◆ m_CurrentLevelSetId

template<unsigned int VDimension, typename TEquationContainer >
IdentifierType itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::m_CurrentLevelSetId {}
protected

Definition at line 118 of file itkUpdateShiSparseLevelSet.h.

◆ m_EquationContainer

template<unsigned int VDimension, typename TEquationContainer >
EquationContainerPointer itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::m_EquationContainer {}
protected

Definition at line 120 of file itkUpdateShiSparseLevelSet.h.

◆ m_InputLevelSet

template<unsigned int VDimension, typename TEquationContainer >
LevelSetPointer itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::m_InputLevelSet {}
private

Definition at line 148 of file itkUpdateShiSparseLevelSet.h.

◆ m_InternalImage

template<unsigned int VDimension, typename TEquationContainer >
LabelImagePointer itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::m_InternalImage {}
protected

Definition at line 125 of file itkUpdateShiSparseLevelSet.h.

◆ m_Offset

template<unsigned int VDimension, typename TEquationContainer >
LevelSetOffsetType itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::m_Offset {}
private

Definition at line 149 of file itkUpdateShiSparseLevelSet.h.

◆ m_OutputLevelSet

template<unsigned int VDimension, typename TEquationContainer >
LevelSetPointer itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::m_OutputLevelSet {}
protected

Definition at line 116 of file itkUpdateShiSparseLevelSet.h.

◆ m_RMSChangeAccumulator

template<unsigned int VDimension, typename TEquationContainer >
LevelSetOutputRealType itk::UpdateShiSparseLevelSet< VDimension, TEquationContainer >::m_RMSChangeAccumulator {}
protected

Definition at line 119 of file itkUpdateShiSparseLevelSet.h.


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