Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::SpotImageMetadataInterface Class Reference

Creation of an "otb" SpotImageMetadataInterface that gets metadata. More...

#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 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
std::vector< std::string > GetBandName () const
 
double GetGCPCol (unsigned int GCPnum) const
 
unsigned int GetGCPCount () const
 
std::string GetGCPId (unsigned int GCPnum) const
 
std::string GetGCPInfo (unsigned int GCPnum) const
 
std::string GetGCPProjection () 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
 
unsigned int GetNumberOfBands () const
 
std::string GetProjectionRef () const
 
std::string GetSensorID () const
 
VectorType GetUpperLeftCorner () const
 
VectorType GetUpperRightCorner () const
 
double GetXPixelSpacing () const
 
double GetYPixelSpacing () const
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent, const MetaDataDictionaryType &dict) const
 
void SetImage (ImageType *image)
 
void SetMetaDataDictionary (const MetaDataDictionaryType &dict)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 SpotImageMetadataInterface ()
 
virtual ~SpotImageMetadataInterface ()
 
- Protected Member Functions inherited from otb::OpticalImageMetadataInterface
 OpticalImageMetadataInterface ()
 
virtual ~OpticalImageMetadataInterface ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
- Protected Member Functions inherited from otb::ImageMetadataInterfaceBase
 ImageMetadataInterfaceBase ()
 
virtual ~ImageMetadataInterfaceBase ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 

Private Member Functions

 SpotImageMetadataInterface (const Self &)
 
void operator= (const Self &)
 

Additional Inherited Members

- Protected Attributes inherited from otb::ImageMetadataInterfaceBase
MetaDataDictionaryType m_MetaDataDictionary
 

Detailed Description

Creation of an "otb" SpotImageMetadataInterface that gets metadata.

Definition at line 30 of file otbSpotImageMetadataInterface.h.

Member Typedef Documentation

Definition at line 37 of file otbSpotImageMetadataInterface.h.

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

Definition at line 49 of file otbSpotImageMetadataInterface.h.

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

Definition at line 43 of file otbSpotImageMetadataInterface.h.

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

Definition at line 46 of file otbSpotImageMetadataInterface.h.

Definition at line 36 of file otbSpotImageMetadataInterface.h.

Definition at line 34 of file otbSpotImageMetadataInterface.h.

Definition at line 35 of file otbSpotImageMetadataInterface.h.

Definition at line 48 of file otbSpotImageMetadataInterface.h.

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

Definition at line 47 of file otbSpotImageMetadataInterface.h.

Constructor & Destructor Documentation

otb::SpotImageMetadataInterface::SpotImageMetadataInterface ( )
protected

Definition at line 30 of file otbSpotImageMetadataInterface.cxx.

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

Definition at line 126 of file otbSpotImageMetadataInterface.h.

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

Member Function Documentation

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.

Definition at line 697 of file otbSpotImageMetadataInterface.cxx.

References otbMsgDevMacro.

bool otb::SpotImageMetadataInterface::CanRead ( ) const
virtual
virtual::itk::LightObject::Pointer otb::SpotImageMetadataInterface::CreateAnother ( void  ) const
int otb::SpotImageMetadataInterface::GetDay ( ) const
virtual
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.

Definition at line 707 of file otbSpotImageMetadataInterface.cxx.

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 97 of file otbSpotImageMetadataInterface.h.

SpotImageMetadataInterface::VariableLengthVectorType otb::SpotImageMetadataInterface::GetFirstWavelengths ( ) const
virtual
int otb::SpotImageMetadataInterface::GetHour ( ) const
virtual
std::string otb::SpotImageMetadataInterface::GetInstrument ( ) const
unsigned int otb::SpotImageMetadataInterface::GetInstrumentIndex ( ) const
SpotImageMetadataInterface::VariableLengthVectorType otb::SpotImageMetadataInterface::GetLastWavelengths ( ) const
virtual
int otb::SpotImageMetadataInterface::GetMinute ( ) const
virtual
int otb::SpotImageMetadataInterface::GetMonth ( ) const
virtual
virtual const char* otb::SpotImageMetadataInterface::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from otb::OpticalImageMetadataInterface.

SpotImageMetadataInterface::VariableLengthVectorType otb::SpotImageMetadataInterface::GetPhysicalBias ( ) const
virtual
SpotImageMetadataInterface::VariableLengthVectorType otb::SpotImageMetadataInterface::GetPhysicalGain ( ) const
virtual
int otb::SpotImageMetadataInterface::GetProductionDay ( ) const
virtual
int otb::SpotImageMetadataInterface::GetProductionMonth ( ) const
virtual
int otb::SpotImageMetadataInterface::GetProductionYear ( ) const
virtual
double otb::SpotImageMetadataInterface::GetSatAzimuth ( ) const
virtual
double otb::SpotImageMetadataInterface::GetSatElevation ( ) const
virtual
SpotImageMetadataInterface::VariableLengthVectorType otb::SpotImageMetadataInterface::GetSolarIrradiance ( ) const
virtual
SpotImageMetadataInterface::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.

Definition at line 718 of file otbSpotImageMetadataInterface.cxx.

References itk::MetaDataDictionary::HasKey(), otb::FilterFunctionValues::New(), and otb::MetaDataKey::OSSIMKeywordlistKey.

int otb::SpotImageMetadataInterface::GetYear ( ) const
virtual
static Pointer otb::SpotImageMetadataInterface::New ( )
static

Method for creation through the object factory.

Referenced by otb::SpectralSensitivityReader::FindFileName().

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

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