OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | List of all members
otb::ImageMetadataInterfaceBase Class Reference
Group Core » Module OTBMetadata

#include <otbImageMetadataInterfaceBase.h>

+ Inheritance diagram for otb::ImageMetadataInterfaceBase:
+ Collaboration diagram for otb::ImageMetadataInterfaceBase:

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef itk::ImageBase< 2 > ImageType
 
typedef itk::MetaDataDictionary MetaDataDictionaryType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef ImageMetadataInterfaceBase Self
 
typedef std::vector< std::string > StringVectorType
 
typedef itk::Object Superclass
 
typedef std::vector< unsigned int > UIntVectorType
 
typedef unsigned int UnsignedIntType
 
typedef MetaDataKey::VariableLengthVectorType VariableLengthVectorType
 
typedef MetaDataKey::VectorType VectorType
 

Public Member Functions

const MetaDataDictionaryType & GetMetaDataDictionary () const
 
virtual const char * GetNameOfClass () const
 
std::string GetProjectionRef () const
 
void SetImage (ImageType *image)
 
void SetMetaDataDictionary (const MetaDataDictionaryType &dict)
 
void SetMetadataSupplierInterface (const MetadataSupplierInterface &)
 
MetaDataDictionaryType m_MetaDataDictionary
 
const MetadataSupplierInterface * m_MetadataSupplierInterface = nullptr
 
GCP m_GCP
 
std::string GetGCPProjection () const
 
UnsignedIntType GetGCPCount () const
 
GCP & GetGCPs (unsigned int GCPnum)
 
std::string GetGCPId (unsigned int GCPnum) const
 
std::string GetGCPInfo (unsigned int GCPnum) const
 
double GetGCPRow (unsigned int GCPnum) const
 
double GetGCPCol (unsigned int GCPnum) const
 
double GetGCPX (unsigned int GCPnum) const
 
double GetGCPY (unsigned int GCPnum) const
 
double GetGCPZ (unsigned int GCPnum) const
 
VectorType GetGeoTransform () const
 
VectorType GetUpperLeftCorner () const
 
VectorType GetUpperRightCorner () const
 
VectorType GetLowerLeftCorner () const
 
VectorType GetLowerRightCorner () const
 
virtual void Parse (ImageMetadata &)
 
const std::string & Fetch (MDStr key, ImageMetadata &imd, const char *path, int band=-1)
 
bool CheckFetch (MDStr key, ImageMetadata &imd, const char *path, int band=-1)
 
const double & Fetch (MDNum key, ImageMetadata &imd, const char *path, int band=-1)
 
bool CheckFetch (MDNum key, ImageMetadata &imd, const char *path, int band=-1)
 
const MetaData::TimePoint & Fetch (MDTime key, ImageMetadata &imd, const char *path, int band=-1)
 
bool CheckFetch (MDTime key, ImageMetadata &imd, const char *path, int band=-1)
 
const std::string & Fetch (std::string key, ImageMetadata &imd, const char *path, int band=-1)
 
bool CheckFetch (std::string key, ImageMetadata &imd, const char *path, int band=-1)
 
const boost::any & FetchRPC (ImageMetadata &imd, const double lineOffset=0.0, const double sampleOffset=0.0)
 
 ImageMetadataInterfaceBase ()=default
 
 ~ImageMetadataInterfaceBase () override=default
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ImageMetadataInterfaceBase (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

Base class for captor metadata reading.

Definition at line 44 of file otbImageMetadataInterfaceBase.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer<const Self> otb::ImageMetadataInterfaceBase::ConstPointer

Definition at line 50 of file otbImageMetadataInterfaceBase.h.

◆ ImageType

typedef itk::ImageBase<2> otb::ImageMetadataInterfaceBase::ImageType

Definition at line 53 of file otbImageMetadataInterfaceBase.h.

◆ MetaDataDictionaryType

typedef itk::MetaDataDictionary otb::ImageMetadataInterfaceBase::MetaDataDictionaryType

Definition at line 56 of file otbImageMetadataInterfaceBase.h.

◆ Pointer

typedef itk::SmartPointer<Self> otb::ImageMetadataInterfaceBase::Pointer

Definition at line 49 of file otbImageMetadataInterfaceBase.h.

◆ Self

typedef ImageMetadataInterfaceBase otb::ImageMetadataInterfaceBase::Self

Definition at line 47 of file otbImageMetadataInterfaceBase.h.

◆ StringVectorType

typedef std::vector<std::string> otb::ImageMetadataInterfaceBase::StringVectorType

Definition at line 60 of file otbImageMetadataInterfaceBase.h.

◆ Superclass

typedef itk::Object otb::ImageMetadataInterfaceBase::Superclass

Definition at line 48 of file otbImageMetadataInterfaceBase.h.

◆ UIntVectorType

typedef std::vector<unsigned int> otb::ImageMetadataInterfaceBase::UIntVectorType

Definition at line 61 of file otbImageMetadataInterfaceBase.h.

◆ UnsignedIntType

typedef unsigned int otb::ImageMetadataInterfaceBase::UnsignedIntType

Definition at line 59 of file otbImageMetadataInterfaceBase.h.

◆ VariableLengthVectorType

typedef MetaDataKey::VariableLengthVectorType otb::ImageMetadataInterfaceBase::VariableLengthVectorType

Definition at line 58 of file otbImageMetadataInterfaceBase.h.

◆ VectorType

typedef MetaDataKey::VectorType otb::ImageMetadataInterfaceBase::VectorType

Definition at line 57 of file otbImageMetadataInterfaceBase.h.

Constructor & Destructor Documentation

◆ ImageMetadataInterfaceBase() [1/2]

otb::ImageMetadataInterfaceBase::ImageMetadataInterfaceBase ( )
protecteddefault

Get the GCP projection coordinates of the image.

◆ ~ImageMetadataInterfaceBase()

otb::ImageMetadataInterfaceBase::~ImageMetadataInterfaceBase ( )
overrideprotecteddefault

Get the GCP projection coordinates of the image.

◆ ImageMetadataInterfaceBase() [2/2]

otb::ImageMetadataInterfaceBase::ImageMetadataInterfaceBase ( const Self &  )
privatedelete

Get the GCP projection coordinates of the image.

Member Function Documentation

◆ CheckFetch() [1/4]

bool otb::ImageMetadataInterfaceBase::CheckFetch ( MDNum  key,
ImageMetadata &  imd,
const char *  path,
int  band = -1 
)

Get the GCP projection coordinates of the image.

◆ CheckFetch() [2/4]

bool otb::ImageMetadataInterfaceBase::CheckFetch ( MDStr  key,
ImageMetadata &  imd,
const char *  path,
int  band = -1 
)

Get the GCP projection coordinates of the image.

◆ CheckFetch() [3/4]

bool otb::ImageMetadataInterfaceBase::CheckFetch ( MDTime  key,
ImageMetadata &  imd,
const char *  path,
int  band = -1 
)

Get the GCP projection coordinates of the image.

◆ CheckFetch() [4/4]

bool otb::ImageMetadataInterfaceBase::CheckFetch ( std::string  key,
ImageMetadata &  imd,
const char *  path,
int  band = -1 
)

Get the GCP projection coordinates of the image.

◆ Fetch() [1/4]

const double& otb::ImageMetadataInterfaceBase::Fetch ( MDNum  key,
ImageMetadata &  imd,
const char *  path,
int  band = -1 
)

Get the GCP projection coordinates of the image.

◆ Fetch() [2/4]

const std::string& otb::ImageMetadataInterfaceBase::Fetch ( MDStr  key,
ImageMetadata &  imd,
const char *  path,
int  band = -1 
)

Get the GCP projection coordinates of the image.

◆ Fetch() [3/4]

const MetaData::TimePoint& otb::ImageMetadataInterfaceBase::Fetch ( MDTime  key,
ImageMetadata &  imd,
const char *  path,
int  band = -1 
)

Get the GCP projection coordinates of the image.

◆ Fetch() [4/4]

const std::string& otb::ImageMetadataInterfaceBase::Fetch ( std::string  key,
ImageMetadata &  imd,
const char *  path,
int  band = -1 
)

Get the GCP projection coordinates of the image.

◆ FetchRPC()

const boost::any& otb::ImageMetadataInterfaceBase::FetchRPC ( ImageMetadata &  imd,
const double  lineOffset = 0.0,
const double  sampleOffset = 0.0 
)

Get the GCP projection coordinates of the image.

◆ GetGCPCol()

double otb::ImageMetadataInterfaceBase::GetGCPCol ( unsigned int  GCPnum) const

Get the GCP projection coordinates of the image.

◆ GetGCPCount()

UnsignedIntType otb::ImageMetadataInterfaceBase::GetGCPCount ( ) const

Get the GCP projection coordinates of the image.

◆ GetGCPId()

std::string otb::ImageMetadataInterfaceBase::GetGCPId ( unsigned int  GCPnum) const

Get the GCP projection coordinates of the image.

◆ GetGCPInfo()

std::string otb::ImageMetadataInterfaceBase::GetGCPInfo ( unsigned int  GCPnum) const

Get the GCP projection coordinates of the image.

◆ GetGCPProjection()

std::string otb::ImageMetadataInterfaceBase::GetGCPProjection ( ) const

Get the GCP projection coordinates of the image.

◆ GetGCPRow()

double otb::ImageMetadataInterfaceBase::GetGCPRow ( unsigned int  GCPnum) const

Get the GCP projection coordinates of the image.

◆ GetGCPs()

GCP& otb::ImageMetadataInterfaceBase::GetGCPs ( unsigned int  GCPnum)

Get the GCP projection coordinates of the image.

◆ GetGCPX()

double otb::ImageMetadataInterfaceBase::GetGCPX ( unsigned int  GCPnum) const

Get the GCP projection coordinates of the image.

◆ GetGCPY()

double otb::ImageMetadataInterfaceBase::GetGCPY ( unsigned int  GCPnum) const

Get the GCP projection coordinates of the image.

◆ GetGCPZ()

double otb::ImageMetadataInterfaceBase::GetGCPZ ( unsigned int  GCPnum) const

Get the GCP projection coordinates of the image.

◆ GetGeoTransform()

VectorType otb::ImageMetadataInterfaceBase::GetGeoTransform ( ) const

Get the six coefficients of affine geoTtransform.

◆ GetLowerLeftCorner()

VectorType otb::ImageMetadataInterfaceBase::GetLowerLeftCorner ( ) const

Get the GCP projection coordinates of the image.

◆ GetLowerRightCorner()

VectorType otb::ImageMetadataInterfaceBase::GetLowerRightCorner ( ) const

Get the GCP projection coordinates of the image.

◆ GetMetaDataDictionary()

const MetaDataDictionaryType& otb::ImageMetadataInterfaceBase::GetMetaDataDictionary ( ) const

Get the MetadataDictionary

◆ GetNameOfClass()

virtual const char* otb::ImageMetadataInterfaceBase::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented in otb::TerraSarXSarImageMetadataInterface, otb::SarImageMetadataInterface, otb::CosmoImageMetadataInterface, otb::DefaultImageMetadataInterface, otb::OpticalDefaultImageMetadataInterface, otb::SarDefaultImageMetadataInterface, otb::Sentinel1ImageMetadataInterface, otb::PleiadesImageMetadataInterface, otb::FormosatImageMetadataInterface, otb::OpticalImageMetadataInterface, otb::Radarsat2ImageMetadataInterface, otb::Spot6ImageMetadataInterface, otb::SpotImageMetadataInterface, otb::IkonosImageMetadataInterface, otb::QuickBirdImageMetadataInterface, otb::WorldView2ImageMetadataInterface, and otb::GDALImageMetadataInterface.

◆ GetProjectionRef()

std::string otb::ImageMetadataInterfaceBase::GetProjectionRef ( ) const

Get the projection coordinate system of the image.

◆ GetUpperLeftCorner()

VectorType otb::ImageMetadataInterfaceBase::GetUpperLeftCorner ( ) const

Get image corners.

◆ GetUpperRightCorner()

VectorType otb::ImageMetadataInterfaceBase::GetUpperRightCorner ( ) const

Get the GCP projection coordinates of the image.

◆ operator=()

void otb::ImageMetadataInterfaceBase::operator= ( const Self &  )
privatedelete

Get the GCP projection coordinates of the image.

◆ Parse()

virtual void otb::ImageMetadataInterfaceBase::Parse ( ImageMetadata &  )
inlinevirtual

Parses the metadata using the MetadataSupplierInterface and fill the ImageMetadata object Raises "MissingMetadataException" if parsing fails.

Reimplemented in otb::FormosatImageMetadataInterface, otb::TerraSarXSarImageMetadataInterface, otb::Sentinel1ImageMetadataInterface, otb::Radarsat2ImageMetadataInterface, otb::CosmoImageMetadataInterface, otb::SpotImageMetadataInterface, otb::PleiadesImageMetadataInterface, otb::Spot6ImageMetadataInterface, otb::IkonosImageMetadataInterface, otb::WorldView2ImageMetadataInterface, and otb::GDALImageMetadataInterface.

Definition at line 133 of file otbImageMetadataInterfaceBase.h.

References otbGenericExceptionMacro.

◆ PrintSelf()

void otb::ImageMetadataInterfaceBase::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Get the GCP projection coordinates of the image.

◆ SetImage()

void otb::ImageMetadataInterfaceBase::SetImage ( ImageType *  image)

Set the image used to get the metadata

◆ SetMetaDataDictionary()

void otb::ImageMetadataInterfaceBase::SetMetaDataDictionary ( const MetaDataDictionaryType &  dict)

Set the MetadataDictionary

◆ SetMetadataSupplierInterface()

void otb::ImageMetadataInterfaceBase::SetMetadataSupplierInterface ( const MetadataSupplierInterface &  )

Set the MetadataSupplierInterface

Member Data Documentation

◆ m_GCP

GCP otb::ImageMetadataInterfaceBase::m_GCP
private

Get the GCP projection coordinates of the image.

Definition at line 166 of file otbImageMetadataInterfaceBase.h.

◆ m_MetaDataDictionary

MetaDataDictionaryType otb::ImageMetadataInterfaceBase::m_MetaDataDictionary
protected

Get the GCP projection coordinates of the image.

Definition at line 158 of file otbImageMetadataInterfaceBase.h.

◆ m_MetadataSupplierInterface

const MetadataSupplierInterface* otb::ImageMetadataInterfaceBase::m_MetadataSupplierInterface = nullptr
protected

Get the GCP projection coordinates of the image.

Definition at line 160 of file otbImageMetadataInterfaceBase.h.

The documentation for this class was generated from the following file:
Generated at Wed Feb 28 2024 15:25:06 for OTB with   doxygen 1.8.17