itk::OneWayEquivalencyTable Class Reference
[Watershed-based Segmentation Filters]

Hash table to manage integral label equivalencies that are order dependent. More...

#include <itkOneWayEquivalencyTable.h>

Inheritance diagram for itk::OneWayEquivalencyTable:

[legend]Collaboration diagram for itk::OneWayEquivalencyTable:

[legend]List of all members.

[NOHEADER]
typedef OneWayEquivalencyTable	Self
typedef DataObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
virtual const char *	GetClassName () const
Pointer	New ()
Public Types
typedef itk::hash_map< unsigned long, unsigned long, itk::hash< unsigned long > >	HashTableType
typedef HashTableType::iterator	Iterator
typedef HashTableType::const_iterator	ConstIterator
typedef HashTableType::value_type	ValueType
Public Member Functions
void	Flatten ()
bool	Add (unsigned long a, unsigned long b)
unsigned long	RecursiveLookup (const unsigned a) const
void	Erase (const unsigned long a)
void	Clear ()
bool	Empty () const
Iterator	Begin ()
Iterator	End ()
unsigned long	Lookup (const unsigned long a) const
bool	IsEntry (const unsigned long a) const
Protected Member Functions
	OneWayEquivalencyTable ()
virtual	~OneWayEquivalencyTable ()
	OneWayEquivalencyTable (const Self &)
void	operator= (const Self &)
void	PrintSelf (std::ostream &os, Indent indent) const
void	UpdateOutputInformation ()
bool	VerifyRequestedRegion ()
void	SetRequestedRegionToLargestPossibleRegion ()
bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
void	SetRequestedRegion (itk::DataObject *)
Protected Attributes
HashTableType	m_HashMap

---

Detailed Description

Hash table to manage integral label equivalencies that are order dependent.

OneWayEquivalencyTable is a variation on itk::EquivalencyTable that preserves the order of equivalencies. For example, the entries { 5 = 4 } and {4 = 5} are not equivalent in this table, yet are the treated as the same entry in EquivalencyTable. Because of the one-way logic of the table, reflexive equivalencies will result in cycling from recursive lookups or flattening of the table. The responsibility is on the user for preventing recursive cycling.

See itk::EquivalencyTable for more information

See also:

EquivalencyTable

Definition at line 47 of file itkOneWayEquivalencyTable.h.

---

Member Typedef Documentation

typedef HashTableType::const_iterator itk::OneWayEquivalencyTable::ConstIterator

Definition at line 63 of file itkOneWayEquivalencyTable.h. Referenced by Lookup().

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

Standard typedefs and smart pointer declarations. Reimplemented from itk::DataObject. Definition at line 54 of file itkOneWayEquivalencyTable.h.

typedef itk::hash_map<unsigned long, unsigned long, itk::hash<unsigned long> > itk::OneWayEquivalencyTable::HashTableType

Define the container type for this table Definition at line 61 of file itkOneWayEquivalencyTable.h. Referenced by ~OneWayEquivalencyTable().

typedef HashTableType::iterator itk::OneWayEquivalencyTable::Iterator

Definition at line 62 of file itkOneWayEquivalencyTable.h.

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

Standard typedefs and smart pointer declarations. Reimplemented from itk::DataObject. Definition at line 53 of file itkOneWayEquivalencyTable.h.

typedef OneWayEquivalencyTable itk::OneWayEquivalencyTable::Self

Standard typedefs and smart pointer declarations. Reimplemented from itk::DataObject. Definition at line 51 of file itkOneWayEquivalencyTable.h. Referenced by OneWayEquivalencyTable().

typedef DataObject itk::OneWayEquivalencyTable::Superclass

Standard typedefs and smart pointer declarations. Reimplemented from itk::DataObject. Definition at line 52 of file itkOneWayEquivalencyTable.h.

typedef HashTableType::value_type itk::OneWayEquivalencyTable::ValueType

Definition at line 64 of file itkOneWayEquivalencyTable.h.

---

Constructor & Destructor Documentation

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

Convenience method for debugging. Definition at line 130 of file itkOneWayEquivalencyTable.h. References Self.

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

Definition at line 131 of file itkOneWayEquivalencyTable.h. References HashTableType.

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

---

Member Function Documentation

bool itk::OneWayEquivalencyTable::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).

Iterator itk::OneWayEquivalencyTable::Begin (  void   )  [inline]

Returns an iterator pointing to the first element of the (unordered) table. Definition at line 120 of file itkOneWayEquivalencyTable.h.

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

Erases all the entries in the table. Definition at line 111 of file itkOneWayEquivalencyTable.h.

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

Returns TRUE if the table is empty, FALSE if it is not empty. Definition at line 115 of file itkOneWayEquivalencyTable.h.

Iterator itk::OneWayEquivalencyTable::End (  void   )  [inline]

Returns and iterator pointing to one position past the last element of the (unordered) table. Definition at line 124 of file itkOneWayEquivalencyTable.h.

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

Erases the entry with key a. Definition at line 107 of file itkOneWayEquivalencyTable.h.

void itk::OneWayEquivalencyTable::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::OneWayEquivalencyTable::GetClassName (   )  const [virtual]

Standard typedefs and smart pointer declarations. Reimplemented from itk::DataObject.

bool itk::OneWayEquivalencyTable::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 99 of file itkOneWayEquivalencyTable.h.

unsigned long itk::OneWayEquivalencyTable::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 83 of file itkOneWayEquivalencyTable.h. References ConstIterator.

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

Standard typedefs and smart pointer declarations. Reimplemented from itk::Object.

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

Reimplemented from itk::DataObject.

void itk::OneWayEquivalencyTable::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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.

unsigned long itk::OneWayEquivalencyTable::RecursiveLookup (  const unsigned  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.

bool itk::OneWayEquivalencyTable::RequestedRegionIsOutsideOfTheBufferedRegion (   )  [inline, protected, virtual]

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute Implements itk::DataObject. Definition at line 141 of file itkOneWayEquivalencyTable.h.

void itk::OneWayEquivalencyTable::SetRequestedRegion (  itk::DataObject *   )  [inline, protected, virtual]

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. This method is implemented in the concrete subclasses of DataObject. Implements itk::DataObject. Definition at line 142 of file itkOneWayEquivalencyTable.h.

void itk::OneWayEquivalencyTable::SetRequestedRegionToLargestPossibleRegion (   )  [inline, protected, virtual]

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update(). Implements itk::DataObject. Definition at line 140 of file itkOneWayEquivalencyTable.h.

void itk::OneWayEquivalencyTable::UpdateOutputInformation (   )  [protected, virtual]

Update the information for this DataObject so that it can be used as an output of a ProcessObject. This method is used in the pipeline mechanism to propagate information and initialize the meta data associated with a DataObject. Any implementation of this method in a derived class is assumed to call its source's ProcessObject::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc. Implements itk::DataObject.

bool itk::OneWayEquivalencyTable::VerifyRequestedRegion (   )  [inline, protected, virtual]

Verify that the RequestedRegion is within the LargestPossibleRegion. If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion. Implements itk::DataObject. Definition at line 139 of file itkOneWayEquivalencyTable.h.

---

Member Data Documentation

HashTableType itk::OneWayEquivalencyTable::m_HashMap [protected]

Definition at line 136 of file itkOneWayEquivalencyTable.h.

---

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

• itkOneWayEquivalencyTable.h

---