ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
itk::ShiSparseLevelSetImage< VDimension > Class Template Reference
Group Segmentation » Module ITKLevelSetsv4

#include <itkShiSparseLevelSetImage.h>

Detailed Description

template<unsigned int VDimension>
class itk::ShiSparseLevelSetImage< VDimension >

Derived class for the shi representation of level-set function.

This representation is a "sparse" level-set function, where values could only be { -3, -1, +1, +3 } and organized into 2 layers { -1, +1 }.

Template Parameters
VDimensionDimension of the input space

Definition at line 37 of file itkShiSparseLevelSetImage.h.

+ Inheritance diagram for itk::ShiSparseLevelSetImage< VDimension >:
+ Collaboration diagram for itk::ShiSparseLevelSetImage< VDimension >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = ShiSparseLevelSetImage
 
using Superclass = LevelSetSparseImage< int8_t, VDimension >
 
- Public Types inherited from itk::LevelSetSparseImage< int8_t, VDimension >
using ConstPointer = SmartPointer< const Self >
 
using LabelMapConstPointer = typename LabelMapType::ConstPointer
 
using LabelMapPointer = typename LabelMapType::Pointer
 
using LabelMapType = LabelMap< LabelObjectType >
 
using LabelObjectLengthType = typename LabelObjectType::LengthType
 
using LabelObjectLineType = typename LabelObjectType::LineType
 
using LabelObjectPointer = typename LabelObjectType::Pointer
 
using LabelObjectType = LabelObject< LayerIdType, VDimension >
 
using LayerConstIterator = typename LayerType::const_iterator
 
using LayerIdListType = std::list< LayerIdType >
 
using LayerIdType = int8_t
 
using LayerIterator = typename LayerType::iterator
 
using LayerMapConstIterator = typename LayerMapType::const_iterator
 
using LayerMapIterator = typename LayerMapType::iterator
 
using LayerMapType = std::map< LayerIdType, LayerType >
 
using LayerType = std::map< InputType, OutputType, Functor::LexicographicCompare >
 
using Pointer = SmartPointer< Self >
 
using RegionType = typename LabelMapType::RegionType
 
using Self = LevelSetSparseImage
 
using Superclass = DiscreteLevelSetImage< int8_t, VDimension >
 
- Public Types inherited from itk::DiscreteLevelSetImage< int8_t, VDimension >
using ConstPointer = SmartPointer< const Self >
 
using IndexType = Index< VDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = DiscreteLevelSetImage
 
using Superclass = LevelSetImage< IndexType, VDimension, int8_t >
 
- Public Types inherited from itk::LevelSetImage< Index< VDimension >, VDimension, int8_t >
using ConstPointer = SmartPointer< const Self >
 
using ImageBaseType = ImageBase< VDimension >
 
using OffsetType = typename ImageBaseType::OffsetType
 
using OffsetValueType = typename ImageBaseType::OffsetValueType
 
using Pointer = SmartPointer< Self >
 
using Self = LevelSetImage
 
using Superclass = LevelSetBase< Index< VDimension >, VDimension, int8_t, ImageBaseType >
 
- Public Types inherited from itk::LevelSetBase< Index< VDimension >, VDimension, int8_t, ImageBase< VDimension > >
using ConstPointer = SmartPointer< const Self >
 
using DomainType = ImageBase< VDimension >
 
using GradientType = CovariantVector< OutputRealType, VDimension >
 
using HessianType = Matrix< OutputRealType, VDimension, VDimension >
 
using InputType = Index< VDimension >
 
using OutputRealType = typename NumericTraits< OutputType >::RealType
 
using OutputType = int8_t
 
using Pointer = SmartPointer< Self >
 
using RegionType = IdentifierType
 
using Self = LevelSetBase
 
using Superclass = DataObject
 
- Public Types inherited from itk::DataObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = std::string
 
using DataObjectPointerArraySizeType = std::vector< Pointer >::size_type
 
using Pointer = SmartPointer< Self >
 
using Self = DataObject
 
using Superclass = Object
 
- 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

OutputType Evaluate (const InputType &inputIndex) const override
 
HessianType EvaluateHessian (const InputType &inputIndex) const override
 
void EvaluateHessian (const InputType &inputIndex, LevelSetDataType &data) const override
 
OutputRealType EvaluateLaplacian (const InputType &inputIndex) const override
 
void EvaluateLaplacian (const InputType &inputIndex, LevelSetDataType &data) const override
 
OutputRealType EvaluateMeanCurvature (const InputType &inputIndex) const override
 
void EvaluateMeanCurvature (const InputType &inputIndex, LevelSetDataType &data) const override
 
const char * GetNameOfClass () const override
 
- Public Member Functions inherited from itk::LevelSetSparseImage< int8_t, VDimension >
LabelObject< TLabel, VDimension >::Pointer GetAsLabelObject ()
 
LayerType & GetLayer (LayerIdType value)
 
const LayerType & GetLayer (LayerIdType value) const
 
const char * GetNameOfClass () const override
 
void Graft (const DataObject *data) override
 
void SetLayer (LayerIdType value, const LayerType &layer)
 
virtual LayerIdType Status (const InputType &inputIndex) const
 
virtual void SetLabelMap (LabelMapType *labelMap)
 
virtual LabelMapType * GetModifiableLabelMap ()
 
- Public Member Functions inherited from itk::DiscreteLevelSetImage< int8_t, VDimension >
OutputType Evaluate (const InputType &inputIndex) const override=0
 
void Evaluate (const InputType &inputIndex, LevelSetDataType &data) const override
 
virtual GradientType EvaluateBackwardGradient (const InputType &inputIndex) const
 
void EvaluateBackwardGradient (const InputType &inputIndex, LevelSetDataType &data) const override
 
virtual GradientType EvaluateForwardGradient (const InputType &inputIndex) const
 
void EvaluateForwardGradient (const InputType &inputIndex, LevelSetDataType &data) const override
 
GradientType EvaluateGradient (const InputType &inputIndex) const override
 
void EvaluateGradient (const InputType &inputIndex, LevelSetDataType &data) const override
 
HessianType EvaluateHessian (const InputType &inputIndex) const override
 
void EvaluateHessian (const InputType &inputIndex, LevelSetDataType &data) const override
 
OutputRealType EvaluateLaplacian (const InputType &inputIndex) const override
 
void EvaluateLaplacian (const InputType &inputIndex, LevelSetDataType &data) const override
 
OutputRealType EvaluateMeanCurvature (const InputType &inputIndex) const override
 
void EvaluateMeanCurvature (const InputType &inputIndex, LevelSetDataType &data) const override
 
const char * GetNameOfClass () const override
 
- Public Member Functions inherited from itk::LevelSetImage< Index< VDimension >, VDimension, int8_t >
virtual OffsetType GetDomainOffset () const
 
const char * GetNameOfClass () const override
 
virtual void SetDomainOffset (OffsetType _arg)
 
- Public Member Functions inherited from itk::LevelSetBase< Index< VDimension >, VDimension, int8_t, ImageBase< VDimension > >
virtual OutputType Evaluate (const InputType &iP) const=0
 
virtual GradientType EvaluateGradient (const InputType &iP) const=0
 
virtual OutputRealType EvaluateGradientNorm (const InputType &iP) const
 
virtual HessianType EvaluateHessian (const InputType &iP) const=0
 
virtual OutputRealType EvaluateLaplacian (const InputType &iP) const=0
 
virtual OutputRealType EvaluateMeanCurvature (const InputType &iP) const=0
 
const char * GetNameOfClass () const override
 
virtual void EvaluateGradientNorm (const InputType &iP, LevelSetDataType &ioData) const
 
virtual bool IsInside (const InputType &iP) const
 
virtual RegionType GetMaximumNumberOfRegions () const
 
void UpdateOutputInformation () override
 
void SetRequestedRegionToLargestPossibleRegion () override
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
bool VerifyRequestedRegion () override
 
void SetRequestedRegion (const DataObject *data) override
 
virtual void SetRequestedRegion (const RegionType &region)
 
virtual RegionType GetRequestedRegion () const
 
virtual void SetBufferedRegion (const RegionType &region)
 
virtual RegionType GetBufferedRegion () const
 
- Public Member Functions inherited from itk::DataObject
virtual void CopyInformation (const DataObject *)
 
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
const char * GetNameOfClass () const override
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObject > GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierType & GetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Graft (const DataObject *)
 
virtual void Initialize ()
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOn ()
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
virtual void SetRequestedRegion (const DataObject *)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
void UpdateSource () const
 
virtual bool VerifyRequestedRegion ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeType & GetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStamp & GetRealTimeStamp () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) 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
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
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 Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
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 LayerIdType MinusOneLayer ()
 
static LayerIdType MinusThreeLayer ()
 
static Pointer New ()
 
static LayerIdType PlusOneLayer ()
 
static LayerIdType PlusThreeLayer ()
 
- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static Pointer New ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- 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 Dimension = VDimension
 
- Static Public Attributes inherited from itk::LevelSetSparseImage< int8_t, VDimension >
static constexpr unsigned int Dimension
 
- Static Public Attributes inherited from itk::DiscreteLevelSetImage< int8_t, VDimension >
static constexpr unsigned int Dimension
 
- Static Public Attributes inherited from itk::LevelSetImage< Index< VDimension >, VDimension, int8_t >
static constexpr unsigned int Dimension
 
- Static Public Attributes inherited from itk::LevelSetBase< Index< VDimension >, VDimension, int8_t, ImageBase< VDimension > >
static constexpr unsigned int Dimension
 

Protected Member Functions

void InitializeInternalLabelList () override
 
void InitializeLayers () override
 
 ShiSparseLevelSetImage ()
 
 ~ShiSparseLevelSetImage () override=default
 
- Protected Member Functions inherited from itk::LevelSetSparseImage< int8_t, VDimension >
void CopyInformation (const DataObject *data) override
 
void Initialize () override
 
virtual void InitializeInternalLabelList ()=0
 
virtual void InitializeLayers ()=0
 
bool IsInsideDomain (const InputType &inputIndex) const override
 
 LevelSetSparseImage ()=default
 
 ~LevelSetSparseImage () override=default
 
- Protected Member Functions inherited from itk::DiscreteLevelSetImage< int8_t, VDimension >
void CopyInformation (const DataObject *data) override
 
 DiscreteLevelSetImage ()=default
 
void Graft (const DataObject *data) override
 
void Initialize () override
 
 ~DiscreteLevelSetImage () override=default
 
- Protected Member Functions inherited from itk::LevelSetImage< Index< VDimension >, VDimension, int8_t >
virtual bool IsInsideDomain (const InputType &iP) const=0
 
 LevelSetImage ()
 
 ~LevelSetImage () override=default
 
- Protected Member Functions inherited from itk::LevelSetBase< Index< VDimension >, VDimension, int8_t, ImageBase< VDimension > >
 LevelSetBase ()
 
 ~LevelSetBase () override=default
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void PropagateResetPipeline ()
 
 ~DataObject () override
 
- 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 PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Additional Inherited Members

- Protected Types inherited from itk::LevelSetImage< Index< VDimension >, VDimension, int8_t >
using ScalingType = GradientType
 
- Protected Attributes inherited from itk::LevelSetSparseImage< int8_t, VDimension >
LayerIdListType m_InternalLabelList
 
LabelMapPointer m_LabelMap
 
LayerMapType m_Layers
 
- Protected Attributes inherited from itk::LevelSetImage< Index< VDimension >, VDimension, int8_t >
OffsetType m_DomainOffset
 
ScalingType m_NeighborhoodScales
 
- Protected Attributes inherited from itk::LevelSetBase< Index< VDimension >, VDimension, int8_t, ImageBase< VDimension > >
RegionType m_MaximumNumberOfRegions
 
RegionType m_NumberOfRegions
 
RegionType m_RequestedNumberOfRegions
 
RegionType m_BufferedRegion
 
RegionType m_RequestedRegion
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<unsigned int VDimension>
using itk::ShiSparseLevelSetImage< VDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 44 of file itkShiSparseLevelSetImage.h.

◆ Pointer

template<unsigned int VDimension>
using itk::ShiSparseLevelSetImage< VDimension >::Pointer = SmartPointer<Self>

Definition at line 43 of file itkShiSparseLevelSetImage.h.

◆ Self

template<unsigned int VDimension>
using itk::ShiSparseLevelSetImage< VDimension >::Self = ShiSparseLevelSetImage

Definition at line 42 of file itkShiSparseLevelSetImage.h.

◆ Superclass

template<unsigned int VDimension>
using itk::ShiSparseLevelSetImage< VDimension >::Superclass = LevelSetSparseImage<int8_t, VDimension>

Definition at line 45 of file itkShiSparseLevelSetImage.h.

Constructor & Destructor Documentation

◆ ShiSparseLevelSetImage()

template<unsigned int VDimension>
itk::ShiSparseLevelSetImage< VDimension >::ShiSparseLevelSetImage ( )
protected

◆ ~ShiSparseLevelSetImage()

template<unsigned int VDimension>
itk::ShiSparseLevelSetImage< VDimension >::~ShiSparseLevelSetImage ( )
overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<unsigned int VDimension>
OutputType itk::ShiSparseLevelSetImage< VDimension >::Evaluate ( const InputType &  inputIndex) const
overridevirtual

Returns the gradient of the level set function at a given location inputIndex

Implements itk::DiscreteLevelSetImage< int8_t, VDimension >.

◆ EvaluateHessian() [1/2]

template<unsigned int VDimension>
HessianType itk::ShiSparseLevelSetImage< VDimension >::EvaluateHessian ( const InputType &  inputIndex) const
overridevirtual

Returns the Hessian of the level set function at a given location inputIndex

Implements itk::LevelSetBase< Index< VDimension >, VDimension, int8_t, ImageBase< VDimension > >.

◆ EvaluateHessian() [2/2]

template<unsigned int VDimension>
void itk::ShiSparseLevelSetImage< VDimension >::EvaluateHessian ( const InputType &  iP,
LevelSetDataType &  ioData 
) const
overridevirtual

Returns true if iP is inside the level set, i.e. \(\phi(p) \le 0 \)

Implements itk::LevelSetBase< Index< VDimension >, VDimension, int8_t, ImageBase< VDimension > >.

◆ EvaluateLaplacian() [1/2]

template<unsigned int VDimension>
OutputRealType itk::ShiSparseLevelSetImage< VDimension >::EvaluateLaplacian ( const InputType &  inputIndex) const
overridevirtual

Returns the Laplacian of the level set function at a given location inputIndex

Implements itk::LevelSetBase< Index< VDimension >, VDimension, int8_t, ImageBase< VDimension > >.

◆ EvaluateLaplacian() [2/2]

template<unsigned int VDimension>
void itk::ShiSparseLevelSetImage< VDimension >::EvaluateLaplacian ( const InputType &  iP,
LevelSetDataType &  ioData 
) const
overridevirtual

Returns true if iP is inside the level set, i.e. \(\phi(p) \le 0 \)

Implements itk::LevelSetBase< Index< VDimension >, VDimension, int8_t, ImageBase< VDimension > >.

◆ EvaluateMeanCurvature() [1/2]

template<unsigned int VDimension>
OutputRealType itk::ShiSparseLevelSetImage< VDimension >::EvaluateMeanCurvature ( const InputType &  inputIndex) const
overridevirtual

Returns the Laplacian of the level set function at a given location inputIndex

Implements itk::LevelSetBase< Index< VDimension >, VDimension, int8_t, ImageBase< VDimension > >.

◆ EvaluateMeanCurvature() [2/2]

template<unsigned int VDimension>
void itk::ShiSparseLevelSetImage< VDimension >::EvaluateMeanCurvature ( const InputType &  iP,
LevelSetDataType &  ioData 
) const
overridevirtual

Returns true if iP is inside the level set, i.e. \(\phi(p) \le 0 \)

Reimplemented from itk::LevelSetBase< Index< VDimension >, VDimension, int8_t, ImageBase< VDimension > >.

◆ GetNameOfClass()

template<unsigned int VDimension>
const char * itk::ShiSparseLevelSetImage< VDimension >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::DataObject.

◆ InitializeInternalLabelList()

template<unsigned int VDimension>
void itk::ShiSparseLevelSetImage< VDimension >::InitializeInternalLabelList ( )
overrideprotectedvirtual

Implements itk::LevelSetSparseImage< int8_t, VDimension >.

◆ InitializeLayers()

template<unsigned int VDimension>
void itk::ShiSparseLevelSetImage< VDimension >::InitializeLayers ( )
overrideprotectedvirtual

Initialize the sparse field layers

Implements itk::LevelSetSparseImage< int8_t, VDimension >.

◆ MinusOneLayer()

template<unsigned int VDimension>
static LayerIdType itk::ShiSparseLevelSetImage< VDimension >::MinusOneLayer ( )
inlinestatic

Definition at line 110 of file itkShiSparseLevelSetImage.h.

◆ MinusThreeLayer()

template<unsigned int VDimension>
static LayerIdType itk::ShiSparseLevelSetImage< VDimension >::MinusThreeLayer ( )
inlinestatic

Definition at line 105 of file itkShiSparseLevelSetImage.h.

◆ New()

template<unsigned int VDimension>
static Pointer itk::ShiSparseLevelSetImage< VDimension >::New ( )
static

Method for creation through the object factory.

◆ PlusOneLayer()

template<unsigned int VDimension>
static LayerIdType itk::ShiSparseLevelSetImage< VDimension >::PlusOneLayer ( )
inlinestatic

Definition at line 115 of file itkShiSparseLevelSetImage.h.

◆ PlusThreeLayer()

template<unsigned int VDimension>
static LayerIdType itk::ShiSparseLevelSetImage< VDimension >::PlusThreeLayer ( )
inlinestatic

Definition at line 120 of file itkShiSparseLevelSetImage.h.

Member Data Documentation

◆ Dimension

template<unsigned int VDimension>
constexpr unsigned int itk::ShiSparseLevelSetImage< VDimension >::Dimension = VDimension
staticconstexpr

Definition at line 53 of file itkShiSparseLevelSetImage.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3