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

#include <otbOpticalImageMetadataInterface.h>

+ Inheritance diagram for otb::OpticalImageMetadataInterface:
+ Collaboration diagram for otb::OpticalImageMetadataInterface:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef FilterFunctionValues FilterFunctionValuesType
 
typedef
Superclass::ImageKeywordlistType 
ImageKeywordlistType
 
typedef Superclass::ImageType ImageType
 
typedef otb::ObjectList
< FilterFunctionValuesType
InternalWavelengthSpectralBandVectorType
 
typedef
Superclass::MetaDataDictionaryType 
MetaDataDictionaryType
 
typedef itk::SmartPointer< SelfPointer
 
typedef
OpticalImageMetadataInterface 
Self
 
typedef ImageMetadataInterfaceBase Superclass
 
typedef
Superclass::VariableLengthVectorType 
VariableLengthVectorType
 
typedef Superclass::VectorType VectorType
 
typedef
InternalWavelengthSpectralBandVectorType::Pointer 
WavelengthSpectralBandVectorType
 
- Public Types inherited from otb::ImageMetadataInterfaceBase
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef ImageKeywordlist ImageKeywordlistType
 
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 Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual unsigned int BandIndexToWavelengthPosition (unsigned int i) const
 
std::vector< std::string > GetEnhancedBandNames () const override=0
 
virtual VariableLengthVectorType GetFirstWavelengths () const =0
 
virtual VariableLengthVectorType GetLastWavelengths () const =0
 
virtual const char * GetNameOfClass () const
 
virtual VariableLengthVectorType GetPhysicalBias () const =0
 
virtual VariableLengthVectorType GetPhysicalGain () const =0
 
virtual double GetSatAzimuth () const =0
 
virtual double GetSatElevation () const =0
 
virtual VariableLengthVectorType GetSolarIrradiance () const =0
 
double GetSunAzimuth () const
 
double GetSunElevation () const
 
- Public Member Functions inherited from otb::ImageMetadataInterfaceBase
virtual bool CanRead () const =0
 
virtual UIntVectorType GetDefaultDisplay () const =0
 
double GetGCPCol (unsigned int GCPnum) const
 
UnsignedIntType GetGCPCount () const
 
std::string GetGCPId (unsigned int GCPnum) const
 
std::string GetGCPInfo (unsigned int GCPnum) const
 
double GetGCPRow (unsigned int GCPnum) const
 
OTB_GCPGetGCPs (unsigned int GCPnum)
 
double GetGCPX (unsigned int GCPnum) const
 
double GetGCPY (unsigned int GCPnum) const
 
double GetGCPZ (unsigned int GCPnum) const
 
VectorType GetGeoTransform () const
 
ImageKeywordlistType GetImageKeywordlist ()
 
const ImageKeywordlistType GetImageKeywordlist () const
 
VectorType GetLowerLeftCorner () const
 
VectorType GetLowerRightCorner () const
 
const MetaDataDictionaryTypeGetMetaDataDictionary () const
 
bool GetNoDataFlags (std::vector< bool > &flags, std::vector< double > &values) const
 
std::string GetProjectionRef () const
 
std::string const GetSensorID () const
 
bool GetSensorID (std::string &sensorId) const
 
VectorType GetUpperLeftCorner () const
 
VectorType GetUpperRightCorner () const
 
void SetImage (ImageType *image)
 
void SetMetaDataDictionary (const MetaDataDictionaryType &dict)
 
std::string GetGCPProjection () const
 
UnsignedIntType GetNumberOfBands () const
 
StringVectorType GetBandName () const
 
double GetXPixelSpacing () const
 
double GetYPixelSpacing () const
 
virtual int GetDay () const =0
 
virtual int GetMonth () const =0
 
virtual int GetYear () const =0
 
virtual int GetHour () const =0
 
virtual int GetMinute () const =0
 
virtual int GetProductionDay () const =0
 
virtual int GetProductionMonth () const =0
 
virtual int GetProductionYear () const =0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- 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

void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from otb::ImageMetadataInterfaceBase
 ImageMetadataInterfaceBase ()
 
 ~ImageMetadataInterfaceBase () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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 ()
 

Private Member Functions

void operator= (const Self &)
 
 OpticalImageMetadataInterface (const Self &)
 
virtual
WavelengthSpectralBandVectorType 
GetSpectralSensitivity () const =0
 
 OpticalImageMetadataInterface ()
 
 ~OpticalImageMetadataInterface () override
 

Additional Inherited Members

- Static Public Member Functions inherited from otb::ImageMetadataInterfaceBase
static void PrintMetadata (std::ostream &os, itk::Indent indent, const MetaDataDictionaryType &dict)
 
- 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 ()
 
- Protected Attributes inherited from otb::ImageMetadataInterfaceBase
MetaDataDictionaryType m_MetaDataDictionary
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

Class for Optical captor metadata reading.

Definition at line 39 of file otbOpticalImageMetadataInterface.h.

Member Typedef Documentation

Definition at line 46 of file otbOpticalImageMetadataInterface.h.

Definition at line 57 of file otbOpticalImageMetadataInterface.h.

typedef Superclass::ImageKeywordlistType otb::OpticalImageMetadataInterface::ImageKeywordlistType

Definition at line 55 of file otbOpticalImageMetadataInterface.h.

typedef Superclass::ImageType otb::OpticalImageMetadataInterface::ImageType

Definition at line 49 of file otbOpticalImageMetadataInterface.h.

Definition at line 58 of file otbOpticalImageMetadataInterface.h.

typedef Superclass::MetaDataDictionaryType otb::OpticalImageMetadataInterface::MetaDataDictionaryType

Definition at line 52 of file otbOpticalImageMetadataInterface.h.

Definition at line 45 of file otbOpticalImageMetadataInterface.h.

Definition at line 43 of file otbOpticalImageMetadataInterface.h.

Definition at line 44 of file otbOpticalImageMetadataInterface.h.

typedef Superclass::VariableLengthVectorType otb::OpticalImageMetadataInterface::VariableLengthVectorType

Definition at line 54 of file otbOpticalImageMetadataInterface.h.

typedef Superclass::VectorType otb::OpticalImageMetadataInterface::VectorType

Definition at line 53 of file otbOpticalImageMetadataInterface.h.

Definition at line 59 of file otbOpticalImageMetadataInterface.h.

Constructor & Destructor Documentation

otb::OpticalImageMetadataInterface::OpticalImageMetadataInterface ( )
protected

Vector that contains the filter function value in 6S format (step of 0.0025 micro m). There values a computed by 6S.

otb::OpticalImageMetadataInterface::~OpticalImageMetadataInterface ( )
inlineoverrideprotected

Vector that contains the filter function value in 6S format (step of 0.0025 micro m). There values a computed by 6S.

Definition at line 102 of file otbOpticalImageMetadataInterface.h.

otb::OpticalImageMetadataInterface::OpticalImageMetadataInterface ( const Self )
private

Member Function Documentation

virtual unsigned int otb::OpticalImageMetadataInterface::BandIndexToWavelengthPosition ( unsigned int  i) const
virtual

This method is to handle the permutation of the spectral band by some image provider in most cases, this method won't change the value, but for SPOT data, the bands are set up as 2 1 0 3 in the tiff file, this method which is overloaded for SPOT enables to retrieve the proper band.

Reimplemented in otb::FormosatImageMetadataInterface, otb::SpotImageMetadataInterface, otb::PleiadesImageMetadataInterface, and otb::Spot6ImageMetadataInterface.

std::vector<std::string> otb::OpticalImageMetadataInterface::GetEnhancedBandNames ( ) const
overridepure virtual
virtual VariableLengthVectorType otb::OpticalImageMetadataInterface::GetFirstWavelengths ( ) const
pure virtual
virtual VariableLengthVectorType otb::OpticalImageMetadataInterface::GetLastWavelengths ( ) const
pure virtual
virtual const char* otb::OpticalImageMetadataInterface::GetNameOfClass ( ) const
virtual
virtual VariableLengthVectorType otb::OpticalImageMetadataInterface::GetPhysicalBias ( ) const
pure virtual
virtual VariableLengthVectorType otb::OpticalImageMetadataInterface::GetPhysicalGain ( ) const
pure virtual
virtual double otb::OpticalImageMetadataInterface::GetSatAzimuth ( ) const
pure virtual
virtual double otb::OpticalImageMetadataInterface::GetSatElevation ( ) const
pure virtual
virtual VariableLengthVectorType otb::OpticalImageMetadataInterface::GetSolarIrradiance ( ) const
pure virtual
virtual WavelengthSpectralBandVectorType otb::OpticalImageMetadataInterface::GetSpectralSensitivity ( ) const
pure virtual
double otb::OpticalImageMetadataInterface::GetSunAzimuth ( ) const

Get the sun azimuth from the ossim metadata

double otb::OpticalImageMetadataInterface::GetSunElevation ( ) const

Get the sun elevation from the ossim metadata

void otb::OpticalImageMetadataInterface::operator= ( const Self )
private
void otb::OpticalImageMetadataInterface::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Reimplemented from otb::ImageMetadataInterfaceBase.


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