itk::watershed::SegmentTable< TScalarType > Class Template Reference
[Watershed-based Segmentation Filters]

#include <itkWatershedSegmentTable.h>

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

[legend]Collaboration diagram for itk::watershed::SegmentTable< TScalarType >:

[legend]List of all 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 (unsigned long). 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 50 of file itkWatershedSegmentTable.h.

Public Types
typedef HashMapType::const_iterator	ConstIterator
typedef SmartPointer< const Self >	ConstPointer
typedef HashMapType::data_type	DataType
typedef std::list< edge_pair_t >	edge_list_t
typedef itk::hash_map< unsigned long, segment_t, itk::hash< unsigned long > >	HashMapType
typedef HashMapType::iterator	Iterator
typedef SmartPointer< Self >	Pointer
typedef TScalarType	ScalarType
typedef DataObject	Superclass
typedef HashMapType::value_type	ValueType
Public Member Functions
bool	Add (unsigned long a, const segment_t &t)
ConstIterator	Begin () const
Iterator	Begin ()
void	Clear ()
void	Copy (const Self &o)
bool	Empty () const
ConstIterator	End () const
Iterator	End ()
void	Erase (const unsigned long a)
ScalarType	GetMaximumDepth () const
virtual const char *	GetNameOfClass () const
Convenience methods for debugging *unsigned int	GetSegmentMemorySize () const
Returns TRUE if the entry key is found in the table FALSE if the key is *not found in the table *bool	IsEntry (const unsigned long a) const
Lookup a segment in the table Returns a const pointer *to the entry On returns a null pointer *const segment_t *	Lookup (const unsigned long a) const
Lookup a segment in the table Returns a pointer to the *entry On returns a null pointer *segment_t *	Lookup (const unsigned long a)
void	PruneEdgeLists (ScalarType maximum_saliency)
Set Get the maximum depth of image on which this segment table is based *Should set really be calling modified jc *void	SetMaximumDepth (ScalarType s)
HashMapType::size_type	Size () const
void	SortEdgeLists ()
Static Public Member Functions
static Pointer	New ()
Public Attributes
Lookup a segment in the table Returns a const pointer *to the entry On	failure
Lookup a segment in the table Returns a pointer to the *entry On	failure
Define smart pointers for this object *typedef SegmentTable	Self
Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
	SegmentTable ()
virtual	~SegmentTable ()
Protected Attributes
HashMapType	m_HashMap
ScalarType	m_MaximumDepth
Classes
struct	edge_pair_t
struct	segment_t

---

Member Typedef Documentation

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

Definition at line 99 of file itkWatershedSegmentTable.h.

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

Definition at line 57 of file itkWatershedSegmentTable.h.

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

Definition at line 101 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 itk::hash_map<unsigned long, segment_t, itk::hash<unsigned long> > itk::watershed::SegmentTable< TScalarType >::HashMapType

Define the container type for the table Definition at line 97 of file itkWatershedSegmentTable.h.

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

Definition at line 98 of file itkWatershedSegmentTable.h.

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

Definition at line 56 of file itkWatershedSegmentTable.h.

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

Definition at line 58 of file itkWatershedSegmentTable.h.

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

Definition at line 55 of file itkWatershedSegmentTable.h.

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

Definition at line 100 of file itkWatershedSegmentTable.h.

---

Constructor & Destructor Documentation

template<class TScalarType> itk::watershed::SegmentTable< TScalarType >::SegmentTable (   )  [inline, protected]

Definition at line 210 of file itkWatershedSegmentTable.h.

template<class TScalarType> virtual itk::watershed::SegmentTable< TScalarType >::~SegmentTable (   )  [inline, protected, virtual]

Definition at line 211 of file itkWatershedSegmentTable.h.

---

Member Function Documentation

template<class TScalarType> bool itk::watershed::SegmentTable< TScalarType >::Add (  unsigned long  a, const segment_t &  t )

Inserts a segment into the table

template<class TScalarType> ConstIterator itk::watershed::SegmentTable< TScalarType >::Begin (   )  const [inline]

Returns a const iterator pointing to the first element in the (unordered) table. Definition at line 175 of file itkWatershedSegmentTable.h.

template<class TScalarType> Iterator itk::watershed::SegmentTable< TScalarType >::Begin (   )  [inline]

Returns an iterator pointing to the first element in the (unordered) table. Definition at line 167 of file itkWatershedSegmentTable.h.

template<class TScalarType> void itk::watershed::SegmentTable< TScalarType >::Clear (   )  [inline]

Removes all the entries in the table. Definition at line 146 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> 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 151 of file itkWatershedSegmentTable.h.

template<class TScalarType> ConstIterator itk::watershed::SegmentTable< TScalarType >::End (   )  const [inline]

Returns a const iterator pointing to one element past the last element in the (unordered table). Definition at line 179 of file itkWatershedSegmentTable.h.

template<class TScalarType> Iterator itk::watershed::SegmentTable< TScalarType >::End (   )  [inline]

Returns an iterator pointing to one element past the last element in the (unordered table). Definition at line 171 of file itkWatershedSegmentTable.h.

template<class TScalarType> void itk::watershed::SegmentTable< TScalarType >::Erase (  const unsigned long  a  )  [inline]

Deletes an entry from the table. Definition at line 142 of file itkWatershedSegmentTable.h.

template<class TScalarType> ScalarType itk::watershed::SegmentTable< TScalarType >::GetMaximumDepth (   )  const [inline]

Definition at line 196 of file itkWatershedSegmentTable.h.

template<class TScalarType> virtual const char* itk::watershed::SegmentTable< TScalarType >::GetNameOfClass (   )  const [virtual]

template<class TScalarType> Convenience methods for debugging* unsigned int itk::watershed::SegmentTable< TScalarType >::GetSegmentMemorySize (   )  const [inline]

Definition at line 182 of file itkWatershedSegmentTable.h.

template<class TScalarType> Returns TRUE if the entry key is found in the table FALSE if the key is* not found in the table* bool itk::watershed::SegmentTable< TScalarType >::IsEntry (  const unsigned long  a  )  const [inline]

Definition at line 134 of file itkWatershedSegmentTable.h.

template<class TScalarType> Lookup a segment in the table Returns a const pointer* to the entry On returns a null pointer* const segment_t* itk::watershed::SegmentTable< TScalarType >::Lookup (  const unsigned long  a  )  const [inline]

Definition at line 124 of file itkWatershedSegmentTable.h.

template<class TScalarType> Lookup a segment in the table Returns a pointer to the* entry On returns a null pointer* segment_t* itk::watershed::SegmentTable< TScalarType >::Lookup (  const unsigned long  a  )  [inline]

Definition at line 114 of file itkWatershedSegmentTable.h.

template<class TScalarType> static Pointer itk::watershed::SegmentTable< TScalarType >::New (   )  [static]

template<class TScalarType> void itk::watershed::SegmentTable< TScalarType >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected]

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> Set Get the maximum depth of image on which this segment table is based* Should set really be calling modified jc* void itk::watershed::SegmentTable< TScalarType >::SetMaximumDepth (  ScalarType  s  )  [inline]

Definition at line 191 of file itkWatershedSegmentTable.h.

template<class TScalarType> HashMapType::size_type itk::watershed::SegmentTable< TScalarType >::Size (   )  const [inline]

Returns the number of entries in the table. Definition at line 159 of file itkWatershedSegmentTable.h.

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

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

---

Member Data Documentation

template<class TScalarType> Lookup a segment in the table Returns a const pointer* to the entry On itk::watershed::SegmentTable< TScalarType >::failure

Definition at line 123 of file itkWatershedSegmentTable.h.

template<class TScalarType> Lookup a segment in the table Returns a pointer to the* entry On itk::watershed::SegmentTable< TScalarType >::failure

Definition at line 113 of file itkWatershedSegmentTable.h.

template<class TScalarType> HashMapType itk::watershed::SegmentTable< TScalarType >::m_HashMap [protected]

Definition at line 214 of file itkWatershedSegmentTable.h.

template<class TScalarType> ScalarType itk::watershed::SegmentTable< TScalarType >::m_MaximumDepth [protected]

Definition at line 215 of file itkWatershedSegmentTable.h.

template<class TScalarType> Define smart pointers for this object* typedef SegmentTable itk::watershed::SegmentTable< TScalarType >::Self

Definition at line 54 of file itkWatershedSegmentTable.h.

---

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

• itkWatershedSegmentTable.h

---