CsmBundleObservation.cpp

 
/* SPDX-License-Identifier: CC0-1.0 */
 
#include "CsmBundleObservation.h"
 
#include <QDebug>
#include <QString>
#include <QStringList>
#include <QVector>
 
#include "BundleImage.h"
#include "BundleControlPoint.h"
#include "BundleObservationSolveSettings.h"
#include "BundleTargetBody.h"
#include "Camera.h"
#include "CSMCamera.h"
#include "LinearAlgebra.h"
#include "SpicePosition.h"
#include "SpiceRotation.h"
 
using namespace std;
 
namespace Isis {
 
  CsmBundleObservation::CsmBundleObservation() {
  }
 
 
  CsmBundleObservation::CsmBundleObservation(BundleImageQsp image, QString observationNumber,
                                       QString instrumentId, BundleTargetBodyQsp bundleTargetBody) : BundleObservation(image, observationNumber, instrumentId, bundleTargetBody) {
    if (bundleTargetBody) {
      QString msg = "Target body parameters cannot be solved for with CSM observations.";
      throw IException(IException::User, msg, _FILEINFO_);
    }
  }
 
 
  CsmBundleObservation::CsmBundleObservation(const CsmBundleObservation &src) : BundleObservation(src) {
    m_solveSettings = src.m_solveSettings;
    m_paramIndices = src.m_paramIndices;
  }
 
 
  CsmBundleObservation::~CsmBundleObservation() {
  }
 
 
  CsmBundleObservation &CsmBundleObservation::operator=(const CsmBundleObservation &src) {
    if (&src != this) {
      m_solveSettings = src.m_solveSettings;
      m_paramIndices = src.m_paramIndices;
    }
    return *this;
  }
 
 
  bool CsmBundleObservation::setSolveSettings(BundleObservationSolveSettings solveSettings) {
    m_solveSettings = BundleObservationSolveSettingsQsp(
                        new BundleObservationSolveSettings(solveSettings));
 
    CSMCamera *csmCamera = dynamic_cast<CSMCamera*>(front()->camera());
 
    m_paramIndices.clear();
    m_weights.clear();
    m_corrections.clear();
    m_adjustedSigmas.clear();
 
    if (m_solveSettings->csmSolveOption() == BundleObservationSolveSettings::Set) {
      m_paramIndices = csmCamera->getParameterIndices(m_solveSettings->csmParameterSet());
    }
    else if (m_solveSettings->csmSolveOption() == BundleObservationSolveSettings::Type) {
      m_paramIndices = csmCamera->getParameterIndices(m_solveSettings->csmParameterType());
    }
    else if (m_solveSettings->csmSolveOption() == BundleObservationSolveSettings::List) {
      m_paramIndices = csmCamera->getParameterIndices(m_solveSettings->csmParameterList());
    }
    else {
      return false;
    }
 
    int nParams = m_paramIndices.size();
 
    m_weights.resize(nParams);
    m_corrections.resize(nParams);
    m_adjustedSigmas.resize(nParams);
    m_aprioriSigmas.resize(nParams);
 
    for (int i = 0; i < nParams; i++) {
      m_aprioriSigmas[i] = csmCamera->getParameterCovariance(m_paramIndices[i], m_paramIndices[i]);
    }
 
    return true;
  }
 
 
  const BundleObservationSolveSettingsQsp CsmBundleObservation::solveSettings() {
    return BundleObservationSolveSettingsQsp(nullptr);
  }
 
 
  bool CsmBundleObservation::applyParameterCorrections(LinearAlgebra::Vector corrections) {
    // Check that the correction vector is the correct size
    if (corrections.size() != m_paramIndices.size()) {
      QString msg = "Invalid correction vector passed to observation.";
      IException(IException::Programmer, msg, _FILEINFO_);
    }
 
    // Apply the corrections to the CSM camera
    CSMCamera *csmCamera = dynamic_cast<CSMCamera*>(front()->camera());
    for (size_t i = 0; i < corrections.size(); i++) {
      csmCamera->applyParameterCorrection(m_paramIndices[i], corrections[i]);
    }
 
    // Accumulate the total corrections
    m_corrections += corrections;
 
    return true;
  }
 
 
  int CsmBundleObservation::numberParameters() {
    return m_paramIndices.size();
  }
 
 
  void CsmBundleObservation::bundleOutputString(std::ostream &fpOut, bool errorPropagation) {
 
    char buf[4096];
 
    QVector<double> finalParameterValues;
    CSMCamera *csmCamera = dynamic_cast<CSMCamera*>(front()->camera());
 
    int nParameters = numberParameters();
 
    QStringList parameterNamesList;
    QStringList parameterUnitList;
 
    for (int i = 0; i < nParameters; i++) {
      parameterNamesList.append(csmCamera->getParameterName(m_paramIndices[i]));
      parameterUnitList.append(csmCamera->getParameterUnits(m_paramIndices[i]));
      finalParameterValues.append(csmCamera->getParameterValue(m_paramIndices[i]));
    }
 
 
    // Set up default values when we are using default position
    QString sigma;
    QString adjustedSigma;
    double correction;
 
    for (int i = 0; i < nParameters; i++) {
 
      correction = m_corrections(i);
      adjustedSigma = QString::number(m_adjustedSigmas[i], 'f', 8);
      sigma = (IsSpecial(m_aprioriSigmas[i]) ? "FREE" : toString(m_aprioriSigmas[i], 8));
 
      sprintf(buf,"%.11s", parameterNamesList.at(i).toStdString().c_str());
      fpOut << buf;
      sprintf(buf,"%18.8lf  ", finalParameterValues[i] - correction);
      fpOut << buf;
      sprintf(buf,"%20.8lf  ", correction);
      fpOut << buf;
      sprintf(buf,"%23.8lf  ", finalParameterValues[i]);
      fpOut << buf;
      sprintf(buf,"            ");
      fpOut << buf;
      sprintf(buf,"%6s", sigma.toStdString().c_str());
      fpOut << buf;
      sprintf(buf,"            ");
      fpOut << buf;
      if (errorPropagation) {
        sprintf(buf,"%s", adjustedSigma.toStdString().c_str());
      }
      else {
        sprintf(buf, "%s","N/A");
      }
      fpOut << buf;
      sprintf(buf,"        ");
      fpOut << buf;
      sprintf(buf,"%s\n", parameterUnitList.at(i).toStdString().c_str());
      fpOut << buf;
 
    }
  }
 
  QString CsmBundleObservation::bundleOutputCSV(bool errorPropagation) {
    QString finalqStr = "";
    CSMCamera *csmCamera = dynamic_cast<CSMCamera*>(front()->camera());
 
    for (size_t i = 0; i < m_paramIndices.size(); i++) {
      double finalValue = csmCamera->getParameterValue(m_paramIndices[i]);
      finalqStr += toString(finalValue - m_corrections[i]) + ",";
      finalqStr += toString(m_corrections[i]) + ",";
      finalqStr += toString(finalValue) + ",";
      finalqStr += toString(m_aprioriSigmas[i], 8) + ",";
      if (errorPropagation) {
        finalqStr += QString::number(m_adjustedSigmas[i], 'f', 8) + ",";
      }
      else {
        finalqStr += "N/A,";
      }
    }
 
    return finalqStr;
  }
 
 
  QStringList CsmBundleObservation::parameterList() {
    QStringList paramList;
    CSMCamera *csmCamera = dynamic_cast<CSMCamera*>(front()->camera());
 
    for (int paramIndex : m_paramIndices) {
      paramList.push_back(csmCamera->getParameterName(paramIndex));
    }
 
    return paramList;
  }
 
  bool CsmBundleObservation::computeTargetPartials(LinearAlgebra::Matrix &coeffTarget, BundleMeasure &measure, BundleSettingsQsp &bundleSettings, BundleTargetBodyQsp &bundleTargetBody) {
    if (bundleTargetBody) {
      QString msg = "Target body parameters cannot be solved for with CSM observations.";
      throw IException(IException::User, msg, _FILEINFO_);
    }
    return false;
  }
 
 
  bool CsmBundleObservation::computeImagePartials(LinearAlgebra::Matrix &coeffImage, BundleMeasure &measure) {
    coeffImage.clear();
 
    CSMCamera *csmCamera = dynamic_cast<CSMCamera*>(measure.camera());
    SurfacePoint groundPoint = measure.parentControlPoint()->adjustedSurfacePoint();
 
    // Loop over parameters and populate matrix
    for (size_t i = 0; i < m_paramIndices.size(); i++) {
      vector<double> partials = csmCamera->getSensorPartials(m_paramIndices[i], groundPoint);
      coeffImage(0, i) = partials[1];
      coeffImage(1, i) = partials[0];
    }
 
    return true;
  }
 
 
  bool CsmBundleObservation::computePoint3DPartials(LinearAlgebra::Matrix &coeffPoint3D, BundleMeasure &measure, SurfacePoint::CoordinateType coordType) {
    coeffPoint3D.clear();
 
    CSMCamera *measureCamera = dynamic_cast<CSMCamera*>(measure.camera());
 
    // do ground partials
    SurfacePoint groundPoint = measure.parentControlPoint()->adjustedSurfacePoint();
    vector<double> groundPartials = measureCamera->GroundPartials(groundPoint);
 
    if (coordType == SurfacePoint::Rectangular) {
      // groundPartials is:
      // line WRT x
      // line WRT y
      // line WRT z
      // sample WRT x
      // sample WRT y
      // sample WRT z
      // Scale from WRT m to WRT Km
      coeffPoint3D(1,0) = groundPartials[0] * 1000;
      coeffPoint3D(1,1) = groundPartials[1] * 1000;
      coeffPoint3D(1,2) = groundPartials[2] * 1000;
      coeffPoint3D(0,0) = groundPartials[3] * 1000;
      coeffPoint3D(0,1) = groundPartials[4] * 1000;
      coeffPoint3D(0,2) = groundPartials[5] * 1000;
    }
    else if (coordType == SurfacePoint::Latitudinal) {
      std::vector<double> latDerivative = groundPoint.LatitudinalDerivative(SurfacePoint::One);
      std::vector<double> lonDerivative = groundPoint.LatitudinalDerivative(SurfacePoint::Two);
      std::vector<double> radDerivative = groundPoint.LatitudinalDerivative(SurfacePoint::Three);
 
      // Line w.r.t (lat, lon, radius)
      coeffPoint3D(1,0) = 1000 * (groundPartials[0]*latDerivative[0] + groundPartials[1]*latDerivative[1] + groundPartials[2]*latDerivative[2]);
      coeffPoint3D(1,1) = 1000 * (groundPartials[0]*lonDerivative[0] + groundPartials[1]*lonDerivative[1] + groundPartials[2]*lonDerivative[2]);
      coeffPoint3D(1,2) = 1000 * (groundPartials[0]*radDerivative[0] + groundPartials[1]*radDerivative[1] + groundPartials[2]*radDerivative[2]);
 
      // Sample w.r.t (lat, lon, radius)
      coeffPoint3D(0,0) = 1000 * (groundPartials[3]*latDerivative[0] + groundPartials[4]*latDerivative[1] + groundPartials[5]*latDerivative[2]);
      coeffPoint3D(0,1) = 1000 * (groundPartials[3]*lonDerivative[0] + groundPartials[4]*lonDerivative[1] + groundPartials[5]*lonDerivative[2]);
      coeffPoint3D(0,2) = 1000 * (groundPartials[3]*radDerivative[0] + groundPartials[4]*radDerivative[1] + groundPartials[5]*radDerivative[2]);
    }
    else {
      IString msg ="Unknown surface point coordinate type enum [" + toString(coordType) + "]." ;
      throw IException(IException::Programmer, msg, _FILEINFO_);
    }
    return true;
  }
 
 
  bool CsmBundleObservation::computeRHSPartials(LinearAlgebra::Vector &coeffRHS, BundleMeasure &measure) {
    // Clear old values
    coeffRHS.clear();
 
    Camera *measureCamera = measure.camera();
    BundleControlPoint* point = measure.parentControlPoint();
 
    // Get ground-to-image computed coordinates for this point.
    if (!(measureCamera->SetGround(point->adjustedSurfacePoint()))) {
      QString msg = "Unable to map apriori surface point for measure ";
      msg += measure.cubeSerialNumber() + " on point " + point->id() + " back into image.";
      throw IException(IException::User, msg, _FILEINFO_);
    }
    double computedSample = measureCamera->Sample();
    double computedLine = measureCamera->Line();
 
    // The RHS is the difference between the measured coordinates on the image
    // and the coordinates calculated by the ground to image call.
    double deltaSample = measure.sample() - computedSample;
    double deltaLine = measure.line() - computedLine;
 
    coeffRHS(0) = deltaSample;
    coeffRHS(1) = deltaLine;
 
    return true;
  }
 
 
  double CsmBundleObservation::computeObservationValue(BundleMeasure &measure, double deltaVal) {
    return deltaVal;
  }
}