ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::LevelSetSparseImage< TOutput, VDimension > Class Template Referenceabstract

#include <itkLevelSetSparseImage.h>

Detailed Description

template<typename TOutput, unsigned int VDimension>
class itk::LevelSetSparseImage< TOutput, VDimension >

Base class for the sparse representation of a level-set function on one Image.

Template Parameters
TImageInput image type of the level set function
Todo:
Think about using image iterators instead of GetPixel()

Definition at line 42 of file itkLevelSetSparseImage.h.

+ Inheritance diagram for itk::LevelSetSparseImage< TOutput, VDimension >:
+ Collaboration diagram for itk::LevelSetSparseImage< TOutput, VDimension >:

Public Types

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< TOutput, VDimension >
 
- Public Types inherited from itk::DiscreteLevelSetImage< TOutput, VDimension >
using ConstPointer = SmartPointer< const Self >
 
using IndexType = Index< VDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = DiscreteLevelSetImage
 
using Superclass = LevelSetImage< IndexType, VDimension, TOutput >
 
- Public Types inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TOutput >
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, TOutput, ImageBaseType >
 
- Public Types inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, 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 = TOutput
 
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

template<typename TLabel >
LabelObject< TLabel, VDimension >::Pointer GetAsLabelObject ()
 
LayerTypeGetLayer (LayerIdType value)
 
const LayerTypeGetLayer (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 LabelMapTypeGetModifiableLabelMap ()
 
- Public Member Functions inherited from itk::DiscreteLevelSetImage< TOutput, 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
 
- Public Member Functions inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TOutput >
virtual OffsetType GetDomainOffset () const
 
const char * GetNameOfClass () const override
 
virtual void SetDomainOffset (OffsetType _arg)
 
- Public Member Functions inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >
virtual OutputRealType EvaluateGradientNorm (const InputType &iP) const
 
virtual void EvaluateGradientNorm (const InputType &iP, LevelSetDataType &ioData) const
 
virtual bool IsInside (const InputType &iP) const
 
virtual RegionType GetMaximumNumberOfRegions () const
 
void Initialize () override
 
void UpdateOutputInformation () override
 
void SetRequestedRegionToLargestPossibleRegion () override
 
void CopyInformation (const DataObject *data) override
 
void Graft (const DataObject *data) 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 DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObjectGetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
void UpdateSource () const
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () const
 
- 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
 
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
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Attributes

static constexpr unsigned int Dimension = Superclass::Dimension
 
- Static Public Attributes inherited from itk::DiscreteLevelSetImage< TOutput, VDimension >
static constexpr unsigned int Dimension = Superclass::Dimension
 
- Static Public Attributes inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TOutput >
static constexpr unsigned int Dimension
 
- Static Public Attributes inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >
static constexpr unsigned int Dimension
 

Protected Member Functions

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< TOutput, VDimension >
 DiscreteLevelSetImage ()=default
 
 ~DiscreteLevelSetImage () override=default
 
- Protected Member Functions inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TOutput >
 LevelSetImage ()
 
 ~LevelSetImage () override=default
 
- Protected Member Functions inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, 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 PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

LayerIdListType m_InternalLabelList {}
 
LabelMapPointer m_LabelMap {}
 
LayerMapType m_Layers {}
 
- Protected Attributes inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TOutput >
OffsetType m_DomainOffset
 
ScalingType m_NeighborhoodScales
 
- Protected Attributes inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, 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 {}
 

Additional Inherited Members

- 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 ()
 
- Protected Types inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TOutput >
using ScalingType = GradientType
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 49 of file itkLevelSetSparseImage.h.

◆ LabelMapConstPointer

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LabelMapConstPointer = typename LabelMapType::ConstPointer

Definition at line 74 of file itkLevelSetSparseImage.h.

◆ LabelMapPointer

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LabelMapPointer = typename LabelMapType::Pointer

Definition at line 73 of file itkLevelSetSparseImage.h.

◆ LabelMapType

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LabelMapType = LabelMap<LabelObjectType>

Definition at line 72 of file itkLevelSetSparseImage.h.

◆ LabelObjectLengthType

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LabelObjectLengthType = typename LabelObjectType::LengthType

Definition at line 69 of file itkLevelSetSparseImage.h.

◆ LabelObjectLineType

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LabelObjectLineType = typename LabelObjectType::LineType

Definition at line 70 of file itkLevelSetSparseImage.h.

◆ LabelObjectPointer

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LabelObjectPointer = typename LabelObjectType::Pointer

Definition at line 68 of file itkLevelSetSparseImage.h.

◆ LabelObjectType

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LabelObjectType = LabelObject<LayerIdType, VDimension>

Definition at line 67 of file itkLevelSetSparseImage.h.

◆ LayerConstIterator

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LayerConstIterator = typename LayerType::const_iterator

Definition at line 79 of file itkLevelSetSparseImage.h.

◆ LayerIdListType

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LayerIdListType = std::list<LayerIdType>

Definition at line 65 of file itkLevelSetSparseImage.h.

◆ LayerIdType

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LayerIdType = int8_t

Definition at line 64 of file itkLevelSetSparseImage.h.

◆ LayerIterator

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LayerIterator = typename LayerType::iterator

Definition at line 78 of file itkLevelSetSparseImage.h.

◆ LayerMapConstIterator

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LayerMapConstIterator = typename LayerMapType::const_iterator

Definition at line 83 of file itkLevelSetSparseImage.h.

◆ LayerMapIterator

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LayerMapIterator = typename LayerMapType::iterator

Definition at line 82 of file itkLevelSetSparseImage.h.

◆ LayerMapType

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LayerMapType = std::map<LayerIdType, LayerType>

Definition at line 81 of file itkLevelSetSparseImage.h.

◆ LayerType

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::LayerType = std::map<InputType, OutputType, Functor::LexicographicCompare>

Definition at line 77 of file itkLevelSetSparseImage.h.

◆ Pointer

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::Pointer = SmartPointer<Self>

Definition at line 48 of file itkLevelSetSparseImage.h.

◆ RegionType

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::RegionType = typename LabelMapType::RegionType

Definition at line 75 of file itkLevelSetSparseImage.h.

◆ Self

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::Self = LevelSetSparseImage

Definition at line 47 of file itkLevelSetSparseImage.h.

◆ Superclass

template<typename TOutput, unsigned int VDimension>
using itk::LevelSetSparseImage< TOutput, VDimension >::Superclass = DiscreteLevelSetImage<TOutput, VDimension>

Definition at line 50 of file itkLevelSetSparseImage.h.

Constructor & Destructor Documentation

◆ LevelSetSparseImage()

template<typename TOutput, unsigned int VDimension>
itk::LevelSetSparseImage< TOutput, VDimension >::LevelSetSparseImage ( )
protecteddefault

◆ ~LevelSetSparseImage()

template<typename TOutput, unsigned int VDimension>
itk::LevelSetSparseImage< TOutput, VDimension >::~LevelSetSparseImage ( )
overrideprotecteddefault

Member Function Documentation

◆ CopyInformation()

template<typename TOutput, unsigned int VDimension>
void itk::LevelSetSparseImage< TOutput, VDimension >::CopyInformation ( const DataObject data)
overrideprotectedvirtual

Copy level set information from data object

Reimplemented from itk::DiscreteLevelSetImage< TOutput, VDimension >.

◆ GetAsLabelObject()

template<typename TOutput, unsigned int VDimension>
template<typename TLabel >
LabelObject<TLabel, VDimension>::Pointer itk::LevelSetSparseImage< TOutput, VDimension >::GetAsLabelObject ( )

Return the label object pointer with a given id

◆ GetLayer() [1/2]

template<typename TOutput, unsigned int VDimension>
LayerType& itk::LevelSetSparseImage< TOutput, VDimension >::GetLayer ( LayerIdType  value)

Return the pointer to a layer map with given id

◆ GetLayer() [2/2]

template<typename TOutput, unsigned int VDimension>
const LayerType& itk::LevelSetSparseImage< TOutput, VDimension >::GetLayer ( LayerIdType  value) const

Return the const reference to a layer map with given id

◆ GetModifiableLabelMap()

template<typename TOutput, unsigned int VDimension>
virtual LabelMapType* itk::LevelSetSparseImage< TOutput, VDimension >::GetModifiableLabelMap ( )
virtual

Set/Get the label map for computing the sparse representation

◆ GetNameOfClass()

template<typename TOutput, unsigned int VDimension>
const char* itk::LevelSetSparseImage< TOutput, VDimension >::GetNameOfClass ( ) const
overridevirtual

◆ Graft()

template<typename TOutput, unsigned int VDimension>
void itk::LevelSetSparseImage< TOutput, VDimension >::Graft ( const DataObject data)
overridevirtual

Graft data object as level set object

Reimplemented from itk::DiscreteLevelSetImage< TOutput, VDimension >.

◆ Initialize()

template<typename TOutput, unsigned int VDimension>
void itk::LevelSetSparseImage< TOutput, VDimension >::Initialize ( )
overrideprotectedvirtual

Initialize the label map point and the sparse-field layers

Reimplemented from itk::DiscreteLevelSetImage< TOutput, VDimension >.

◆ InitializeInternalLabelList()

template<typename TOutput, unsigned int VDimension>
virtual void itk::LevelSetSparseImage< TOutput, VDimension >::InitializeInternalLabelList ( )
protectedpure virtual

◆ InitializeLayers()

template<typename TOutput, unsigned int VDimension>
virtual void itk::LevelSetSparseImage< TOutput, VDimension >::InitializeLayers ( )
protectedpure virtual

◆ IsInsideDomain()

template<typename TOutput, unsigned int VDimension>
bool itk::LevelSetSparseImage< TOutput, VDimension >::IsInsideDomain ( const InputType inputIndex) const
overrideprotectedvirtual

◆ SetLabelMap()

template<typename TOutput, unsigned int VDimension>
virtual void itk::LevelSetSparseImage< TOutput, VDimension >::SetLabelMap ( LabelMapType labelMap)
virtual

Set/Get the label map for computing the sparse representation

◆ SetLayer()

template<typename TOutput, unsigned int VDimension>
void itk::LevelSetSparseImage< TOutput, VDimension >::SetLayer ( LayerIdType  value,
const LayerType layer 
)

Set a layer map with id to the given layer pointer

◆ Status()

template<typename TOutput, unsigned int VDimension>
virtual LayerIdType itk::LevelSetSparseImage< TOutput, VDimension >::Status ( const InputType inputIndex) const
virtual

Returns the layer affiliation of a given location inputIndex

Member Data Documentation

◆ Dimension

template<typename TOutput, unsigned int VDimension>
constexpr unsigned int itk::LevelSetSparseImage< TOutput, VDimension >::Dimension = Superclass::Dimension
staticconstexpr

Definition at line 55 of file itkLevelSetSparseImage.h.

◆ m_InternalLabelList

template<typename TOutput, unsigned int VDimension>
LayerIdListType itk::LevelSetSparseImage< TOutput, VDimension >::m_InternalLabelList {}
protected

Definition at line 122 of file itkLevelSetSparseImage.h.

◆ m_LabelMap

template<typename TOutput, unsigned int VDimension>
LabelMapPointer itk::LevelSetSparseImage< TOutput, VDimension >::m_LabelMap {}
protected

Definition at line 121 of file itkLevelSetSparseImage.h.

◆ m_Layers

template<typename TOutput, unsigned int VDimension>
LayerMapType itk::LevelSetSparseImage< TOutput, VDimension >::m_Layers {}
protected

Definition at line 120 of file itkLevelSetSparseImage.h.


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