Orfeo Toolbox  4.0
Classes | Public Types | Public Member Functions | Private Attributes | List of all members
itk::MetaDataDictionary Class Reference

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

#include <itkMetaDataDictionary.h>

+ Collaboration diagram for itk::MetaDataDictionary:

Classes

class  MetaDataDictionaryMapType
 

Public Types

typedef
MetaDataDictionaryMapType::const_iterator 
ConstIterator
 
typedef
MetaDataDictionaryMapType::iterator 
Iterator
 
typedef MetaDataDictionary Self
 

Public Member Functions

 MetaDataDictionary ()
 
 MetaDataDictionary (const MetaDataDictionary &)
 
virtual ~MetaDataDictionary ()
 
Iterator Begin ()
 
ConstIterator Begin () const
 
void Clear ()
 
Iterator End ()
 
ConstIterator End () const
 
Iterator Find (const std::string &key)
 
ConstIterator Find (const std::string &key) const
 
const MetaDataObjectBaseGet (const std::string &) const
 
std::vector< std::string > GetKeys () const
 
bool HasKey (const std::string &) const
 
MetaDataDictionaryoperator= (const MetaDataDictionary &)
 
MetaDataObjectBase::Pointeroperator[] (const std::string &)
 
const MetaDataObjectBaseoperator[] (const std::string &) const
 
virtual void Print (std::ostream &os) const
 
void Set (const std::string &, MetaDataObjectBase *)
 

Private Attributes

MetaDataDictionaryMapTypem_Dictionary
 

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.

Definition at line 40 of file itkMetaDataDictionary.h.

Member Typedef Documentation

typedef MetaDataDictionaryMapType::const_iterator itk::MetaDataDictionary::ConstIterator

Definition at line 57 of file itkMetaDataDictionary.h.

typedef MetaDataDictionaryMapType::iterator itk::MetaDataDictionary::Iterator

Definition at line 56 of file itkMetaDataDictionary.h.

Definition at line 43 of file itkMetaDataDictionary.h.

Constructor & Destructor Documentation

itk::MetaDataDictionary::MetaDataDictionary ( )

Definition at line 23 of file itkMetaDataDictionary.cxx.

itk::MetaDataDictionary::MetaDataDictionary ( const MetaDataDictionary old)

Definition at line 36 of file itkMetaDataDictionary.cxx.

References m_Dictionary.

itk::MetaDataDictionary::~MetaDataDictionary ( )
virtual

Definition at line 29 of file itkMetaDataDictionary.cxx.

Member Function Documentation

MetaDataDictionary::Iterator itk::MetaDataDictionary::Begin ( void  )
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

Definition at line 127 of file itkMetaDataDictionary.cxx.

MetaDataDictionary::ConstIterator itk::MetaDataDictionary::Begin ( void  ) const

Definition at line 134 of file itkMetaDataDictionary.cxx.

void itk::MetaDataDictionary::Clear ( void  )

remove all MetaObjects from dictionary

Definition at line 169 of file itkMetaDataDictionary.cxx.

MetaDataDictionary::Iterator itk::MetaDataDictionary::End ( void  )

Returns an iterator to the end of the map

Definition at line 141 of file itkMetaDataDictionary.cxx.

MetaDataDictionary::ConstIterator itk::MetaDataDictionary::End ( void  ) const

Definition at line 148 of file itkMetaDataDictionary.cxx.

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

Returns an iterator matching the string key

Definition at line 155 of file itkMetaDataDictionary.cxx.

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

Definition at line 162 of file itkMetaDataDictionary.cxx.

const MetaDataObjectBase * itk::MetaDataDictionary::Get ( const std::string &  key) const
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.

Definition at line 111 of file itkMetaDataDictionary.cxx.

Referenced by otb::ImageMetadataInterfaceBase::PrintSelf().

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

Definition at line 104 of file itkMetaDataDictionary.cxx.

Referenced by otb::SarParametricMapFunction< TInputImage, TCoordRep >::EvaluateParametricCoefficient(), itk::ExposeMetaData(), otb::ImageMetadataInterfaceBase::GetBandName(), otb::TerraSarImageMetadataInterface::GetCalibrationFactor(), otb::TerraSarImageMetadataInterface::GetCenterIncidenceAngle(), otb::TerraSarImageMetadataInterface::GetCenterIncidenceAngleIndex(), otb::TerraSarImageMetadataInterface::GetCornersIncidenceAngles(), otb::TerraSarImageMetadataInterface::GetCornersIncidenceAnglesIndex(), otb::QuickBirdImageMetadataInterface::GetDay(), otb::WorldView2ImageMetadataInterface::GetDay(), otb::FormosatImageMetadataInterface::GetDay(), otb::IkonosImageMetadataInterface::GetDay(), otb::SpotImageMetadataInterface::GetDay(), otb::PleiadesImageMetadataInterface::GetDay(), otb::TerraSarImageMetadataInterface::GetDay(), otb::WorldView2ImageMetadataInterface::GetDefaultDisplay(), otb::PleiadesImageMetadataInterface::GetDefaultDisplay(), otb::PleiadesImageMetadataInterface::GetFirstWavelengths(), otb::FormosatImageMetadataInterface::GetFirstWavelengths(), otb::WorldView2ImageMetadataInterface::GetFirstWavelengths(), otb::QuickBirdImageMetadataInterface::GetFirstWavelengths(), otb::IkonosImageMetadataInterface::GetFirstWavelengths(), otb::SpotImageMetadataInterface::GetFirstWavelengths(), otb::ImageMetadataInterfaceBase::GetGCPCol(), otb::ImageMetadataInterfaceBase::GetGCPCount(), otb::ImageMetadataInterfaceBase::GetGCPId(), otb::ImageMetadataInterfaceBase::GetGCPInfo(), otb::ImageMetadataInterfaceBase::GetGCPProjection(), otb::ImageMetadataInterfaceBase::GetGCPRow(), otb::ImageMetadataInterfaceBase::GetGCPs(), otb::ImageMetadataInterfaceBase::GetGCPX(), otb::ImageMetadataInterfaceBase::GetGCPY(), otb::ImageMetadataInterfaceBase::GetGCPZ(), otb::ImageMetadataInterfaceBase::GetGeoTransform(), otb::FormosatImageMetadataInterface::GetHour(), otb::WorldView2ImageMetadataInterface::GetHour(), otb::QuickBirdImageMetadataInterface::GetHour(), otb::SpotImageMetadataInterface::GetHour(), otb::IkonosImageMetadataInterface::GetHour(), otb::PleiadesImageMetadataInterface::GetHour(), otb::TerraSarImageMetadataInterface::GetHour(), otb::ImageMetadataInterfaceBase::GetImageKeywordlist(), otb::FormosatImageMetadataInterface::GetInstrument(), otb::PleiadesImageMetadataInterface::GetInstrument(), otb::SpotImageMetadataInterface::GetInstrument(), otb::PleiadesImageMetadataInterface::GetInstrumentIndex(), otb::SpotImageMetadataInterface::GetInstrumentIndex(), otb::FormosatImageMetadataInterface::GetInstrumentIndex(), otb::IkonosImageMetadataInterface::GetLastWavelengths(), otb::PleiadesImageMetadataInterface::GetLastWavelengths(), otb::FormosatImageMetadataInterface::GetLastWavelengths(), otb::QuickBirdImageMetadataInterface::GetLastWavelengths(), otb::SpotImageMetadataInterface::GetLastWavelengths(), otb::WorldView2ImageMetadataInterface::GetLastWavelengths(), otb::ImageMetadataInterfaceBase::GetLowerLeftCorner(), otb::ImageMetadataInterfaceBase::GetLowerRightCorner(), otb::TerraSarImageMetadataInterface::GetMeanIncidenceAngles(), otb::PleiadesImageMetadataInterface::GetMinute(), otb::FormosatImageMetadataInterface::GetMinute(), otb::QuickBirdImageMetadataInterface::GetMinute(), otb::IkonosImageMetadataInterface::GetMinute(), otb::SpotImageMetadataInterface::GetMinute(), otb::WorldView2ImageMetadataInterface::GetMinute(), otb::TerraSarImageMetadataInterface::GetMinute(), otb::QuickBirdImageMetadataInterface::GetMonth(), otb::WorldView2ImageMetadataInterface::GetMonth(), otb::IkonosImageMetadataInterface::GetMonth(), otb::SpotImageMetadataInterface::GetMonth(), otb::FormosatImageMetadataInterface::GetMonth(), otb::PleiadesImageMetadataInterface::GetMonth(), otb::TerraSarImageMetadataInterface::GetMonth(), otb::TerraSarImageMetadataInterface::GetNoisePolynomialCoefficients(), otb::TerraSarImageMetadataInterface::GetNoisePolynomialCoefficientsList(), otb::TerraSarImageMetadataInterface::GetNoisePolynomialDegrees(), otb::TerraSarImageMetadataInterface::GetNoiseReferencePoint(), otb::TerraSarImageMetadataInterface::GetNoiseReferencePointList(), otb::TerraSarImageMetadataInterface::GetNoiseTimeUTC(), otb::TerraSarImageMetadataInterface::GetNoiseTimeUTCList(), otb::TerraSarImageMetadataInterface::GetNoiseValidityRangeMaxList(), otb::TerraSarImageMetadataInterface::GetNoiseValidityRangeMinList(), otb::ImageMetadataInterfaceBase::GetNumberOfBands(), otb::TerraSarImageMetadataInterface::GetNumberOfCornerIncidenceAngles(), otb::TerraSarImageMetadataInterface::GetNumberOfNoiseRecords(), otb::PleiadesImageMetadataInterface::GetPhysicalBias(), otb::WorldView2ImageMetadataInterface::GetPhysicalBias(), otb::QuickBirdImageMetadataInterface::GetPhysicalBias(), otb::FormosatImageMetadataInterface::GetPhysicalBias(), otb::SpotImageMetadataInterface::GetPhysicalBias(), otb::WorldView2ImageMetadataInterface::GetPhysicalGain(), otb::QuickBirdImageMetadataInterface::GetPhysicalGain(), otb::SpotImageMetadataInterface::GetPhysicalGain(), otb::FormosatImageMetadataInterface::GetPhysicalGain(), otb::TerraSarImageMetadataInterface::GetPRF(), otb::IkonosImageMetadataInterface::GetProductionDay(), otb::WorldView2ImageMetadataInterface::GetProductionDay(), otb::PleiadesImageMetadataInterface::GetProductionDay(), otb::QuickBirdImageMetadataInterface::GetProductionDay(), otb::FormosatImageMetadataInterface::GetProductionDay(), otb::SpotImageMetadataInterface::GetProductionDay(), otb::TerraSarImageMetadataInterface::GetProductionDay(), otb::SpotImageMetadataInterface::GetProductionMonth(), otb::PleiadesImageMetadataInterface::GetProductionMonth(), otb::FormosatImageMetadataInterface::GetProductionMonth(), otb::WorldView2ImageMetadataInterface::GetProductionMonth(), otb::QuickBirdImageMetadataInterface::GetProductionMonth(), otb::IkonosImageMetadataInterface::GetProductionMonth(), otb::TerraSarImageMetadataInterface::GetProductionMonth(), otb::PleiadesImageMetadataInterface::GetProductionYear(), otb::WorldView2ImageMetadataInterface::GetProductionYear(), otb::QuickBirdImageMetadataInterface::GetProductionYear(), otb::SpotImageMetadataInterface::GetProductionYear(), otb::FormosatImageMetadataInterface::GetProductionYear(), otb::IkonosImageMetadataInterface::GetProductionYear(), otb::TerraSarImageMetadataInterface::GetProductionYear(), otb::ImageMetadataInterfaceBase::GetProjectionRef(), otb::TerraSarImageMetadataInterface::GetRadarFrequency(), otb::TerraSarImageMetadataInterface::GetRadiometricCalibrationScale(), otb::TerraSarImageMetadataInterface::GetRangeTimeFirstPixel(), otb::TerraSarImageMetadataInterface::GetRangeTimeLastPixel(), otb::TerraSarImageMetadataInterface::GetRSF(), otb::FormosatImageMetadataInterface::GetSatAzimuth(), otb::WorldView2ImageMetadataInterface::GetSatAzimuth(), otb::PleiadesImageMetadataInterface::GetSatAzimuth(), otb::QuickBirdImageMetadataInterface::GetSatAzimuth(), otb::IkonosImageMetadataInterface::GetSatAzimuth(), otb::SpotImageMetadataInterface::GetSatAzimuth(), otb::PleiadesImageMetadataInterface::GetSatElevation(), otb::WorldView2ImageMetadataInterface::GetSatElevation(), otb::QuickBirdImageMetadataInterface::GetSatElevation(), otb::IkonosImageMetadataInterface::GetSatElevation(), otb::SpotImageMetadataInterface::GetSatElevation(), otb::FormosatImageMetadataInterface::GetSatElevation(), otb::ImageMetadataInterfaceBase::GetSensorID(), otb::SpotImageMetadataInterface::GetSolarIrradiance(), otb::PleiadesImageMetadataInterface::GetSolarIrradiance(), otb::QuickBirdImageMetadataInterface::GetSolarIrradiance(), otb::WorldView2ImageMetadataInterface::GetSolarIrradiance(), otb::IkonosImageMetadataInterface::GetSolarIrradiance(), otb::FormosatImageMetadataInterface::GetSolarIrradiance(), otb::WorldView2ImageMetadataInterface::GetSpectralSensitivity(), otb::QuickBirdImageMetadataInterface::GetSpectralSensitivity(), otb::PleiadesImageMetadataInterface::GetSpectralSensitivity(), otb::FormosatImageMetadataInterface::GetSpectralSensitivity(), otb::SpotImageMetadataInterface::GetSpectralSensitivity(), otb::TerraSarImageMetadataInterface::GetStartTimeUTC(), otb::TerraSarImageMetadataInterface::GetStopTimeUTC(), otb::OpticalImageMetadataInterface::GetSunAzimuth(), otb::OpticalImageMetadataInterface::GetSunElevation(), otb::ImageMetadataInterfaceBase::GetUpperLeftCorner(), otb::ImageMetadataInterfaceBase::GetUpperRightCorner(), otb::PolyLineParametricPathWithValue< TValue, 2 >::GetValue(), otb::ImageMetadataInterfaceBase::GetXPixelSpacing(), otb::IkonosImageMetadataInterface::GetYear(), otb::SpotImageMetadataInterface::GetYear(), otb::PleiadesImageMetadataInterface::GetYear(), otb::WorldView2ImageMetadataInterface::GetYear(), otb::FormosatImageMetadataInterface::GetYear(), otb::QuickBirdImageMetadataInterface::GetYear(), otb::TerraSarImageMetadataInterface::GetYear(), and otb::ImageMetadataInterfaceBase::GetYPixelSpacing().

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

Definition at line 43 of file itkMetaDataDictionary.cxx.

References m_Dictionary.

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

Definition at line 67 of file itkMetaDataDictionary.cxx.

const MetaDataObjectBase * itk::MetaDataDictionary::operator[] ( const std::string &  key) const
void itk::MetaDataDictionary::Print ( std::ostream &  os) const
virtual

Defines the default behavior for printing out this element

Parameters
osAn output stream

Definition at line 54 of file itkMetaDataDictionary.cxx.

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

Definition at line 97 of file itkMetaDataDictionary.cxx.

Member Data Documentation

MetaDataDictionaryMapType* itk::MetaDataDictionary::m_Dictionary
private

Definition at line 117 of file itkMetaDataDictionary.h.

Referenced by MetaDataDictionary(), and operator=().


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

Generated at Sat Mar 8 2014 17:25:05 for Orfeo Toolbox with doxygen 1.8.3.1