ITK  5.3.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members

#include <itkWatershedSegmentTree.h>

+ Inheritance diagram for itk::watershed::SegmentTree< TScalar >:
+ Collaboration diagram for itk::watershed::SegmentTree< TScalar >:

Classes

struct  merge_comp
 
struct  merge_t
 
struct  sort_comp
 

Public Types

using ConstIterator = typename DequeType::const_iterator
 
using DequeType = std::deque< merge_t >
 
using Iterator = typename DequeType::iterator
 
using ValueType = typename DequeType::value_type
 
- 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

merge_tBack ()
 
const merge_tBack () const
 
Iterator Begin ()
 
ConstIterator Begin () const
 
void Clear ()
 
bool Empty () const
 
Iterator End ()
 
ConstIterator End () const
 
merge_tFront ()
 
const merge_tFront () const
 
void Initialize () override
 
void PopBack ()
 
void PopFront ()
 
void PushBack (const ValueType &t)
 
void PushFront (const ValueType &t)
 
DequeType::size_type Size () const
 
- Public Member Functions inherited from itk::DataObject
virtual void CopyInformation (const 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 Graft (const DataObject *)
 
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 ()
 
virtual bool VerifyRequestedRegion ()
 
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
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 SegmentTree ()=default
 
 ~SegmentTree () override=default
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
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

DequeType m_Deque
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 
using Self = SegmentTree
 
using Superclass = DataObject
 
using Pointer = SmartPointer< Self >
 
using ConstPointer = SmartPointer< const Self >
 
using ScalarType = TScalar
 
static Pointer New ()
 
virtual const char * GetNameOfClass () const
 

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 ()
 

Detailed Description

template<typename TScalar>
class itk::watershed::SegmentTree< TScalar >

A data structure for storing segment merge information used in filters of the watershed segmentation algorithm. See itk::WatershedImageFilter for an overview.

This class is the implementation of the "merge tree" referred to in the documentation for itk::WatershedImageFilter and other watershed segmentation component classes. It holds a list of merges among image segments at various saliency levels. The list is actually a representation of a binary tree, whose nodes are segments and edges are saliencies.
See also
itk::WatershedImageFilter

Definition at line 48 of file itkWatershedSegmentTree.h.

Member Typedef Documentation

◆ ConstIterator

template<typename TScalar >
using itk::watershed::SegmentTree< TScalar >::ConstIterator = typename DequeType::const_iterator

Definition at line 77 of file itkWatershedSegmentTree.h.

◆ ConstPointer

template<typename TScalar >
using itk::watershed::SegmentTree< TScalar >::ConstPointer = SmartPointer<const Self>

Define itk Smart Pointers for this object

Definition at line 57 of file itkWatershedSegmentTree.h.

◆ DequeType

template<typename TScalar >
using itk::watershed::SegmentTree< TScalar >::DequeType = std::deque<merge_t>

Define the container type used in this list data structure

Definition at line 75 of file itkWatershedSegmentTree.h.

◆ Iterator

template<typename TScalar >
using itk::watershed::SegmentTree< TScalar >::Iterator = typename DequeType::iterator

Definition at line 76 of file itkWatershedSegmentTree.h.

◆ Pointer

template<typename TScalar >
using itk::watershed::SegmentTree< TScalar >::Pointer = SmartPointer<Self>

Define itk Smart Pointers for this object

Definition at line 56 of file itkWatershedSegmentTree.h.

◆ ScalarType

template<typename TScalar >
using itk::watershed::SegmentTree< TScalar >::ScalarType = TScalar

Define itk Smart Pointers for this object

Definition at line 60 of file itkWatershedSegmentTree.h.

◆ Self

template<typename TScalar >
using itk::watershed::SegmentTree< TScalar >::Self = SegmentTree

Define itk Smart Pointers for this object

Definition at line 54 of file itkWatershedSegmentTree.h.

◆ Superclass

template<typename TScalar >
using itk::watershed::SegmentTree< TScalar >::Superclass = DataObject

Define itk Smart Pointers for this object

Definition at line 55 of file itkWatershedSegmentTree.h.

◆ ValueType

template<typename TScalar >
using itk::watershed::SegmentTree< TScalar >::ValueType = typename DequeType::value_type

Definition at line 78 of file itkWatershedSegmentTree.h.

Constructor & Destructor Documentation

◆ SegmentTree()

template<typename TScalar >
itk::watershed::SegmentTree< TScalar >::SegmentTree ( )
protecteddefault

◆ ~SegmentTree()

template<typename TScalar >
itk::watershed::SegmentTree< TScalar >::~SegmentTree ( )
overrideprotecteddefault

Member Function Documentation

◆ Back() [1/2]

template<typename TScalar >
merge_t& itk::watershed::SegmentTree< TScalar >::Back ( )
inline

Returns a reference to the back of the list

Definition at line 142 of file itkWatershedSegmentTree.h.

◆ Back() [2/2]

template<typename TScalar >
const merge_t& itk::watershed::SegmentTree< TScalar >::Back ( ) const
inline

Returns a const reference to the back of the list (node with the greatest saliency value).

Definition at line 128 of file itkWatershedSegmentTree.h.

◆ Begin() [1/2]

template<typename TScalar >
Iterator itk::watershed::SegmentTree< TScalar >::Begin ( )
inline

Returns an iterator pointing to the first element in the list.

Definition at line 177 of file itkWatershedSegmentTree.h.

◆ Begin() [2/2]

template<typename TScalar >
ConstIterator itk::watershed::SegmentTree< TScalar >::Begin ( ) const
inline

Returns a const iterator pointing to the first element in the list.

Definition at line 184 of file itkWatershedSegmentTree.h.

◆ Clear()

template<typename TScalar >
void itk::watershed::SegmentTree< TScalar >::Clear ( )
inline

Clears the Deque completely

Definition at line 207 of file itkWatershedSegmentTree.h.

◆ Empty()

template<typename TScalar >
bool itk::watershed::SegmentTree< TScalar >::Empty ( ) const
inline

Returns TRUE if the SegmentTree is empty, FALSE if the SegmentTree is not empty.

Definition at line 112 of file itkWatershedSegmentTree.h.

◆ End() [1/2]

template<typename TScalar >
Iterator itk::watershed::SegmentTree< TScalar >::End ( )
inline

Returns an iterator pointing one element past the last element in the list.

Definition at line 192 of file itkWatershedSegmentTree.h.

◆ End() [2/2]

template<typename TScalar >
ConstIterator itk::watershed::SegmentTree< TScalar >::End ( ) const
inline

Returns a const iterator pointing one element past the last element in the list.

Definition at line 200 of file itkWatershedSegmentTree.h.

◆ Front() [1/2]

template<typename TScalar >
merge_t& itk::watershed::SegmentTree< TScalar >::Front ( )
inline

Returns a reference to the front of the list

Definition at line 135 of file itkWatershedSegmentTree.h.

◆ Front() [2/2]

template<typename TScalar >
const merge_t& itk::watershed::SegmentTree< TScalar >::Front ( ) const
inline

Returns a const reference to the front of the list (node with the least saliency value).

Definition at line 120 of file itkWatershedSegmentTree.h.

◆ GetNameOfClass()

template<typename TScalar >
virtual const char* itk::watershed::SegmentTree< TScalar >::GetNameOfClass ( ) const
virtual

Define itk Smart Pointers for this object

Reimplemented from itk::DataObject.

◆ Initialize()

template<typename TScalar >
void itk::watershed::SegmentTree< TScalar >::Initialize ( )
overridevirtual

Standard DataObject routine to initialize. Returns the segment tree to a default state, deallocating memory.

Reimplemented from itk::DataObject.

◆ New()

template<typename TScalar >
static Pointer itk::watershed::SegmentTree< TScalar >::New ( )
static

Define itk Smart Pointers for this object

◆ PopBack()

template<typename TScalar >
void itk::watershed::SegmentTree< TScalar >::PopBack ( )
inline

Erases the node at the back of the list.

Definition at line 170 of file itkWatershedSegmentTree.h.

◆ PopFront()

template<typename TScalar >
void itk::watershed::SegmentTree< TScalar >::PopFront ( )
inline

Erases the node at the front of the list.

Definition at line 163 of file itkWatershedSegmentTree.h.

◆ PrintSelf()

template<typename TScalar >
void itk::watershed::SegmentTree< TScalar >::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::DataObject.

◆ PushBack()

template<typename TScalar >
void itk::watershed::SegmentTree< TScalar >::PushBack ( const ValueType t)
inline

Inserts a node at the back of the list

Definition at line 156 of file itkWatershedSegmentTree.h.

◆ PushFront()

template<typename TScalar >
void itk::watershed::SegmentTree< TScalar >::PushFront ( const ValueType t)
inline

Inserts a node at the front of the list.

Definition at line 149 of file itkWatershedSegmentTree.h.

◆ Size()

template<typename TScalar >
DequeType::size_type itk::watershed::SegmentTree< TScalar >::Size ( ) const
inline

Returns the size of the list.

Definition at line 104 of file itkWatershedSegmentTree.h.

Member Data Documentation

◆ m_Deque

template<typename TScalar >
DequeType itk::watershed::SegmentTree< TScalar >::m_Deque
protected

Definition at line 224 of file itkWatershedSegmentTree.h.


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