ITK  4.1.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
itk::watershed::SegmentTree< TScalarType > Class Template Reference
Watershed-based Segmentation Filters | Module ITKWatersheds

#include <itkWatershedSegmentTree.h>

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

List of all members.

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 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 ()
void Initialize ()
void PopBack ()
void PopFront ()
void PushBack (const ValueType &t)
void PushFront (const ValueType &t)
DequeType::size_type Size () const

Protected Member Functions

void operator= (const Self &)
void PrintSelf (std::ostream &os, Indent indent) const
 SegmentTree ()
 SegmentTree (const Self &)
virtual ~SegmentTree ()

Protected Attributes

DequeType m_Deque
typedef SegmentTree 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

Detailed Description

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

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.

Member Typedef Documentation

template<class TScalarType >
typedef DequeType::const_iterator itk::watershed::SegmentTree< TScalarType >::ConstIterator

Definition at line 73 of file itkWatershedSegmentTree.h.

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

Define itk Smart Pointers for this object

Reimplemented from itk::DataObject.

Definition at line 54 of file itkWatershedSegmentTree.h.

template<class TScalarType >
typedef std::deque< merge_t > itk::watershed::SegmentTree< TScalarType >::DequeType

Define the container type used in this list data structure

Definition at line 71 of file itkWatershedSegmentTree.h.

template<class TScalarType >
typedef DequeType::iterator itk::watershed::SegmentTree< TScalarType >::Iterator

Definition at line 72 of file itkWatershedSegmentTree.h.

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

Define itk Smart Pointers for this object

Reimplemented from itk::DataObject.

Definition at line 53 of file itkWatershedSegmentTree.h.

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

Define itk Smart Pointers for this object

Definition at line 56 of file itkWatershedSegmentTree.h.

template<class TScalarType >
typedef SegmentTree itk::watershed::SegmentTree< TScalarType >::Self

Define itk Smart Pointers for this object

Reimplemented from itk::DataObject.

Definition at line 51 of file itkWatershedSegmentTree.h.

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

Define itk Smart Pointers for this object

Reimplemented from itk::DataObject.

Definition at line 52 of file itkWatershedSegmentTree.h.

template<class TScalarType >
typedef DequeType::value_type itk::watershed::SegmentTree< TScalarType >::ValueType

Definition at line 74 of file itkWatershedSegmentTree.h.

Constructor & Destructor Documentation

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

Definition at line 166 of file itkWatershedSegmentTree.h.

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

Definition at line 167 of file itkWatershedSegmentTree.h.

template<class TScalarType >
itk::watershed::SegmentTree< TScalarType >::SegmentTree ( const Self &  ) [inline, protected]

Definition at line 168 of file itkWatershedSegmentTree.h.

Member Function Documentation

template<class TScalarType >
const merge_t& itk::watershed::SegmentTree< TScalarType >::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.

template<class TScalarType >
merge_t& itk::watershed::SegmentTree< TScalarType >::Back ( ) [inline]

Returns a reference to the back of the list

Definition at line 120 of file itkWatershedSegmentTree.h.

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

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

Definition at line 140 of file itkWatershedSegmentTree.h.

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

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

Definition at line 144 of file itkWatershedSegmentTree.h.

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

Clears the Deque completely

Definition at line 158 of file itkWatershedSegmentTree.h.

template<class TScalarType >
virtual::itk::LightObject::Pointer itk::watershed::SegmentTree< TScalarType >::CreateAnother ( void  ) const [virtual]

Define itk Smart Pointers for this object

Reimplemented from itk::Object.

template<class TScalarType >
bool itk::watershed::SegmentTree< TScalarType >::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.

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

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

Definition at line 149 of file itkWatershedSegmentTree.h.

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

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

Definition at line 154 of file itkWatershedSegmentTree.h.

template<class TScalarType >
const merge_t& itk::watershed::SegmentTree< TScalarType >::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.

template<class TScalarType >
merge_t& itk::watershed::SegmentTree< TScalarType >::Front ( ) [inline]

Returns a reference to the front of the list

Definition at line 116 of file itkWatershedSegmentTree.h.

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

Define itk Smart Pointers for this object

Reimplemented from itk::DataObject.

template<class TScalarType >
void itk::watershed::SegmentTree< TScalarType >::Initialize ( ) [virtual]

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

Reimplemented from itk::DataObject.

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

Define itk Smart Pointers for this object

Reimplemented from itk::Object.

template<class TScalarType >
void itk::watershed::SegmentTree< TScalarType >::operator= ( const Self &  ) [inline, protected]

Reimplemented from itk::DataObject.

Definition at line 169 of file itkWatershedSegmentTree.h.

template<class TScalarType >
void itk::watershed::SegmentTree< TScalarType >::PopBack ( ) [inline]

Erases the node at the back of the list.

Definition at line 136 of file itkWatershedSegmentTree.h.

template<class TScalarType >
void itk::watershed::SegmentTree< TScalarType >::PopFront ( ) [inline]

Erases the node at the front of the list.

Definition at line 132 of file itkWatershedSegmentTree.h.

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

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

Reimplemented from itk::DataObject.

template<class TScalarType >
void itk::watershed::SegmentTree< TScalarType >::PushBack ( const ValueType &  t) [inline]

Inserts a node at the back of the list

Definition at line 128 of file itkWatershedSegmentTree.h.

template<class TScalarType >
void itk::watershed::SegmentTree< TScalarType >::PushFront ( const ValueType &  t) [inline]

Inserts a node at the front of the list.

Definition at line 124 of file itkWatershedSegmentTree.h.

template<class TScalarType >
DequeType::size_type itk::watershed::SegmentTree< TScalarType >::Size ( void  ) const [inline]

Returns the size of the list.

Definition at line 97 of file itkWatershedSegmentTree.h.

Member Data Documentation

template<class TScalarType >
DequeType itk::watershed::SegmentTree< TScalarType >::m_Deque [protected]

Definition at line 172 of file itkWatershedSegmentTree.h.

The documentation for this class was generated from the following file:
Generated on Thu Feb 9 2012 03:17:02 for ITK by doxygen 1.7.6.1