itk::OneWayEquivalencyTable Class Reference

#include <itkOneWayEquivalencyTable.h>

Inheritance diagram for itk::OneWayEquivalencyTable:

Collaboration diagram for itk::OneWayEquivalencyTable:

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 46 of file itkOneWayEquivalencyTable.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)
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
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
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
	OneWayEquivalencyTable ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
	~OneWayEquivalencyTable () 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
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 = OneWayEquivalencyTable
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::OneWayEquivalencyTable::ConstIterator = HashTableType::const_iterator

Definition at line 65 of file itkOneWayEquivalencyTable.h.

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

Standard type alias and smart pointer declarations.

Definition at line 55 of file itkOneWayEquivalencyTable.h.

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

Define the container type for this table

Definition at line 62 of file itkOneWayEquivalencyTable.h.

using itk::OneWayEquivalencyTable::Iterator = HashTableType::iterator

Definition at line 64 of file itkOneWayEquivalencyTable.h.

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

Standard type alias and smart pointer declarations.

Definition at line 54 of file itkOneWayEquivalencyTable.h.

using itk::OneWayEquivalencyTable::Self = OneWayEquivalencyTable

Standard type alias and smart pointer declarations.

Definition at line 52 of file itkOneWayEquivalencyTable.h.

using itk::OneWayEquivalencyTable::Superclass = DataObject

Standard type alias and smart pointer declarations.

Definition at line 53 of file itkOneWayEquivalencyTable.h.

using itk::OneWayEquivalencyTable::ValueType = HashTableType::value_type

Definition at line 66 of file itkOneWayEquivalencyTable.h.

Constructor & Destructor Documentation

itk::OneWayEquivalencyTable::OneWayEquivalencyTable ( )

protecteddefault

Convenience method for debugging.

itk::OneWayEquivalencyTable::~OneWayEquivalencyTable ( )

overrideprotecteddefault

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

inline

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

Definition at line 122 of file itkOneWayEquivalencyTable.h.

void itk::OneWayEquivalencyTable::Clear ( )

inline

Erases all the entries in the table.

Definition at line 113 of file itkOneWayEquivalencyTable.h.

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

virtual

Standard type alias and smart pointer declarations.

Reimplemented from itk::Object.

bool itk::OneWayEquivalencyTable::Empty ( ) const

inline

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

Definition at line 117 of file itkOneWayEquivalencyTable.h.

Iterator itk::OneWayEquivalencyTable::End ( )

inline

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

Definition at line 126 of file itkOneWayEquivalencyTable.h.

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

inline

Erases the entry with key a.

Definition at line 109 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::GetNameOfClass ( ) const

virtual

Standard type alias 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 101 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 85 of file itkOneWayEquivalencyTable.h.

static Pointer itk::OneWayEquivalencyTable::New ( )

static

Standard type alias and smart pointer declarations.

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

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