#include <itkWatershedSegmentTable.h>

Detailed Description

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

A table for storing segmentation information in various component filters of the watershed segmentation algorithm. See itk::WatershedImageFilter for an overview.

: This is a hash table that holds information about labeled segments in an image. Keys in the table are label values (IdentifierType). Each entry in the table records the minimum value in the segment region and a list of all the adjacent segments in the image. The adjacency (edge) list also holds a saliency value (likelihood of merge) for each adjacency.

See also: itk::WatershedImageFilter

Definition at line 48 of file itkWatershedSegmentTable.h.

Inheritance diagram for itk::watershed::SegmentTable< TScalar >:

Collaboration diagram for itk::watershed::SegmentTable< TScalar >:

Classes
struct	edge_pair_t

struct	segment_t

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	ScalarType = TScalar

using	Self = SegmentTable

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
void	Copy (const Self &o)

ScalarType	GetMaximumDepth () const

const char *	GetNameOfClass () const override

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

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

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

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 Member Functions
	SegmentTable ()

	~SegmentTable () 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
HashMapType	m_HashMap {}

ScalarType	m_MaximumDepth {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Private Member Functions
void	operator= (const Self &)

using	edge_list_t = std::list< edge_pair_t >

using	HashMapType = std::unordered_map< IdentifierType, segment_t >

using	Iterator = typename HashMapType::iterator

using	ConstIterator = typename HashMapType::const_iterator

using	ValueType = typename HashMapType::value_type

using	DataType = typename HashMapType::mapped_type

bool	Add (IdentifierType a, const segment_t &t)

void	PruneEdgeLists (ScalarType maximum_saliency)

segment_t *	Lookup (const IdentifierType a)

const segment_t *	Lookup (const IdentifierType a) const

bool	IsEntry (const IdentifierType a) const

void	Erase (const IdentifierType a)

void	Clear ()

bool	Empty () const

void	SortEdgeLists ()

HashMapType::size_type	Size () const

Iterator	Begin ()

Iterator	End ()

ConstIterator	Begin () const

ConstIterator	End () const

unsigned int	GetSegmentMemorySize () const

void	SetMaximumDepth (ScalarType s)

Member Typedef Documentation

◆ ConstIterator

template<typename TScalar >

using itk::watershed::SegmentTable< TScalar >::ConstIterator = typename HashMapType::const_iterator

Structure for storing lists of adjacencies (edges) and their saliencies.

Definition at line 102 of file itkWatershedSegmentTable.h.

◆ ConstPointer

template<typename TScalar >

using itk::watershed::SegmentTable< TScalar >::ConstPointer = SmartPointer<const Self>

Definition at line 56 of file itkWatershedSegmentTable.h.

◆ DataType

template<typename TScalar >

using itk::watershed::SegmentTable< TScalar >::DataType = typename HashMapType::mapped_type

Structure for storing lists of adjacencies (edges) and their saliencies.

Definition at line 104 of file itkWatershedSegmentTable.h.

◆ edge_list_t

template<typename TScalar >

using itk::watershed::SegmentTable< TScalar >::edge_list_t = std::list<edge_pair_t>

Structure for storing lists of adjacencies (edges) and their saliencies.

Definition at line 90 of file itkWatershedSegmentTable.h.

◆ HashMapType

template<typename TScalar >

using itk::watershed::SegmentTable< TScalar >::HashMapType = std::unordered_map<IdentifierType, segment_t>

Define the container type for the table

Definition at line 100 of file itkWatershedSegmentTable.h.

◆ Iterator

template<typename TScalar >

using itk::watershed::SegmentTable< TScalar >::Iterator = typename HashMapType::iterator

Structure for storing lists of adjacencies (edges) and their saliencies.

Definition at line 101 of file itkWatershedSegmentTable.h.

◆ Pointer

template<typename TScalar >

using itk::watershed::SegmentTable< TScalar >::Pointer = SmartPointer<Self>

Definition at line 55 of file itkWatershedSegmentTable.h.

◆ ScalarType

template<typename TScalar >

using itk::watershed::SegmentTable< TScalar >::ScalarType = TScalar

Definition at line 57 of file itkWatershedSegmentTable.h.

◆ Self

template<typename TScalar >

using itk::watershed::SegmentTable< TScalar >::Self = SegmentTable

Define smart pointers for this object

Definition at line 53 of file itkWatershedSegmentTable.h.

◆ Superclass

template<typename TScalar >

using itk::watershed::SegmentTable< TScalar >::Superclass = DataObject

Definition at line 54 of file itkWatershedSegmentTable.h.

◆ ValueType

template<typename TScalar >

using itk::watershed::SegmentTable< TScalar >::ValueType = typename HashMapType::value_type

Structure for storing lists of adjacencies (edges) and their saliencies.

Definition at line 103 of file itkWatershedSegmentTable.h.

Constructor & Destructor Documentation

◆ SegmentTable()

template<typename TScalar >

itk::watershed::SegmentTable< TScalar >::SegmentTable ( )

inlineprotected

Definition at line 265 of file itkWatershedSegmentTable.h.

◆ ~SegmentTable()

template<typename TScalar >

itk::watershed::SegmentTable< TScalar >::~SegmentTable ( )

overrideprotecteddefault

Member Function Documentation

◆ Add()

template<typename TScalar >

bool itk::watershed::SegmentTable< TScalar >::Add	(	IdentifierType	a,
		const segment_t &	t
	)

Inserts a segment into the table

◆ Begin() [1/2]

template<typename TScalar >

Iterator itk::watershed::SegmentTable< TScalar >::Begin ( )

inline

Merges two entries of the table. from->to
Returns an iterator pointing to the first element in the (unordered) table.

Definition at line 200 of file itkWatershedSegmentTable.h.

◆ Begin() [2/2]

template<typename TScalar >

ConstIterator itk::watershed::SegmentTable< TScalar >::Begin ( ) const

inline

Returns a const iterator pointing to the first element in the (unordered) table.

Definition at line 216 of file itkWatershedSegmentTable.h.

◆ Clear()

template<typename TScalar >

void itk::watershed::SegmentTable< TScalar >::Clear ( )

inline

Removes all the entries in the table.

Definition at line 169 of file itkWatershedSegmentTable.h.

◆ Copy()

template<typename TScalar >

void itk::watershed::SegmentTable< TScalar >::Copy ( const Self & o )

inline

Copies the contents of another segment table into this segment table. This is really operator= in disguise, although superclass information is not copied.

Definition at line 258 of file itkWatershedSegmentTable.h.

◆ Empty()

template<typename TScalar >

bool itk::watershed::SegmentTable< TScalar >::Empty ( ) const

inline

Returns true if the table is empty and false if the table is not empty.

Definition at line 177 of file itkWatershedSegmentTable.h.

◆ End() [1/2]

template<typename TScalar >

Iterator itk::watershed::SegmentTable< TScalar >::End ( )

inline

Returns an iterator pointing to one element past the last element in the (unordered table).

Definition at line 208 of file itkWatershedSegmentTable.h.

◆ End() [2/2]

template<typename TScalar >

ConstIterator itk::watershed::SegmentTable< TScalar >::End ( ) const

inline

Returns a const iterator pointing to one element past the last element in the (unordered table).

Definition at line 224 of file itkWatershedSegmentTable.h.

◆ Erase()

template<typename TScalar >

void itk::watershed::SegmentTable< TScalar >::Erase ( const IdentifierType a )

inline

Deletes an entry from the table.

Definition at line 162 of file itkWatershedSegmentTable.h.

◆ GetMaximumDepth()

template<typename TScalar >

ScalarType itk::watershed::SegmentTable< TScalar >::GetMaximumDepth ( ) const

inline

Definition at line 249 of file itkWatershedSegmentTable.h.

◆ GetNameOfClass()

template<typename TScalar >

const char* itk::watershed::SegmentTable< TScalar >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::DataObject.

◆ GetSegmentMemorySize()

template<typename TScalar >

unsigned int itk::watershed::SegmentTable< TScalar >::GetSegmentMemorySize ( ) const

inline

Convenience methods for debugging

Definition at line 231 of file itkWatershedSegmentTable.h.

◆ IsEntry()

template<typename TScalar >

bool itk::watershed::SegmentTable< TScalar >::IsEntry ( const IdentifierType a ) const

inline

Returns TRUE if the entry key is found in the table. FALSE if the key is not found in the table.

Definition at line 150 of file itkWatershedSegmentTable.h.

◆ Lookup() [1/2]

template<typename TScalar >

segment_t* itk::watershed::SegmentTable< TScalar >::Lookup ( const IdentifierType a )

inline

Lookup a segment in the table. Returns a pointer to the entry. On failure, returns a null pointer.

Definition at line 120 of file itkWatershedSegmentTable.h.

◆ Lookup() [2/2]

template<typename TScalar >

const segment_t* itk::watershed::SegmentTable< TScalar >::Lookup ( const IdentifierType a ) const

inline

Lookup a segment in the table. Returns a const pointer to the entry. On failure, returns a null pointer.

Definition at line 135 of file itkWatershedSegmentTable.h.

◆ New()

template<typename TScalar >

static Pointer itk::watershed::SegmentTable< TScalar >::New ( )

static

◆ operator=()

template<typename TScalar >

void itk::watershed::SegmentTable< TScalar >::operator= ( const Self & )

inlineprivate

Definition at line 276 of file itkWatershedSegmentTable.h.

◆ PruneEdgeLists()

template<typename TScalar >

void itk::watershed::SegmentTable< TScalar >::PruneEdgeLists ( ScalarType maximum_saliency )

Iterates through the table and removes edges in every edge list whose saliencies are above the specified maximum. Requires that the edge lists have been sorted prior to calling this method.

◆ SetMaximumDepth()

template<typename TScalar >

void itk::watershed::SegmentTable< TScalar >::SetMaximumDepth ( ScalarType s )

inline

Set/Get the maximum depth of image on which this segment table is based. (Should set really be calling modified? jc 11/16/01)

Definition at line 241 of file itkWatershedSegmentTable.h.

◆ Size()

template<typename TScalar >

HashMapType::size_type itk::watershed::SegmentTable< TScalar >::Size ( ) const

inline

Returns the number of entries in the table.

Definition at line 189 of file itkWatershedSegmentTable.h.

◆ SortEdgeLists()

template<typename TScalar >

void itk::watershed::SegmentTable< TScalar >::SortEdgeLists ( )

Sorts all the entries in the edge lists from least to greatest saliency.

Member Data Documentation

◆ m_HashMap

template<typename TScalar >

HashMapType itk::watershed::SegmentTable< TScalar >::m_HashMap {}

protected

Definition at line 270 of file itkWatershedSegmentTable.h.

◆ m_MaximumDepth

template<typename TScalar >

ScalarType itk::watershed::SegmentTable< TScalar >::m_MaximumDepth {}

protected

Definition at line 272 of file itkWatershedSegmentTable.h.

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

itkWatershedSegmentTable.h

Detailed Description

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Member Typedef Documentation

◆ ConstIterator

◆ ConstPointer

◆ DataType

◆ edge_list_t

◆ HashMapType

◆ Iterator

◆ Pointer

◆ ScalarType

◆ Self

◆ Superclass

◆ ValueType

Constructor & Destructor Documentation

◆ SegmentTable()

◆ ~SegmentTable()

Member Function Documentation

◆ Add()

◆ Begin() [1/2]

◆ Begin() [2/2]

◆ Clear()

◆ Copy()

◆ Empty()

◆ End() [1/2]

◆ End() [2/2]

◆ Erase()

◆ GetMaximumDepth()

◆ GetNameOfClass()

◆ GetSegmentMemorySize()

◆ IsEntry()

◆ Lookup() [1/2]

◆ Lookup() [2/2]

◆ New()

◆ operator=()

◆ PruneEdgeLists()

◆ SetMaximumDepth()

◆ Size()

◆ SortEdgeLists()

Member Data Documentation

◆ m_HashMap

◆ m_MaximumDepth

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