otbImageMetadata.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef otbImageMetadata_h
#define otbImageMetadata_h
 
#include "otbGeometryMetadata.h"
#include "otbSARMetadata.h"
#include "otbMetaDataKey.h"
#include "OTBMetadataExport.h"
#include "otbSpot5Metadata.h"
#include "otbMacro.h"
 
#include <boost/any.hpp>
#include <vector>
#include <string>
#include <map>
#include <unordered_map>
 
namespace otb
{
 
class OTBMetadata_EXPORT ImageMetadataBase
{
public:
  template <class TKey, class TVal>
  using DictType = std::map<TKey, TVal>;
 
  using Keywordlist = std::unordered_map<std::string, std::string>;
 
  DictType<MDGeom, boost::any> GeometryKeys;
 
  DictType<MDNum, double> NumericKeys;
 
  DictType<MDStr, std::string> StringKeys;
 
  DictType<MDL1D, MetaData::LUT1D> LUT1DKeys;
 
  DictType<MDL2D, MetaData::LUT2D> LUT2DKeys;
 
  DictType<MDTime, MetaData::TimePoint> TimeKeys;
 
  DictType<std::string, std::string> ExtraKeys;
 
  // Constructor
  ImageMetadataBase() = default;
  ImageMetadataBase(DictType<MDGeom, boost::any> geometryKeys,
                    DictType<MDNum, double> numericKeys,
                    DictType<MDStr, std::string> stringKeys,
                    DictType<MDL1D, MetaData::LUT1D> lut1DKeys,
                    DictType<MDL2D, MetaData::LUT2D> lut2DKeys,
                    DictType<MDTime, MetaData::TimePoint> timeKeys,
                    DictType<std::string, std::string> extraKeys);
 
  // -------------------- Geom utility function ----------------------------
 
  const boost::any & operator[](MDGeom key) const;
 
  const Projection::GCPParam & GetGCPParam() const;
  const Projection::RPCParam & GetRPCParam() const;
  const SARParam & GetSARParam() const;
  const Spot5Param & GetSpot5Param() const;
 
  std::string GetProjectedGeometry() const;
 
  std::string GetProjectionWKT() const;
 
  std::string GetProjectionProj() const;
 
  void Add(MDGeom key, const boost::any &value);
 
  size_t Remove(MDGeom key);
 
  size_t RemoveSensorGeometry();
 
  size_t RemoveProjectedGeometry();
 
  bool Has(MDGeom key) const;
 
  bool HasSensorGeometry() const;
 
  bool HasProjectedGeometry() const;
 
  // -------------------- Double utility function ----------------------------
 
  const double & operator[](MDNum key) const;
 
  void Add(MDNum key, const double &value);
 
  size_t Remove(MDNum key);
 
  bool Has(MDNum key) const;
 
  std::string GetKeyListNum() const;
 
  // -------------------- String utility function ----------------------------
 
  const std::string & operator[](MDStr key) const;
 
  void Add(MDStr key, const std::string &value);
 
  size_t Remove(MDStr key);
 
  bool Has(MDStr key) const;
 
  std::string GetKeyListStr() const;
 
  // -------------------- LUT1D utility function ----------------------------
 
  const MetaData::LUT1D & operator[](MDL1D key) const;
 
  void Add(MDL1D key, const MetaData::LUT1D &value);
 
  size_t Remove(MDL1D key);
 
  bool Has(MDL1D key) const;
 
  std::string GetKeyListL1D() const;
 
  // -------------------- 2D LUT utility function ----------------------------
 
  const MetaData::LUT2D & operator[](MDL2D key) const;
 
  void Add(MDL2D key, const MetaData::LUT2D &value);
 
  size_t Remove(MDL2D key);
 
  bool Has(MDL2D key) const;
 
//  std::string GetKeyListL2D() const;
 
  // -------------------- Time utility function ----------------------------
 
  const MetaData::TimePoint & operator[](MDTime key) const;
 
  void Add(MDTime key, const MetaData::TimePoint &value);
 
  size_t Remove(MDTime key);
 
  bool Has(MDTime key) const;
 
  std::string GetKeyListTime() const;
 
  // -------------------- Extra keys utility function --------------------------
 
  const std::string & operator[](const std::string & key) const;
 
  void Add(const std::string& key, const std::string &value);
 
  size_t Remove(const std::string& key);
 
  bool Has(const std::string& key) const;
 
  // -------------------- Other --------------------------
 
  void ToKeywordlist(Keywordlist&) const;
 
  std::string ToJSON(bool multiline=false) const;
 
  bool FromKeywordlist(const Keywordlist&);
 
  void Fuse(const ImageMetadataBase& );
 
  std::vector<unsigned int> GetDefaultDisplay() const;
 
  int GetSize() const;
 
};
 
 
class OTBMetadata_EXPORT ImageMetadata: public ImageMetadataBase
{
public:
  using KeywordlistVector = std::vector<ImageMetadata::Keywordlist>;
 
  using ImageMetadataBandsType = std::vector<ImageMetadataBase>;
  ImageMetadataBandsType Bands;
 
  // Constructor
  ImageMetadata() = default;
  ImageMetadata(DictType<MDGeom, boost::any> geometryKeys,
                DictType<MDNum, double> numericKeys,
                DictType<MDStr, std::string> stringKeys,
                DictType<MDL1D, MetaData::LUT1D> lut1DKeys,
                DictType<MDL2D, MetaData::LUT2D> lut2DKeys,
                DictType<MDTime, MetaData::TimePoint> timeKeys,
                DictType<std::string, std::string> extraKeys,
                ImageMetadataBandsType bands);
 
  // utility functions
  ImageMetadata slice(int start, int end) const;
 
  void append(const ImageMetadata& );
 
  void compact();
 
  void Merge(const ImageMetadata& );
 
  void AppendToKeywordlists(KeywordlistVector&) const;
 
  void AppendToBandKeywordlists(KeywordlistVector&) const;
 
  bool FromKeywordlists(const KeywordlistVector&);
 
  using ImageMetadataBase::Add;
  void Add(MDNum , const MetaDataKey::VariableLengthVectorType);
 
  itk::VariableLengthVector<double> GetAsVector(MDNum key) const;
 
  bool HasBandMetadata(MDNum key) const;
 
  bool HasBandMetadata(MDL1D key) const;
 
  std::vector<std::string> GetBandNames() const;
 
  std::vector<std::string> GetEnhancedBandNames() const;
 
  int GetSize() const;
};
 
extern OTBMetadata_EXPORT std::ostream& operator<<(std::ostream& os, const otb::ImageMetadataBase& imd);
 
extern OTBMetadata_EXPORT std::ostream& operator<<(std::ostream& os, const otb::ImageMetadata& imd);
 
OTBMetadata_EXPORT bool HasOpticalSensorMetadata(const ImageMetadata & imd);
OTBMetadata_EXPORT bool HasSARSensorMetadata(const ImageMetadata & imd);
 
OTBMetadata_EXPORT void WriteImageMetadataToGeomFile(const ImageMetadata & imd, const std::string & filename);
 
bool HasSameRPCModel(const ImageMetadataBase& a, const ImageMetadataBase& b);
bool HasSameSARModel(const ImageMetadataBase& a, const ImageMetadataBase& b);
bool HasSameSensorModel(const ImageMetadataBase& a, const ImageMetadataBase& b);
 
} // end namespace otb
 
#endif