otbImageMetadataInterfaceBase.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ORFEO Toolbox
  Language:  C++
  Date:      $Date$
  Version:   $Revision$


  Copyright (c) Centre National d'Etudes Spatiales. All rights reserved.
  See OTBCopyright.txt for details.


     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __otbImageMetadataInterfaceBase_h
#define __otbImageMetadataInterfaceBase_h

#include <string>

#include "itkMetaDataDictionary.h"
#include "otbMetaDataKey.h"
#include "itkImageBase.h"
#include "otbMacro.h"

namespace otb
{

class ImageKeywordlist;

class ITK_EXPORT ImageMetadataInterfaceBase : public itk::Object
{
public:

  typedef ImageMetadataInterfaceBase    Self;
  typedef itk::Object                   Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;

  itkTypeMacro(ImageMetadataInterfaceBase, itk::Object);

  typedef itk::ImageBase<2>                     ImageType;
  typedef itk::MetaDataDictionary               MetaDataDictionaryType;
  typedef MetaDataKey::VectorType               VectorType;
  typedef MetaDataKey::VariableLengthVectorType VariableLengthVectorType;
  typedef ImageKeywordlist                      ImageKeywordlistType;
  typedef unsigned int                          UnsignedIntType;


  void SetImage (ImageType* image)
  {
    this->SetMetaDataDictionary(image->GetMetaDataDictionary());
  }

  void SetMetaDataDictionary(const MetaDataDictionaryType& dict)
  {
    m_MetaDataDictionary = dict;
  }

  const MetaDataDictionaryType&  GetMetaDataDictionary() const
  {
    return m_MetaDataDictionary;
  }

  std::string GetProjectionRef() const;

  std::string GetGCPProjection() const;
//  otbMetadataGetMacro(GCPProjection, std::string);

  unsigned int GetGCPCount() const;
//  otbMetadataGetMacro(GCPCount, unsigned int);

  OTB_GCP& GetGCPs(unsigned int GCPnum);
  //otbMetadataGetGCPnumMacro(GCPs, OTB_GCP&, GCPnum, unsigned int);

  std::string GetGCPId(unsigned int GCPnum) const;
//  otbMetadataGetGCPnumMacro(GCPId, std::string, GCPnum, unsigned int);

  std::string GetGCPInfo(unsigned int GCPnum) const;
//  otbMetadataGetGCPnumMacro(GCPInfo, std::string, GCPnum, unsigned int);

  double GetGCPRow(unsigned int GCPnum) const;
//  otbMetadataGetGCPnumMacro(GCPRow, double, GCPnum, unsigned int);

  double GetGCPCol(unsigned int GCPnum) const;
//  otbMetadataGetGCPnumMacro(GCPCol, double, GCPnum, unsigned int);

  double GetGCPX(unsigned int GCPnum) const;
//  otbMetadataGetGCPnumMacro(GCPX, double, GCPnum, unsigned int);

  double GetGCPY(unsigned int GCPnum) const;
//  otbMetadataGetGCPnumMacro(GCPY, double, GCPnum, unsigned int);

  double GetGCPZ(unsigned int GCPnum) const;
//  otbMetadataGetGCPnumMacro(GCPZ, double, GCPnum, unsigned int);

  VectorType GetGeoTransform() const;
//  otbMetadataGetMacro(GeoTransform, VectorType);

  VectorType GetUpperLeftCorner() const;
//  otbMetadataGetMacro(UpperLeftCorner, VectorType);

  VectorType GetUpperRightCorner() const;
//  otbMetadataGetMacro(UpperRightCorner, VectorType);

  VectorType GetLowerLeftCorner() const;
//  otbMetadataGetMacro(LowerLeftCorner, VectorType);

  VectorType GetLowerRightCorner() const;
//  otbMetadataGetMacro(LowerRightCorner, VectorType);

  ImageKeywordlistType GetImageKeywordlist();
  const ImageKeywordlistType GetImageKeywordlist() const;

  std::string GetSensorID() const;
  //otbMetadataGetMacro(SensorID, std::string);

  unsigned int GetNumberOfBands() const;
  //otbMetadataGetMacro(NumberOfBands, unsigned int);

  std::vector<std::string> GetBandName() const;
  //otbMetadataGetMacro(BandName, std::vector<std::string>);

  double GetXPixelSpacing() const;
  //otbMetadataGetMacro(XPixelSpacing, double);

  double GetYPixelSpacing() const;
  //otbMetadataGetMacro(YPixelSpacing, double);


  virtual int GetDay() const = 0;
//  otbMetadataGetMacro(Day, int);

  virtual int GetMonth() const = 0;
  //otbMetadataGetMacro(Month, int);

  virtual int GetYear() const = 0;
  //otbMetadataGetMacro(Year, int);

  virtual int GetHour() const = 0;
  //otbMetadataGetMacro(Hour, int);

  virtual int GetMinute() const = 0;
  //otbMetadataGetMacro(Minute, int);

  virtual int GetProductionDay() const = 0;
  //otbMetadataGetMacro(ProductionDay, int);

  virtual int GetProductionMonth() const = 0;
  //otbMetadataGetMacro(ProductionMonth, int);

  virtual int GetProductionYear() const = 0;
  //otbMetadataGetMacro(ProductionYear, int);

  virtual std::vector<std::string> GetEnhancedBandNames () const = 0;

  virtual std::vector<unsigned int> GetDefaultDisplay() const = 0;

  virtual bool CanRead() const = 0;

  virtual void PrintSelf(std::ostream& os, itk::Indent indent, const MetaDataDictionaryType& dict) const;

protected:
  ImageMetadataInterfaceBase();
  virtual ~ImageMetadataInterfaceBase() {}

  void PrintSelf(std::ostream& os, itk::Indent indent) const;

  MetaDataDictionaryType m_MetaDataDictionary;

private:
  ImageMetadataInterfaceBase(const Self &); //purposely not implemented
  void operator =(const Self&); //purposely not implemented

  OTB_GCP            m_GCP;
};

} // end namespace otb

#endif