OTB  5.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::SpotImageMetadataInterface Class Reference

#include <otbSpotImageMetadataInterface.h>

+ Inheritance diagram for otb::SpotImageMetadataInterface:
+ Collaboration diagram for otb::SpotImageMetadataInterface:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
Superclass::ImageKeywordlistType 
ImageKeywordlistType
 
typedef Superclass::ImageType ImageType
 
typedef
Superclass::MetaDataDictionaryType 
MetaDataDictionaryType
 
typedef itk::SmartPointer< SelfPointer
 
typedef SpotImageMetadataInterface Self
 
typedef
OpticalImageMetadataInterface 
Superclass
 
typedef
Superclass::VariableLengthVectorType 
VariableLengthVectorType
 
typedef Superclass::VectorType VectorType
 
- Public Types inherited from otb::OpticalImageMetadataInterface
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 itk::Object Superclass
 
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
 
bool CanRead () const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
int GetDay () const
 
std::vector< unsigned int > GetDefaultDisplay () const
 
std::vector< std::string > GetEnhancedBandNames () const
 
VariableLengthVectorType GetFirstWavelengths () const
 
int GetHour () const
 
std::string GetInstrument () const
 
unsigned int GetInstrumentIndex () const
 
VariableLengthVectorType GetLastWavelengths () const
 
int GetMinute () const
 
int GetMonth () const
 
virtual const char * GetNameOfClass () const
 
VariableLengthVectorType GetPhysicalBias () const
 
VariableLengthVectorType GetPhysicalGain () const
 
int GetProductionDay () const
 
int GetProductionMonth () const
 
int GetProductionYear () const
 
double GetSatAzimuth () const
 
double GetSatElevation () const
 
VariableLengthVectorType GetSolarIrradiance () const
 
WavelengthSpectralBandVectorType GetSpectralSensitivity () const
 
int GetYear () const
 
- Public Member Functions inherited from otb::OpticalImageMetadataInterface
double GetSunAzimuth () const
 
double GetSunElevation () const
 
- Public Member Functions inherited from otb::ImageMetadataInterfaceBase
double GetGCPCol (unsigned int GCPnum) const
 
unsigned int 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
 
VectorType GetLowerLeftCorner () const
 
VectorType GetLowerRightCorner () const
 
const MetaDataDictionaryTypeGetMetaDataDictionary () const
 
std::string GetProjectionRef () const
 
VectorType GetUpperLeftCorner () const
 
VectorType GetUpperRightCorner () const
 
void SetImage (ImageType *image)
 
void SetMetaDataDictionary (const MetaDataDictionaryType &dict)
 
std::string GetGCPProjection () const
 
ImageKeywordlistType GetImageKeywordlist ()
 
const ImageKeywordlistType GetImageKeywordlist () const
 
std::string GetSensorID () const
 
unsigned int GetNumberOfBands () const
 
std::vector< std::string > GetBandName () const
 
double GetXPixelSpacing () const
 
double GetYPixelSpacing () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
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 ITK_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) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
- 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
 

Static Public Member Functions

static Pointer New ()
 
- 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 Member Functions

 SpotImageMetadataInterface ()
 
virtual ~SpotImageMetadataInterface ()
 
- Protected Member Functions inherited from otb::OpticalImageMetadataInterface
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
 OpticalImageMetadataInterface ()
 
virtual ~OpticalImageMetadataInterface ()
 
- Protected Member Functions inherited from otb::ImageMetadataInterfaceBase
 ImageMetadataInterfaceBase ()
 
virtual ~ImageMetadataInterfaceBase ()
 
- 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 &)
 
 SpotImageMetadataInterface (const Self &)
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from otb::ImageMetadataInterfaceBase
MetaDataDictionaryType m_MetaDataDictionary
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Detailed Description

Creation of an "otb" SpotImageMetadataInterface that gets metadata.

Definition at line 32 of file otbSpotImageMetadataInterface.h.

Member Typedef Documentation

Definition at line 39 of file otbSpotImageMetadataInterface.h.

typedef Superclass::ImageKeywordlistType otb::SpotImageMetadataInterface::ImageKeywordlistType

Definition at line 51 of file otbSpotImageMetadataInterface.h.

typedef Superclass::ImageType otb::SpotImageMetadataInterface::ImageType

Definition at line 45 of file otbSpotImageMetadataInterface.h.

typedef Superclass::MetaDataDictionaryType otb::SpotImageMetadataInterface::MetaDataDictionaryType

Definition at line 48 of file otbSpotImageMetadataInterface.h.

Definition at line 38 of file otbSpotImageMetadataInterface.h.

Definition at line 36 of file otbSpotImageMetadataInterface.h.

Definition at line 37 of file otbSpotImageMetadataInterface.h.

typedef Superclass::VariableLengthVectorType otb::SpotImageMetadataInterface::VariableLengthVectorType

Definition at line 50 of file otbSpotImageMetadataInterface.h.

typedef Superclass::VectorType otb::SpotImageMetadataInterface::VectorType

Definition at line 49 of file otbSpotImageMetadataInterface.h.

Constructor & Destructor Documentation

otb::SpotImageMetadataInterface::SpotImageMetadataInterface ( )
protected
virtual otb::SpotImageMetadataInterface::~SpotImageMetadataInterface ( )
inlineprotectedvirtual

Definition at line 128 of file otbSpotImageMetadataInterface.h.

otb::SpotImageMetadataInterface::SpotImageMetadataInterface ( const Self )
private

Member Function Documentation

virtual unsigned int otb::SpotImageMetadataInterface::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 from otb::OpticalImageMetadataInterface.

bool otb::SpotImageMetadataInterface::CanRead ( ) const
virtual
virtual::itk::LightObject::Pointer otb::SpotImageMetadataInterface::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

int otb::SpotImageMetadataInterface::GetDay ( ) const
virtual

Get the imaging acquisition day from the ossim metadata : IMAGING_DATE metadata variable

Implements otb::ImageMetadataInterfaceBase.

std::vector<unsigned int> otb::SpotImageMetadataInterface::GetDefaultDisplay ( ) const
virtual

Get the 3 spectral band numbers corresponding to the default display for visualization, in the order R, G, B

Implements otb::ImageMetadataInterfaceBase.

std::vector<std::string> otb::SpotImageMetadataInterface::GetEnhancedBandNames ( ) const
inlinevirtual

Get the enhanced band names (here nothing because the metadata did not provide band names)

Implements otb::OpticalImageMetadataInterface.

Definition at line 99 of file otbSpotImageMetadataInterface.h.

VariableLengthVectorType otb::SpotImageMetadataInterface::GetFirstWavelengths ( ) const
virtual

Get the first wavelength for the spectral band definition

Implements otb::OpticalImageMetadataInterface.

int otb::SpotImageMetadataInterface::GetHour ( ) const
virtual

Get the imaging acquisition hour from the ossim metadata : IMAGING_DATE metadata variable

Implements otb::ImageMetadataInterfaceBase.

std::string otb::SpotImageMetadataInterface::GetInstrument ( ) const

Get Instrument

unsigned int otb::SpotImageMetadataInterface::GetInstrumentIndex ( ) const

Get Instrument Index

VariableLengthVectorType otb::SpotImageMetadataInterface::GetLastWavelengths ( ) const
virtual

Get the last wavelength for the spectral band definition

Implements otb::OpticalImageMetadataInterface.

int otb::SpotImageMetadataInterface::GetMinute ( ) const
virtual

Get the imaging acquisition year from the ossim metadata : IMAGING_DATE metadata variable

Implements otb::ImageMetadataInterfaceBase.

int otb::SpotImageMetadataInterface::GetMonth ( ) const
virtual

Get the imaging acquisition month from the ossim metadata : IMAGING_DATE metadata variable

Implements otb::ImageMetadataInterfaceBase.

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

Run-time type information (and related methods).

Reimplemented from otb::OpticalImageMetadataInterface.

VariableLengthVectorType otb::SpotImageMetadataInterface::GetPhysicalBias ( ) const
virtual

Get the radiometric bias from the ossim metadata

Implements otb::OpticalImageMetadataInterface.

VariableLengthVectorType otb::SpotImageMetadataInterface::GetPhysicalGain ( ) const
virtual

Get the radiometric gain from the ossim metadata

Implements otb::OpticalImageMetadataInterface.

int otb::SpotImageMetadataInterface::GetProductionDay ( ) const
virtual

Get the imaging production day from the ossim metadata : DATASET_PRODUCTION_DATE metadata variable

Implements otb::ImageMetadataInterfaceBase.

int otb::SpotImageMetadataInterface::GetProductionMonth ( ) const
virtual

Get the imaging production month from the ossim metadata : DATASET_PRODUCTION_DATE metadata variable

Implements otb::ImageMetadataInterfaceBase.

int otb::SpotImageMetadataInterface::GetProductionYear ( ) const
virtual

Get the imaging production year from the ossim metadata : DATASET_PRODUCTION_DATE metadata variable

Implements otb::ImageMetadataInterfaceBase.

double otb::SpotImageMetadataInterface::GetSatAzimuth ( ) const
virtual

Get the sat azimuth from the ossim metadata

Implements otb::OpticalImageMetadataInterface.

double otb::SpotImageMetadataInterface::GetSatElevation ( ) const
virtual

Get the sat elevation from the ossim metadata

Implements otb::OpticalImageMetadataInterface.

VariableLengthVectorType otb::SpotImageMetadataInterface::GetSolarIrradiance ( ) const
virtual

Get the solar irradiance from the ossim metadata

Implements otb::OpticalImageMetadataInterface.

WavelengthSpectralBandVectorType otb::SpotImageMetadataInterface::GetSpectralSensitivity ( ) const
virtual

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

Implements otb::OpticalImageMetadataInterface.

int otb::SpotImageMetadataInterface::GetYear ( ) const
virtual

Get the imaging acquisition year from the ossim metadata : IMAGING_DATE metadata variable

Implements otb::ImageMetadataInterfaceBase.

static Pointer otb::SpotImageMetadataInterface::New ( )
static

Method for creation through the object factory.

void otb::SpotImageMetadataInterface::operator= ( const Self )
private

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