OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::SarImageMetadataInterface Class Referenceabstract

#include <otbSarImageMetadataInterface.h>

+ Inheritance diagram for otb::SarImageMetadataInterface:
+ Collaboration diagram for otb::SarImageMetadataInterface:

Public Types

typedef std::array< int, 2 > ArrayIndexType
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::ImageType ImageType
 
typedef ImageType::IndexType IndexType
 
typedef LookupDataType::Pointer LookupDataPointerType
 
typedef SarCalibrationLookupData LookupDataType
 
typedef Superclass::MetaDataDictionaryType MetaDataDictionaryType
 
typedef itk::SmartPointer< SelfPointer
 
typedef PointSetType::Pointer PointSetPointer
 
typedef itk::PointSet< double, 2 > PointSetType
 
typedef PointSetType::PointType PointType
 
typedef double RealType
 
typedef SarImageMetadataInterface Self
 
typedef Superclass::StringVectorType StringVectorType
 
typedef ImageMetadataInterfaceBase Superclass
 
typedef Superclass::UIntVectorType UIntVectorType
 
typedef Superclass::VariableLengthVectorType VariableLengthVectorType
 
typedef Superclass::VectorType VectorType
 
- Public Types inherited from otb::ImageMetadataInterfaceBase
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::ImageBase< 2 > ImageType
 
typedef itk::MetaDataDictionary MetaDataDictionaryType
 
typedef itk::SmartPointer< SelfPointer
 
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

virtual bool CreateCalibrationLookupData (SARCalib &, const ImageMetadata &, const MetadataSupplierInterface &, const bool) const
 
std::vector< AzimuthFmRateGetAzimuthFmRateGeom () const
 
std::vector< BurstRecordGetBurstRecordsGeom () const
 
virtual double GetCenterIncidenceAngle (const MetadataSupplierInterface &mds) const =0
 
std::vector< DopplerCentroidGetDopplerCentroidGeom () const
 
virtual const char * GetNameOfClass () const
 
std::vector< OrbitGetOrbitsGeom () const
 
virtual PointSetPointer GetRadiometricCalibrationAntennaPatternNewGain () const
 
virtual ArrayIndexType GetRadiometricCalibrationAntennaPatternNewGainPolynomialDegree () const
 
virtual PointSetPointer GetRadiometricCalibrationAntennaPatternOldGain () const
 
virtual ArrayIndexType GetRadiometricCalibrationAntennaPatternOldGainPolynomialDegree () const
 
virtual PointSetPointer GetRadiometricCalibrationIncidenceAngle (const MetadataSupplierInterface &) const
 
virtual ArrayIndexType GetRadiometricCalibrationIncidenceAnglePolynomialDegree () const
 
virtual PointSetPointer GetRadiometricCalibrationNoise (const MetadataSupplierInterface &, const ImageMetadata &, const std::string &b="") const
 
virtual ArrayIndexType GetRadiometricCalibrationNoisePolynomialDegree () const
 
virtual PointSetPointer GetRadiometricCalibrationRangeSpreadLoss () const
 
virtual ArrayIndexType GetRadiometricCalibrationRangeSpreadLossPolynomialDegree () const
 
virtual double GetRescalingFactor () const
 
bool GetSAR (SARParam &) const
 
virtual bool HasCalibrationLookupDataFlag (const MetadataSupplierInterface &) const
 
void LoadRadiometricCalibrationData (SARCalib &sarCalib, const MetadataSupplierInterface &mds, const ImageMetadata &imd, const std::string &band="") const
 
virtual void ParseGdal (ImageMetadata &)=0
 
virtual void ParseGeom (ImageMetadata &)=0
 
- Public Member Functions inherited from otb::ImageMetadataInterfaceBase
const MetaDataDictionaryTypeGetMetaDataDictionary () const
 
std::string GetProjectionRef () const
 
void SetImage (ImageType *image)
 
void SetMetaDataDictionary (const MetaDataDictionaryType &dict)
 
void SetMetadataSupplierInterface (const MetadataSupplierInterface &)
 
std::string GetGCPProjection () const
 
UnsignedIntType GetGCPCount () const
 
GCPGetGCPs (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::TimePointFetch (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)
 

Protected Member Functions

ArrayIndexType GetConstantPolynomialDegree () const
 
PointSetPointer GetConstantValuePointSet (const RealType &value) const
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 SarImageMetadataInterface ()
 
 ~SarImageMetadataInterface () override=default
 
- Protected Member Functions inherited from otb::ImageMetadataInterfaceBase
 ImageMetadataInterfaceBase ()=default
 
 ~ImageMetadataInterfaceBase () override=default
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 

Private Member Functions

void operator= (const Self &)=delete
 
 SarImageMetadataInterface (const Self &)=delete
 

Additional Inherited Members

- Protected Attributes inherited from otb::ImageMetadataInterfaceBase
MetaDataDictionaryType m_MetaDataDictionary
 
const MetadataSupplierInterfacem_MetadataSupplierInterface = nullptr
 

Detailed Description

Class for SAR captor metadata reading.

Definition at line 42 of file otbSarImageMetadataInterface.h.

Member Typedef Documentation

◆ ArrayIndexType

Definition at line 55 of file otbSarImageMetadataInterface.h.

◆ ConstPointer

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

Definition at line 48 of file otbSarImageMetadataInterface.h.

◆ ImageType

typedef Superclass::ImageType otb::SarImageMetadataInterface::ImageType

Definition at line 51 of file otbSarImageMetadataInterface.h.

◆ IndexType

typedef ImageType::IndexType otb::SarImageMetadataInterface::IndexType

Definition at line 54 of file otbSarImageMetadataInterface.h.

◆ LookupDataPointerType

Definition at line 66 of file otbSarImageMetadataInterface.h.

◆ LookupDataType

Definition at line 65 of file otbSarImageMetadataInterface.h.

◆ MetaDataDictionaryType

typedef Superclass::MetaDataDictionaryType otb::SarImageMetadataInterface::MetaDataDictionaryType

Definition at line 56 of file otbSarImageMetadataInterface.h.

◆ Pointer

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

Definition at line 47 of file otbSarImageMetadataInterface.h.

◆ PointSetPointer

typedef PointSetType::Pointer otb::SarImageMetadataInterface::PointSetPointer

Definition at line 62 of file otbSarImageMetadataInterface.h.

◆ PointSetType

typedef itk::PointSet<double, 2> otb::SarImageMetadataInterface::PointSetType

Definition at line 61 of file otbSarImageMetadataInterface.h.

◆ PointType

typedef PointSetType::PointType otb::SarImageMetadataInterface::PointType

Definition at line 64 of file otbSarImageMetadataInterface.h.

◆ RealType

Definition at line 63 of file otbSarImageMetadataInterface.h.

◆ Self

Definition at line 45 of file otbSarImageMetadataInterface.h.

◆ StringVectorType

typedef Superclass::StringVectorType otb::SarImageMetadataInterface::StringVectorType

Definition at line 60 of file otbSarImageMetadataInterface.h.

◆ Superclass

Definition at line 46 of file otbSarImageMetadataInterface.h.

◆ UIntVectorType

typedef Superclass::UIntVectorType otb::SarImageMetadataInterface::UIntVectorType

Definition at line 59 of file otbSarImageMetadataInterface.h.

◆ VariableLengthVectorType

typedef Superclass::VariableLengthVectorType otb::SarImageMetadataInterface::VariableLengthVectorType

Definition at line 58 of file otbSarImageMetadataInterface.h.

◆ VectorType

typedef Superclass::VectorType otb::SarImageMetadataInterface::VectorType

Definition at line 57 of file otbSarImageMetadataInterface.h.

Constructor & Destructor Documentation

◆ SarImageMetadataInterface() [1/2]

otb::SarImageMetadataInterface::SarImageMetadataInterface ( )
protected

◆ ~SarImageMetadataInterface()

otb::SarImageMetadataInterface::~SarImageMetadataInterface ( )
overrideprotecteddefault

◆ SarImageMetadataInterface() [2/2]

otb::SarImageMetadataInterface::SarImageMetadataInterface ( const Self )
privatedelete

Member Function Documentation

◆ CreateCalibrationLookupData()

virtual bool otb::SarImageMetadataInterface::CreateCalibrationLookupData ( SARCalib ,
const ImageMetadata ,
const MetadataSupplierInterface ,
const bool   
) const
virtual

◆ GetAzimuthFmRateGeom()

std::vector<AzimuthFmRate> otb::SarImageMetadataInterface::GetAzimuthFmRateGeom ( ) const

◆ GetBurstRecordsGeom()

std::vector<BurstRecord> otb::SarImageMetadataInterface::GetBurstRecordsGeom ( ) const

◆ GetCenterIncidenceAngle()

virtual double otb::SarImageMetadataInterface::GetCenterIncidenceAngle ( const MetadataSupplierInterface mds) const
pure virtual

◆ GetConstantPolynomialDegree()

ArrayIndexType otb::SarImageMetadataInterface::GetConstantPolynomialDegree ( ) const
protected

◆ GetConstantValuePointSet()

PointSetPointer otb::SarImageMetadataInterface::GetConstantValuePointSet ( const RealType value) const
protected

◆ GetDopplerCentroidGeom()

std::vector<DopplerCentroid> otb::SarImageMetadataInterface::GetDopplerCentroidGeom ( ) const

◆ GetNameOfClass()

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

◆ GetOrbitsGeom()

std::vector<Orbit> otb::SarImageMetadataInterface::GetOrbitsGeom ( ) const

◆ GetRadiometricCalibrationAntennaPatternNewGain()

virtual PointSetPointer otb::SarImageMetadataInterface::GetRadiometricCalibrationAntennaPatternNewGain ( ) const
virtual

◆ GetRadiometricCalibrationAntennaPatternNewGainPolynomialDegree()

virtual ArrayIndexType otb::SarImageMetadataInterface::GetRadiometricCalibrationAntennaPatternNewGainPolynomialDegree ( ) const
virtual

◆ GetRadiometricCalibrationAntennaPatternOldGain()

virtual PointSetPointer otb::SarImageMetadataInterface::GetRadiometricCalibrationAntennaPatternOldGain ( ) const
virtual

◆ GetRadiometricCalibrationAntennaPatternOldGainPolynomialDegree()

virtual ArrayIndexType otb::SarImageMetadataInterface::GetRadiometricCalibrationAntennaPatternOldGainPolynomialDegree ( ) const
virtual

◆ GetRadiometricCalibrationIncidenceAngle()

virtual PointSetPointer otb::SarImageMetadataInterface::GetRadiometricCalibrationIncidenceAngle ( const MetadataSupplierInterface ) const
virtual

◆ GetRadiometricCalibrationIncidenceAnglePolynomialDegree()

virtual ArrayIndexType otb::SarImageMetadataInterface::GetRadiometricCalibrationIncidenceAnglePolynomialDegree ( ) const
virtual

◆ GetRadiometricCalibrationNoise()

virtual PointSetPointer otb::SarImageMetadataInterface::GetRadiometricCalibrationNoise ( const MetadataSupplierInterface ,
const ImageMetadata ,
const std::string &  b = "" 
) const
virtual

◆ GetRadiometricCalibrationNoisePolynomialDegree()

virtual ArrayIndexType otb::SarImageMetadataInterface::GetRadiometricCalibrationNoisePolynomialDegree ( ) const
virtual

◆ GetRadiometricCalibrationRangeSpreadLoss()

virtual PointSetPointer otb::SarImageMetadataInterface::GetRadiometricCalibrationRangeSpreadLoss ( ) const
virtual

◆ GetRadiometricCalibrationRangeSpreadLossPolynomialDegree()

virtual ArrayIndexType otb::SarImageMetadataInterface::GetRadiometricCalibrationRangeSpreadLossPolynomialDegree ( ) const
virtual

◆ GetRescalingFactor()

virtual double otb::SarImageMetadataInterface::GetRescalingFactor ( ) const
virtual

◆ GetSAR()

bool otb::SarImageMetadataInterface::GetSAR ( SARParam ) const

◆ HasCalibrationLookupDataFlag()

virtual bool otb::SarImageMetadataInterface::HasCalibrationLookupDataFlag ( const MetadataSupplierInterface ) const
virtual

◆ LoadRadiometricCalibrationData()

void otb::SarImageMetadataInterface::LoadRadiometricCalibrationData ( SARCalib sarCalib,
const MetadataSupplierInterface mds,
const ImageMetadata imd,
const std::string &  band = "" 
) const

Loads the radiometric calibration data to the SARCalib.

Parameters
sarCalibThe SARCalib objct to complete
mdsThe MetadataSupplierInterface containing the calibration data
imdThe ImageMetadata containing the calibration data

◆ operator=()

void otb::SarImageMetadataInterface::operator= ( const Self )
privatedelete

◆ ParseGdal()

virtual void otb::SarImageMetadataInterface::ParseGdal ( ImageMetadata )
pure virtual

◆ ParseGeom()

virtual void otb::SarImageMetadataInterface::ParseGeom ( ImageMetadata )
pure virtual

◆ PrintSelf()

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

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