itk::watershed::SegmentTree< TScalar > Class Template Reference

#include <itkWatershedSegmentTree.h>

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

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

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 implemenation 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 47 of file itkWatershedSegmentTree.h.

Classes
struct	merge_comp
struct	merge_t
struct	sort_comp

Public Types
typedef DequeType::const_iterator	ConstIterator
typedef std::deque< merge_t >	DequeType
typedef DequeType::iterator	Iterator
typedef DequeType::value_type	ValueType
Public Types inherited from itk::DataObject
typedef SmartPointer< const Self >	ConstPointer
typedef std::string	DataObjectIdentifierType
typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType
typedef SmartPointer< Self >	Pointer
typedef DataObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
const merge_t &	Back () const
merge_t &	Back ()
Iterator	Begin ()
ConstIterator	Begin () const
void	Clear ()
bool	Empty () const
Iterator	End ()
ConstIterator	End () const
const merge_t &	Front () const
merge_t &	Front ()
virtual 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
SmartPointerForwardReference < ProcessObject >	GetSource () const
DataObjectPointerArraySizeType	GetSourceOutputIndex () const
const DataObjectIdentifierType &	GetSourceOutputName () const
virtual ModifiedTimeType	GetUpdateMTime () const
virtual void	Graft (const DataObject *)
virtual void	PrepareForNewData ()
virtual void	PropagateRequestedRegion ()
void	ReleaseData ()
virtual void	ReleaseDataFlagOff ()
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 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 *)
unsigned long	AddObserver (const EventObject &event, Command *) const
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
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Protected Member Functions
void	operator= (const Self &)
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
	SegmentTree ()
	SegmentTree (const Self &)
virtual	~SegmentTree ()
Protected Member Functions inherited from itk::DataObject
	DataObject ()
virtual void	PropagateResetPipeline ()
	~DataObject ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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
AtomicInt< int >	m_ReferenceCount
typedef SegmentTree	Self
typedef DataObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TScalar	ScalarType
static Pointer	New ()
virtual ::itk::LightObject::Pointer	CreateAnother () const
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 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 flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Member Typedef Documentation

template<typename TScalar >

typedef DequeType::const_iterator itk::watershed::SegmentTree< TScalar >::ConstIterator

Definition at line 73 of file itkWatershedSegmentTree.h.

template<typename TScalar >

typedef SmartPointer< const Self > itk::watershed::SegmentTree< TScalar >::ConstPointer

Define itk Smart Pointers for this object

Definition at line 54 of file itkWatershedSegmentTree.h.

template<typename TScalar >

typedef std::deque< merge_t > itk::watershed::SegmentTree< TScalar >::DequeType

Define the container type used in this list data structure

Definition at line 71 of file itkWatershedSegmentTree.h.

template<typename TScalar >

typedef DequeType::iterator itk::watershed::SegmentTree< TScalar >::Iterator

Definition at line 72 of file itkWatershedSegmentTree.h.

template<typename TScalar >

typedef SmartPointer< Self > itk::watershed::SegmentTree< TScalar >::Pointer

Define itk Smart Pointers for this object

Definition at line 53 of file itkWatershedSegmentTree.h.

template<typename TScalar >

typedef TScalar itk::watershed::SegmentTree< TScalar >::ScalarType

Define itk Smart Pointers for this object

Definition at line 56 of file itkWatershedSegmentTree.h.

template<typename TScalar >

typedef SegmentTree itk::watershed::SegmentTree< TScalar >::Self

Define itk Smart Pointers for this object

Definition at line 51 of file itkWatershedSegmentTree.h.

template<typename TScalar >

typedef DataObject itk::watershed::SegmentTree< TScalar >::Superclass

Define itk Smart Pointers for this object

Definition at line 52 of file itkWatershedSegmentTree.h.

template<typename TScalar >

typedef DequeType::value_type itk::watershed::SegmentTree< TScalar >::ValueType

Definition at line 74 of file itkWatershedSegmentTree.h.

Constructor & Destructor Documentation

template<typename TScalar >

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

inlineprotected

Definition at line 166 of file itkWatershedSegmentTree.h.

template<typename TScalar >

virtual itk::watershed::SegmentTree< TScalar >::~SegmentTree ( )

inlineprotectedvirtual

Definition at line 167 of file itkWatershedSegmentTree.h.

template<typename TScalar >

itk::watershed::SegmentTree< TScalar >::SegmentTree ( const Self &  )

inlineprotected

Definition at line 168 of file itkWatershedSegmentTree.h.

Member Function Documentation

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 112 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

template<typename TScalar >

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

inline

Returns a reference to the back of the list

Definition at line 120 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

template<typename TScalar >

Iterator itk::watershed::SegmentTree< TScalar >::Begin ( void  )

inline

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

Definition at line 140 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

template<typename TScalar >

ConstIterator itk::watershed::SegmentTree< TScalar >::Begin ( void  ) const

inline

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

Definition at line 144 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

template<typename TScalar >

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

inline

Clears the Deque completely

Definition at line 158 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

template<typename TScalar >

virtual::itk::LightObject::Pointer itk::watershed::SegmentTree< TScalar >::CreateAnother ( ) const

virtual

Define itk Smart Pointers for this object

Reimplemented from itk::Object.

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 102 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

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 149 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

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 154 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

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 107 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

template<typename TScalar >

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

inline

Returns a reference to the front of the list

Definition at line 116 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

template<typename TScalar >

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

virtual

Define itk Smart Pointers for this object

Reimplemented from itk::DataObject.

template<typename TScalar >

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

template<typename TScalar >

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

static

Define itk Smart Pointers for this object

template<typename TScalar >

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

inlineprotected

Definition at line 169 of file itkWatershedSegmentTree.h.

template<typename TScalar >

void itk::watershed::SegmentTree< TScalar >::PopBack ( )

inline

Erases the node at the back of the list.

Definition at line 136 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

template<typename TScalar >

void itk::watershed::SegmentTree< TScalar >::PopFront ( )

inline

Erases the node at the front of the list.

Definition at line 132 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

template<typename TScalar >

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

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 128 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

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 124 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

template<typename TScalar >

DequeType::size_type itk::watershed::SegmentTree< TScalar >::Size ( void  ) const

inline

Returns the size of the list.

Definition at line 97 of file itkWatershedSegmentTree.h.

References itk::watershed::SegmentTree< TScalar >::m_Deque.

Member Data Documentation

template<typename TScalar >

DequeType itk::watershed::SegmentTree< TScalar >::m_Deque

protected

Definition at line 172 of file itkWatershedSegmentTree.h.

Referenced by itk::watershed::SegmentTree< TScalar >::Back(), itk::watershed::SegmentTree< TScalar >::Begin(), itk::watershed::SegmentTree< TScalar >::Clear(), itk::watershed::SegmentTree< TScalar >::Empty(), itk::watershed::SegmentTree< TScalar >::End(), itk::watershed::SegmentTree< TScalar >::Front(), itk::watershed::SegmentTree< TScalar >::PopBack(), itk::watershed::SegmentTree< TScalar >::PopFront(), itk::watershed::SegmentTree< TScalar >::PushBack(), itk::watershed::SegmentTree< TScalar >::PushFront(), and itk::watershed::SegmentTree< TScalar >::Size().

---

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

• itkWatershedSegmentTree.h