#include <itkEquivalencyTable.h>

Inheritance diagram for itk::EquivalencyTable:

Collaboration diagram for itk::EquivalencyTable:

Public Types
typedef HashTableType::const_iterator	ConstIterator
typedef itksys::hash_map < unsigned long, unsigned long, itksys::hash< unsigned long > >	HashTableType
typedef HashTableType::iterator	Iterator
typedef HashTableType::value_type	ValueType
Public Member Functions
bool	Add (unsigned long a, unsigned long b)
bool	AddAndFlatten (unsigned long a, unsigned long b)
Iterator	Begin ()
void	Clear ()
bool	Empty () const
Iterator	End ()
void	Erase (const unsigned long a)
void	Flatten ()
unsigned long	Lookup (const unsigned long a) const
unsigned long	RecursiveLookup (const unsigned long a) const
HashTableType::size_type	Size () const

bool	IsEntry (const unsigned long a) const
Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const

	EquivalencyTable ()
virtual	~EquivalencyTable ()
	EquivalencyTable (const Self &)
void	operator= (const Self &)
Protected Attributes
HashTableType	m_HashMap
typedef EquivalencyTable	Self
typedef DataObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
static Pointer	New ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const

Detailed Description

Hash table to manage integral label equivalencies.

EquivalencyTable is a hash table for recording equivalencies among unsigned long integer values. EquivalencyTable can store recursive relationships (8=7, 7=6, 6=5, ...) or be ``flattened'' to eliminate recursion. The table uses an efficient algorithm for eliminating redundancy and preventing circular dependencies.

: In the context of the watershed segmentation algorithm (itk::WatershedImageFilter), this table is used to store connections identified among image segments and as the input to itk::watershed::Relabeler.

Definition at line 44 of file itkEquivalencyTable.h.

Member Typedef Documentation

typedef HashTableType::const_iterator itk::EquivalencyTable::ConstIterator

Definition at line 61 of file itkEquivalencyTable.h.

typedef SmartPointer< const Self > itk::EquivalencyTable::ConstPointer

Standard smart pointer declarations

Reimplemented from itk::DataObject.

Definition at line 51 of file itkEquivalencyTable.h.

typedef itksys::hash_map< unsigned long, unsigned long, itksys::hash< unsigned long > > itk::EquivalencyTable::HashTableType

Define the container type for the table.

Definition at line 53 of file itkEquivalencyTable.h.

typedef HashTableType::iterator itk::EquivalencyTable::Iterator

Definition at line 60 of file itkEquivalencyTable.h.

typedef SmartPointer< Self > itk::EquivalencyTable::Pointer

Standard smart pointer declarations

Reimplemented from itk::DataObject.

Definition at line 50 of file itkEquivalencyTable.h.

typedef EquivalencyTable itk::EquivalencyTable::Self

Standard smart pointer declarations

Reimplemented from itk::DataObject.

Definition at line 48 of file itkEquivalencyTable.h.

typedef DataObject itk::EquivalencyTable::Superclass

Standard smart pointer declarations

Reimplemented from itk::DataObject.

Definition at line 49 of file itkEquivalencyTable.h.

typedef HashTableType::value_type itk::EquivalencyTable::ValueType

Definition at line 62 of file itkEquivalencyTable.h.

Constructor & Destructor Documentation

itk::EquivalencyTable::EquivalencyTable ( ) [inline, protected]

Convenience method for debugging.

Definition at line 139 of file itkEquivalencyTable.h.

virtual itk::EquivalencyTable::~EquivalencyTable ( ) [inline, protected, virtual]

Convenience method for debugging.

Definition at line 140 of file itkEquivalencyTable.h.

itk::EquivalencyTable::EquivalencyTable ( const Self & ) [protected]

Convenience method for debugging.

Member Function Documentation

bool itk::EquivalencyTable::Add	(	unsigned long	a,
		unsigned long	b
	)

Insert an equivalency into the table. A return value of TRUE indicates that the equivalency did not previously exist in the table and was successfully added. A FALSE return value indicates that the equivalency was not added to the table because a conflict with an existing entry occurred (most likely, the equivalency was already recorded directly or indirectly).

bool itk::EquivalencyTable::AddAndFlatten	(	unsigned long	a,
		unsigned long	b
	)

Insert an equivalency into the table and flatten that equivalency. A return value of TRUE indicates that the equivalency did not previously exist in the table and was successfully added. A FALSE return value indicates that the equivalency was not added to the table because a conflict with an existing entry occurred (most likely, the equivalency was already recorded directly or indirectly).

Iterator itk::EquivalencyTable::Begin ( ) [inline]

Returns an iterator pointing to the first element of the (unordered) table.

Definition at line 130 of file itkEquivalencyTable.h.

void itk::EquivalencyTable::Clear ( ) [inline]

Erases all the entries in the table.

Definition at line 117 of file itkEquivalencyTable.h.

virtual::itk::LightObject::Pointer itk::EquivalencyTable::CreateAnother ( void ) const [virtual]

Standard smart pointer declarations

Reimplemented from itk::Object.

bool itk::EquivalencyTable::Empty ( ) const [inline]

Returns TRUE if the table is empty, FALSE if it is not empty.

Definition at line 121 of file itkEquivalencyTable.h.

Iterator itk::EquivalencyTable::End ( ) [inline]

Returns and iterator pointing to one position past the last element of the (unordered) table.

Definition at line 134 of file itkEquivalencyTable.h.

void itk::EquivalencyTable::Erase ( const unsigned long a ) [inline]

Erases the entry with key a.

Definition at line 113 of file itkEquivalencyTable.h.

void itk::EquivalencyTable::Flatten ( )

``Flattens'' the equivalency table by eliminating all redundant and recursive equivalencies. I.e. the set { 2=1; 3=2; 4=3 } is converted to {4=1; 3=1; 2=1}.

virtual const char* itk::EquivalencyTable::GetNameOfClass ( ) const [virtual]

Standard smart pointer declarations

Reimplemented from itk::DataObject.

bool itk::EquivalencyTable::IsEntry ( const unsigned long a ) const [inline]

Returns TRUE if the label is found in the table and FALSE is the label is not found in the table.

Definition at line 105 of file itkEquivalencyTable.h.

unsigned long itk::EquivalencyTable::Lookup ( const unsigned long a ) const [inline]

Lookup an equivalency in the table. If no entry is found in the table, the method returns its the value of the argument. Does not recursively descent through equivalencies.

Definition at line 89 of file itkEquivalencyTable.h.

static Pointer itk::EquivalencyTable::New ( ) [static]

Standard smart pointer declarations

Reimplemented from itk::Object.

void itk::EquivalencyTable::operator= ( const Self & ) [protected]

Convenience method for debugging.

Reimplemented from itk::DataObject.

void itk::EquivalencyTable::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.

unsigned long itk::EquivalencyTable::RecursiveLookup ( const unsigned long a ) const

Lookup an equivalency in the table by recursing through all successive equivalencies. For example, if the follow entries exist in the table {8=7, 7=6, 6=5}, then RecursiveLookup(8) returns 5.

HashTableType::size_type itk::EquivalencyTable::Size ( void ) const [inline]

Returns the number of entries in the table.

Definition at line 125 of file itkEquivalencyTable.h.

Member Data Documentation

HashTableType itk::EquivalencyTable::m_HashMap [protected]

Definition at line 147 of file itkEquivalencyTable.h.

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

itkEquivalencyTable.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation