otbSARMetadata.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 otbSARMetadata_h
#define otbSARMetadata_h
 
#include "OTBMetadataExport.h"
#include "otbMetaDataKey.h"
#include "otbSarCalibrationLookupData.h"
 
#include <string>
#include <vector>
#include <sstream>
#include <unordered_map>
 
#include "itkPoint.h"
 
#include "itkPointSet.h"
#include "otbDateTime.h"
 
namespace otb
{
 
class SarCalibrationLookupData;
 
struct OTBMetadata_EXPORT AzimuthFmRate
{
 
  MetaData::TimePoint azimuthTime;
 
  double t0;
 
  std::vector<double> azimuthFmRatePolynomial;
 
  void ToKeywordlist(MetaData::Keywordlist & kwl, const std::string & prefix = "") const;
 
  static AzimuthFmRate FromKeywordlist(const MetaData::Keywordlist & kwl, const std::string & prefix = "");
};
 
struct OTBMetadata_EXPORT DopplerCentroid
{
 
  MetaData::TimePoint azimuthTime;
  /* Two-way slant range time origin for Doppler centroid estimate */
  double t0;
  /* Doppler centroid estimated from data */
  std::vector<double> dopCoef;
  /* Doppler centroid estimated from orbit */
  std::vector<double> geoDopCoef;
 
  void ToKeywordlist(MetaData::Keywordlist & kwl, const std::string & prefix = "") const;
 
  static DopplerCentroid FromKeywordlist(const MetaData::Keywordlist & kwl, const std::string & prefix = "");
};
 
struct OTBMetadata_EXPORT Orbit
{
  using PointType = itk::Point<double, 3>;
 
  MetaData::TimePoint time;
 
  PointType position;
 
  PointType velocity;
 
  void ToKeywordlist(MetaData::Keywordlist & kwl, const std::string & prefix = "") const;
 
  static Orbit FromKeywordlist(const MetaData::Keywordlist & kwl, const std::string & prefix = "");
};
 
struct OTBMetadata_EXPORT BurstRecord
{
  MetaData::TimePoint      azimuthStartTime;
  MetaData::TimePoint      azimuthStopTime;
  unsigned long startLine;
  unsigned long endLine;
  unsigned long startSample;
  unsigned long endSample;
  double        azimuthAnxTime;
 
  void ToKeywordlist(MetaData::Keywordlist & kwl, const std::string & prefix = "") const;
 
  static BurstRecord FromKeywordlist(const MetaData::Keywordlist & kwl, const std::string & prefix = "");
};
 
 
struct OTBMetadata_EXPORT GCPTime
{
 
  MetaData::TimePoint azimuthTime;
 
  double slantRangeTime;
 
  void ToKeywordlist(MetaData::Keywordlist & kwl, const std::string & prefix = "") const;
};
 
struct CoordinateConversionRecord
{
  MetaData::TimePoint azimuthTime;
  double rg0;
  std::vector<double> coeffs;
 
  void ToKeywordlist(MetaData::Keywordlist & kwl, const std::string & prefix = "") const;
 
  static CoordinateConversionRecord FromKeywordlist(const MetaData::Keywordlist & kwl, const std::string & prefix = "");
};
 
struct InfoSceneCoord
{
 
  unsigned long referenceRow;
 
  unsigned long referenceColumn;
 
  double latitude;
 
  double longitude;
 
  MetaData::TimePoint azimuthTime;
 
  double rangeTime;
 
  double incidenceAngle;
 
  void ToKeywordlist(MetaData::Keywordlist & kwl, const std::string & prefix = "") const;
 
  static InfoSceneCoord FromKeywordlist(const MetaData::Keywordlist & kwl, const std::string & prefix = "");
};
 
struct OTBMetadata_EXPORT SARParam
{ 
 
  std::vector<AzimuthFmRate> azimuthFmRates;
 
  MetaData::Duration azimuthTimeInterval;
  double nearRangeTime;
  double rangeSamplingRate;
  double rangeResolution;
 
  unsigned long numberOfLinesPerBurst;
  unsigned long numberOfSamplesPerBurst;
 
  double azimuthBandwidth = 0.;
  double rangeBandwidth = 0.;
  double azimuthSteeringRate = 0.;
 
  bool rightLookingFlag = true;
 
  std::vector<DopplerCentroid> dopplerCentroids;
 
  std::vector<Orbit> orbits;
 
  std::vector<BurstRecord> burstRecords;
 
  std::unordered_map<std::string, GCPTime> gcpTimes;
 
  std::vector<CoordinateConversionRecord> slantRangeToGroundRangeRecords;
 
  std::vector<CoordinateConversionRecord> groundRangeToSlantRangeRecords;
 
  InfoSceneCoord centerSceneCoord;
  InfoSceneCoord ulSceneCoord;
  InfoSceneCoord urSceneCoord;
  InfoSceneCoord lrSceneCoord;
  InfoSceneCoord llSceneCoord;
 
  void ToKeywordlist(MetaData::Keywordlist & kwl, const std::string & prefix) const;
 
  void FromKeywordlist(const MetaData::Keywordlist & kwl, const std::string & prefix);
 
  // Equality comparison operator (hidden friend idiom)
  friend bool operator==(const SARParam & lhs, const SARParam & rhs)
  {
    MetaData::Keywordlist lhs_kwl;
    lhs.ToKeywordlist(lhs_kwl, "");
    MetaData::Keywordlist rhs_kwl;
    rhs.ToKeywordlist(rhs_kwl, "");
    return lhs_kwl == rhs_kwl;
  }
};
 
struct OTBMetadata_EXPORT SARCalib
{
  using PointSetType   = itk::PointSet<double, 2>;
  using ArrayType      = std::array<int, 2>;
 
  bool calibrationLookupFlag = false;
  double rescalingFactor;
  MetaData::TimePoint calibrationStartTime;
  MetaData::TimePoint calibrationStopTime;
  ArrayType radiometricCalibrationNoisePolynomialDegree;
  ArrayType radiometricCalibrationAntennaPatternNewGainPolynomialDegree;
  ArrayType radiometricCalibrationAntennaPatternOldGainPolynomialDegree;
  ArrayType radiometricCalibrationIncidenceAnglePolynomialDegree;
  ArrayType radiometricCalibrationRangeSpreadLossPolynomialDegree;
  PointSetType::Pointer radiometricCalibrationNoise = PointSetType::New();
  PointSetType::Pointer radiometricCalibrationAntennaPatternNewGain = PointSetType::New();
  PointSetType::Pointer radiometricCalibrationAntennaPatternOldGain = PointSetType::New();
  PointSetType::Pointer radiometricCalibrationIncidenceAngle = PointSetType::New();
  PointSetType::Pointer radiometricCalibrationRangeSpreadLoss = PointSetType::New();
  std::unordered_map<short, SarCalibrationLookupData::Pointer> calibrationLookupData;
 
  void ToKeywordlist(MetaData::Keywordlist & kwl, const std::string & prefix) const;
 
  void FromKeywordlist(const MetaData::Keywordlist & kwl, const std::string & prefix);
};
 
} // end namespace otb
 
#endif