#include <itkMetaDataDictionary.h>

Detailed Description

Provides a mechanism for storing a collection of arbitrary data types.

Author: Hans J. Johnson

The MetaDataDictionary, along with the MetaDataObject derived template classes, is designed to provide a mechanism for storing a collection of arbitrary data types. The main motivation for such a collection is to associate arbitrary data elements with itk DataObjects.

The MetaDataDictionary implements shallow copying with copy on write behavior. When a copy of this class is created, the new copy will be shared with the old copy via C++11 shared pointers. When a non-constant operation is done, if the dictionary is not unique to this object, then a deep copy is performed. This make is very cheap to create multiple copies of the same dictionary if they are never modified.

ITK Sphinx Examples:

All ITK Sphinx Examples

Store Non-Pixel Data In Image

Examples: Examples/Filtering/DiffusionTensor3DReconstructionImageFilter.cxx, Examples/IO/DicomImageReadChangeHeaderWrite.cxx, Examples/IO/DicomImageReadPrintTags.cxx, Examples/IO/DicomSeriesReadPrintTags.cxx, Examples/IO/ImageReadDicomSeriesWrite.cxx, SphinxExamples/src/Core/Common/StoreNonPixelDataInImage/Code.cxx, SphinxExamples/src/IO/GDCM/ReadAndPrintDICOMTags/Code.cxx, and SphinxExamples/src/IO/GDCM/ResampleDICOMSeries/Code.cxx.

Definition at line 54 of file itkMetaDataDictionary.h.

Collaboration diagram for itk::MetaDataDictionary:

Public Types
using	ConstIterator = MetaDataDictionaryMapType::const_iterator

using	Iterator = MetaDataDictionaryMapType::iterator

using	MetaDataDictionaryMapType = std::map< std::string, MetaDataObjectBase::Pointer >

using	Self = MetaDataDictionary

Public Member Functions
void	Clear ()

bool	Erase (const std::string &)

Iterator	Find (const std::string &key)

ConstIterator	Find (const std::string &key) const

const MetaDataObjectBase *	Get (const std::string &) const

std::vector< std::string >	GetKeys () const

bool	HasKey (const std::string &) const

	MetaDataDictionary ()

	MetaDataDictionary (const MetaDataDictionary &)

	MetaDataDictionary (MetaDataDictionary &&)=default

MetaDataDictionary &	operator= (const MetaDataDictionary &)

MetaDataDictionary &	operator= (MetaDataDictionary &&)=default

MetaDataObjectBase::Pointer &	operator[] (const std::string &)

const MetaDataObjectBase *	operator[] (const std::string &) const

virtual void	Print (std::ostream &os) const

void	Set (const std::string &, MetaDataObjectBase *)

void	Swap (MetaDataDictionary &other)

virtual	~MetaDataDictionary ()


Iterator	Begin ()

ConstIterator	Begin () const


Iterator	End ()

ConstIterator	End () const

Private Member Functions
bool	MakeUnique ()

Private Attributes
std::shared_ptr< MetaDataDictionaryMapType >	m_Dictionary {}

Friends
bool	operator!= (const Self &lhs, const Self &rhs)

bool	operator== (const Self &lhs, const Self &rhs)

Member Typedef Documentation

◆ ConstIterator

using itk::MetaDataDictionary::ConstIterator = MetaDataDictionaryMapType::const_iterator

Definition at line 69 of file itkMetaDataDictionary.h.

◆ Iterator

using itk::MetaDataDictionary::Iterator = MetaDataDictionaryMapType::iterator

Definition at line 68 of file itkMetaDataDictionary.h.

◆ MetaDataDictionaryMapType

using itk::MetaDataDictionary::MetaDataDictionaryMapType = std::map<std::string, MetaDataObjectBase::Pointer>

Definition at line 67 of file itkMetaDataDictionary.h.

◆ Self

using itk::MetaDataDictionary::Self = MetaDataDictionary

Definition at line 57 of file itkMetaDataDictionary.h.

Constructor & Destructor Documentation

◆ MetaDataDictionary() [1/3]

itk::MetaDataDictionary::MetaDataDictionary ( )

◆ MetaDataDictionary() [2/3]

itk::MetaDataDictionary::MetaDataDictionary ( const MetaDataDictionary & )

◆ MetaDataDictionary() [3/3]

itk::MetaDataDictionary::MetaDataDictionary ( MetaDataDictionary && )

default

◆ ~MetaDataDictionary()

virtual itk::MetaDataDictionary::~MetaDataDictionary ( )

virtual

Member Function Documentation

◆ Begin() [1/2]

Iterator itk::MetaDataDictionary::Begin ( )

Warning: the following functions SHOULD NOT be used with the visual studio 6 compiler since iterator outside of the dll context cannot be dereferenced safely Returns an iterator to the beginning of the map

Examples: SphinxExamples/src/Core/Common/StoreNonPixelDataInImage/Code.cxx, and SphinxExamples/src/IO/GDCM/ResampleDICOMSeries/Code.cxx.

◆ Begin() [2/2]

ConstIterator itk::MetaDataDictionary::Begin ( ) const

Warning: the following functions SHOULD NOT be used with the visual studio 6 compiler since iterator outside of the dll context cannot be dereferenced safely Returns an iterator to the beginning of the map

◆ Clear()

void itk::MetaDataDictionary::Clear ( )

remove all MetaObjects from dictionary

◆ End() [1/2]

Iterator itk::MetaDataDictionary::End ( )

Returns an iterator to the end of the map

Examples: SphinxExamples/src/Core/Common/StoreNonPixelDataInImage/Code.cxx, and SphinxExamples/src/IO/GDCM/ResampleDICOMSeries/Code.cxx.

Referenced by itk::ExposeMetaData().

◆ End() [2/2]

ConstIterator itk::MetaDataDictionary::End ( ) const

Returns an iterator to the end of the map

◆ Erase()

bool itk::MetaDataDictionary::Erase ( const std::string & )

◆ Find() [1/2]

Iterator itk::MetaDataDictionary::Find ( const std::string & key )

Returns an iterator matching the string key

Referenced by itk::ExposeMetaData().

◆ Find() [2/2]

ConstIterator itk::MetaDataDictionary::Find ( const std::string & key ) const

◆ Get()

const MetaDataObjectBase* itk::MetaDataDictionary::Get ( const std::string & ) const

◆ GetKeys()

std::vector<std::string> itk::MetaDataDictionary::GetKeys ( ) const

Returns a vector of keys to the key/value entries in the dictionary. Iterate through the dictionary using these keys.

Examples: Examples/Filtering/DiffusionTensor3DReconstructionImageFilter.cxx.

◆ HasKey()

bool itk::MetaDataDictionary::HasKey ( const std::string & ) const

◆ MakeUnique()

bool itk::MetaDataDictionary::MakeUnique ( )

private

◆ operator=() [1/2]

MetaDataDictionary& itk::MetaDataDictionary::operator= ( const MetaDataDictionary & )

◆ operator=() [2/2]

MetaDataDictionary& itk::MetaDataDictionary::operator= ( MetaDataDictionary && )

default

◆ operator[]() [1/2]

MetaDataObjectBase::Pointer& itk::MetaDataDictionary::operator[] ( const std::string & )

◆ operator[]() [2/2]

const MetaDataObjectBase* itk::MetaDataDictionary::operator[] ( const std::string & ) const

◆ Print()

virtual void itk::MetaDataDictionary::Print ( std::ostream & os ) const

virtual

Defines the default behavior for printing out this element

Parameters

os	An output stream

Examples: SphinxExamples/src/Core/Common/StoreNonPixelDataInImage/Code.cxx.

◆ Set()

void itk::MetaDataDictionary::Set	(	const std::string &	,
		MetaDataObjectBase *
	)

◆ Swap()

void itk::MetaDataDictionary::Swap ( MetaDataDictionary & other )

Referenced by itk::swap().

Friends And Related Function Documentation

◆ operator!=

bool operator!=	(	const Self &	lhs,
		const Self &	rhs
	)

friend

Returns (metaDataDictionary1 != metaDataDictionary2).

Definition at line 108 of file itkMetaDataDictionary.h.

◆ operator==

bool operator==	(	const Self &	lhs,
		const Self &	rhs
	)