itk::EquivalencyTable Class Reference

#include <itkEquivalencyTable.h>

Inheritance diagram for itk::EquivalencyTable:

Collaboration diagram for itk::EquivalencyTable:

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.

Public Types
using	ConstIterator = HashTableType::const_iterator
using	HashTableType = itksys::hash_map< unsigned long, unsigned long, itksys::hash< unsigned long > >
using	Iterator = HashTableType::iterator
using	ValueType = HashTableType::value_type
Public Types inherited from itk::DataObject
using	ConstPointer = SmartPointer< const Self >
using	DataObjectIdentifierType = std::string
using	DataObjectPointerArraySizeType = std::vector< Pointer >::size_type
using	Pointer = SmartPointer< Self >
using	Self = DataObject
using	Superclass = Object
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

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
Public Member Functions inherited from itk::DataObject
virtual void	CopyInformation (const DataObject *)
virtual void	DataHasBeenGenerated ()
void	DisconnectPipeline ()
bool	GetDataReleased () const
virtual const bool &	GetReleaseDataFlag () const
SmartPointer< ProcessObject >	GetSource () const
DataObjectPointerArraySizeType	GetSourceOutputIndex () const
const DataObjectIdentifierType &	GetSourceOutputName () const
virtual ModifiedTimeType	GetUpdateMTime () const
virtual void	Graft (const DataObject *)
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 (ModifiedTimeType time)
virtual const ModifiedTimeType &	GetPipelineMTime () const
virtual void	SetRealTimeStamp (RealTimeStamp _arg)
virtual const RealTimeStamp &	GetRealTimeStamp () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
LightObject::Pointer	CreateAnother () const override
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	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
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () 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

Protected Member Functions
	EquivalencyTable ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
	~EquivalencyTable () override=default
Protected Member Functions inherited from itk::DataObject
	DataObject ()
virtual void	PropagateResetPipeline ()
	~DataObject () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	SetTimeStamp (const TimeStamp &time)
	~Object () override
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
HashTableType	m_HashMap
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount
using	Self = EquivalencyTable
using	Superclass = DataObject
using	Pointer = SmartPointer< Self >
using	ConstPointer = SmartPointer< const Self >
static Pointer	New ()
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const char *	GetNameOfClass () const

Additional Inherited Members
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 Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Member Typedef Documentation

using itk::EquivalencyTable::ConstIterator = HashTableType::const_iterator

Definition at line 63 of file itkEquivalencyTable.h.

using itk::EquivalencyTable::ConstPointer = SmartPointer< const Self >

Standard smart pointer declarations

Definition at line 53 of file itkEquivalencyTable.h.

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

Define the container type for the table.

Definition at line 60 of file itkEquivalencyTable.h.

using itk::EquivalencyTable::Iterator = HashTableType::iterator

Definition at line 62 of file itkEquivalencyTable.h.

using itk::EquivalencyTable::Pointer = SmartPointer< Self >

Standard smart pointer declarations

Definition at line 52 of file itkEquivalencyTable.h.

using itk::EquivalencyTable::Self = EquivalencyTable

Standard smart pointer declarations

Definition at line 50 of file itkEquivalencyTable.h.

using itk::EquivalencyTable::Superclass = DataObject

Standard smart pointer declarations

Definition at line 51 of file itkEquivalencyTable.h.

using itk::EquivalencyTable::ValueType = HashTableType::value_type

Definition at line 64 of file itkEquivalencyTable.h.

Constructor & Destructor Documentation

itk::EquivalencyTable::EquivalencyTable ( )

protecteddefault

Convenience method for debugging.

itk::EquivalencyTable::~EquivalencyTable ( )

overrideprotecteddefault

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 132 of file itkEquivalencyTable.h.

void itk::EquivalencyTable::Clear ( )

inline

Erases all the entries in the table.

Definition at line 119 of file itkEquivalencyTable.h.

virtual::itk::LightObject::Pointer itk::EquivalencyTable::CreateAnother ( ) const

virtual

Standard smart pointer declarations

Reimplemented from itk::LightObject.

bool itk::EquivalencyTable::Empty ( ) const

inline

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

Definition at line 123 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 136 of file itkEquivalencyTable.h.

void itk::EquivalencyTable::Erase ( const unsigned long  a )

inline

Erases the entry with key a.

Definition at line 115 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 107 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 91 of file itkEquivalencyTable.h.

static Pointer itk::EquivalencyTable::New ( )

static

Standard smart pointer declarations

void itk::EquivalencyTable::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

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::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 ( ) const

inline

Returns the number of entries in the table.

Definition at line 127 of file itkEquivalencyTable.h.

Member Data Documentation

HashTableType itk::EquivalencyTable::m_HashMap

protected

Definition at line 146 of file itkEquivalencyTable.h.

---

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

• itkEquivalencyTable.h