#include <itkWatershedSegmentTable.h>

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

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

Classes
struct	edge_pair_t
struct	segment_t

Public Types
typedef HashMapType::const_iterator	ConstIterator
typedef HashMapType::data_type	DataType
typedef std::list< edge_pair_t >	edge_list_t
typedef itksys::hash_map < IdentifierType, segment_t, itksys::hash< IdentifierType > >	HashMapType
typedef HashMapType::iterator	Iterator
typedef HashMapType::value_type	ValueType
Public Types inherited from itk::DataObject
typedef std::string	DataObjectIdentifierType
typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
bool	Add (IdentifierType a, const segment_t &t)
Iterator	Begin ()
ConstIterator	Begin () const
void	Clear ()
void	Copy (const Self &o)
bool	Empty () const
Iterator	End ()
ConstIterator	End () const
void	Erase (const IdentifierType a)
ScalarType	GetMaximumDepth () const
unsigned int	GetSegmentMemorySize () const
segment_t *	Lookup (const IdentifierType a)
const segment_t *	Lookup (const IdentifierType a) const
void	PruneEdgeLists (ScalarType maximum_saliency)
HashMapType::size_type	Size () const
void	SortEdgeLists ()

bool	IsEntry (const IdentifierType a) const

void	SetMaximumDepth (ScalarType s)
Public Member Functions inherited from itk::DataObject
virtual void	CopyInformation (const DataObject *)
virtual void	DataHasBeenGenerated ()
void	DisconnectPipeline ()
bool	GetDataReleased () const
virtual const bool &	GetReleaseDataFlag ()
SmartPointerForwardReference < ProcessObject >	GetSource () const
DataObjectPointerArraySizeType	GetSourceOutputIndex () const
const DataObjectIdentifierType &	GetSourceOutputName () const
virtual unsigned long	GetUpdateMTime () const
virtual void	Initialize ()
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 (unsigned long time)
virtual const unsigned long &	GetPipelineMTime ()
virtual void	SetRealTimeStamp (RealTimeStamp _arg)
virtual const RealTimeStamp &	GetRealTimeStamp ()
virtual void	Graft (const DataObject *)
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 (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	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
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () 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
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 void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

Protected Member Functions
	SegmentTable ()
virtual	~SegmentTable ()
Protected Member Functions inherited from itk::DataObject
virtual void	PropagateResetPipeline ()
	DataObject ()
	~DataObject ()
void	PrintSelf (std::ostream &os, Indent indent) const
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
HashMapType	m_HashMap
ScalarType	m_MaximumDepth

Private Member Functions
void	operator= (const Self &)
typedef SegmentTable	Self
typedef DataObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TScalarType	ScalarType
static Pointer	New ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const

Additional Inherited Members

Detailed Description

template<class TScalarType>
class itk::watershed::SegmentTable< TScalarType >

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

Member Typedef Documentation

template<class TScalarType >

typedef HashMapType::const_iterator itk::watershed::SegmentTable< TScalarType >::ConstIterator

Definition at line 98 of file itkWatershedSegmentTable.h.

template<class TScalarType >

typedef SmartPointer< const Self > itk::watershed::SegmentTable< TScalarType >::ConstPointer

Define smart pointers for this object

Reimplemented from itk::DataObject.

Definition at line 54 of file itkWatershedSegmentTable.h.

template<class TScalarType >

typedef HashMapType::data_type itk::watershed::SegmentTable< TScalarType >::DataType

Definition at line 100 of file itkWatershedSegmentTable.h.

template<class TScalarType >

typedef std::list< edge_pair_t > itk::watershed::SegmentTable< TScalarType >::edge_list_t

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

Definition at line 86 of file itkWatershedSegmentTable.h.

template<class TScalarType >

typedef itksys::hash_map< IdentifierType, segment_t, itksys::hash< IdentifierType > > itk::watershed::SegmentTable< TScalarType >::HashMapType

Define the container type for the table

Definition at line 96 of file itkWatershedSegmentTable.h.

template<class TScalarType >

typedef HashMapType::iterator itk::watershed::SegmentTable< TScalarType >::Iterator

Definition at line 97 of file itkWatershedSegmentTable.h.

template<class TScalarType >

typedef SmartPointer< Self > itk::watershed::SegmentTable< TScalarType >::Pointer

Define smart pointers for this object

Reimplemented from itk::DataObject.

Definition at line 53 of file itkWatershedSegmentTable.h.

template<class TScalarType >

typedef TScalarType itk::watershed::SegmentTable< TScalarType >::ScalarType

Define smart pointers for this object

Definition at line 55 of file itkWatershedSegmentTable.h.

template<class TScalarType >

typedef SegmentTable itk::watershed::SegmentTable< TScalarType >::Self

Define smart pointers for this object

Reimplemented from itk::DataObject.

Definition at line 51 of file itkWatershedSegmentTable.h.

template<class TScalarType >

typedef DataObject itk::watershed::SegmentTable< TScalarType >::Superclass

Define smart pointers for this object

Reimplemented from itk::DataObject.

Definition at line 52 of file itkWatershedSegmentTable.h.

template<class TScalarType >

typedef HashMapType::value_type itk::watershed::SegmentTable< TScalarType >::ValueType

Definition at line 99 of file itkWatershedSegmentTable.h.

Constructor & Destructor Documentation

template<class TScalarType >

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

inlineprotected

Definition at line 210 of file itkWatershedSegmentTable.h.

template<class TScalarType >

virtual itk::watershed::SegmentTable< TScalarType >::~SegmentTable ( )

inlineprotectedvirtual

Definition at line 211 of file itkWatershedSegmentTable.h.

Member Function Documentation

template<class TScalarType >

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

Inserts a segment into the table

template<class TScalarType >

Iterator itk::watershed::SegmentTable< TScalarType >::Begin ( void )

inline

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

Definition at line 166 of file itkWatershedSegmentTable.h.

template<class TScalarType >

ConstIterator itk::watershed::SegmentTable< TScalarType >::Begin ( void ) const

inline

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

Definition at line 174 of file itkWatershedSegmentTable.h.

template<class TScalarType >

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

inline

Removes all the entries in the table.

Definition at line 145 of file itkWatershedSegmentTable.h.

template<class TScalarType >

void itk::watershed::SegmentTable< TScalarType >::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 203 of file itkWatershedSegmentTable.h.

template<class TScalarType >

virtual::itk::LightObject::Pointer itk::watershed::SegmentTable< TScalarType >::CreateAnother ( void ) const

virtual

Define smart pointers for this object

Reimplemented from itk::Object.

template<class TScalarType >

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

inline

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

Definition at line 150 of file itkWatershedSegmentTable.h.

template<class TScalarType >

Iterator itk::watershed::SegmentTable< TScalarType >::End ( void )

inline

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

Definition at line 170 of file itkWatershedSegmentTable.h.

template<class TScalarType >

ConstIterator itk::watershed::SegmentTable< TScalarType >::End ( void ) const

inline

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

Definition at line 178 of file itkWatershedSegmentTable.h.

template<class TScalarType >

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

inline

Deletes an entry from the table.

Definition at line 141 of file itkWatershedSegmentTable.h.

template<class TScalarType >

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

inline

Definition at line 197 of file itkWatershedSegmentTable.h.

template<class TScalarType >

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

virtual

Define smart pointers for this object

Reimplemented from itk::DataObject.

template<class TScalarType >

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

inline

Convenience methods for debugging

Definition at line 181 of file itkWatershedSegmentTable.h.

template<class TScalarType >

bool itk::watershed::SegmentTable< TScalarType >::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 133 of file itkWatershedSegmentTable.h.

template<class TScalarType >

segment_t* itk::watershed::SegmentTable< TScalarType >::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 113 of file itkWatershedSegmentTable.h.

template<class TScalarType >

const segment_t* itk::watershed::SegmentTable< TScalarType >::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 123 of file itkWatershedSegmentTable.h.

template<class TScalarType >

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

static

Define smart pointers for this object

Reimplemented from itk::Object.

template<class TScalarType >

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

inlineprivate

Reimplemented from itk::DataObject.

Definition at line 217 of file itkWatershedSegmentTable.h.

template<class TScalarType >

void itk::watershed::SegmentTable< TScalarType >::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.

template<class TScalarType >

void itk::watershed::SegmentTable< TScalarType >::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 190 of file itkWatershedSegmentTable.h.

template<class TScalarType >

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

inline

Returns the number of entries in the table.

Definition at line 158 of file itkWatershedSegmentTable.h.

template<class TScalarType >

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