TopoAtm.cpp

 
/* SPDX-License-Identifier: CC0-1.0 */
#include <cmath>
#include "TopoAtm.h"
#include "NumericalApproximation.h"
#include "IException.h"
 
namespace Isis {
  /*
   * @history 2008-11-05 Jeannie Walldren - Modified references to
   *          NumericalMethods class and replaced Isis::PI with PI
   *          since this is in Isis namespace.
   */
  TopoAtm::TopoAtm(Pvl &pvl, PhotoModel &pmodel, AtmosModel &amodel) : NormModel(pvl, pmodel, amodel) {
    double psurf0;
    double psurfref;
    double pprimeref;
    double ahref;
    double munotref;
    double pstdref;
    double transref;
    double trans0ref;
    double transs;
    double sbar;
 
    PvlGroup &algorithm = pvl.findObject("NormalizationModel").findGroup("Algorithm", Pvl::Traverse);
 
    SetNormPharef(0.0);
    SetNormIncref(0.0);
    SetNormEmaref(0.0);
    SetNormAlbedo(1.0);
 
    if(algorithm.hasKeyword("Incref")) {
      SetNormIncref(algorithm["Incref"]);
    }
 
    if(algorithm.hasKeyword("Pharef")) {
      SetNormPharef(algorithm["Pharef"]);
    }
    else {
      p_normPharef = p_normIncref;
    }
 
    if(algorithm.hasKeyword("Emaref")) {
      SetNormEmaref(algorithm["Emaref"]);
    }
 
    if(algorithm.hasKeyword("Albedo")) {
      SetNormAlbedo(algorithm["Albedo"]);
    }
 
    // First-time setup:
    // Calculate normalization at standard conditions
    GetPhotoModel()->SetStandardConditions(true);
    psurf0 = GetPhotoModel()->CalcSurfAlbedo(0.0, 0.0, 0.0);
 
    if(psurf0 == 0.0) {
      std::string msg = "Divide by zero encountered";
      throw IException(IException::Unknown, msg, _FILEINFO_);
    }
    else {
      p_normRhobar = p_normAlbedo / psurf0;
    }
 
    psurfref = GetPhotoModel()->CalcSurfAlbedo(p_normPharef, p_normIncref, p_normEmaref);
    pprimeref = GetPhotoModel()->PhtTopder(p_normPharef, p_normIncref, p_normEmaref);
    GetPhotoModel()->SetStandardConditions(false);
 
    //  Get reference hemispheric albedo (p_photoB0 doesn't influence it much)
    GetAtmosModel()->GenerateAhTable();
 
    ahref = (GetAtmosModel()->AtmosAhSpline()).Evaluate(p_normIncref, NumericalApproximation::Extrapolate);
 
    munotref = cos((PI / 180.0) * p_normIncref);
 
    // Now calculate atmosphere at standard conditions
    GetAtmosModel()->SetStandardConditions(true);
    GetAtmosModel()->CalcAtmEffect(p_normPharef, p_normIncref, p_normEmaref, &pstdref, &transref,
                                   &trans0ref, &sbar, &transs);
    GetAtmosModel()->SetStandardConditions(false);
 
    // Finally, calculate the additive and multiplicative parts of the
    // output-normalized signal, from the point of view of fixed albedo
    // and varying topography
    p_normAout = p_normRhobar * pprimeref * trans0ref;
    p_normBout = pstdref + p_normRhobar * (transref * ahref * munotref /
                                           (1.0 - p_normRhobar * GetAtmosModel()->AtmosAb() * sbar) + trans0ref *
                                           (psurfref - ahref * munotref));
  }
 
  /*
   *@history 2008-11-05 Jeannie Walldren - Modified references to
   *          NumericalMethods class and replaced Isis::PI with PI
   *          since this is in Isis namespace.
   */
  void TopoAtm::NormModelAlgorithm(double phase, double incidence, double emission,
                                   double demincidence, double dememission, double dn,
                                   double &albedo, double &mult, double &base) {
    double eps = 0.1;
    static double psurf;
    static double pprime;
    static double ahInterp;
    static double munot;
    double pstd;
    double trans;
    double trans0;
    double transs;
    double sbar;
    double rhotlt;
    double dpo;
    double q;
    double slope;
    double pprimeeff;
    double ptilt;
    double dpm;
    double pflat;
    double rhoflat;
 
    static double old_phase = -9999;
    static double old_incidence = -9999;
    static double old_emission = -9999;
    static double old_demincidence = -9999;
    static double old_dememission = -9999;
 
    if (old_phase != phase || old_incidence != incidence || old_emission != emission ||
        old_demincidence != demincidence || old_dememission != dememission) {
 
      psurf = GetPhotoModel()->CalcSurfAlbedo(phase, demincidence, dememission);
      pprime = GetPhotoModel()->PhtTopder(phase, demincidence, dememission);
      ahInterp = (GetAtmosModel()->AtmosAhSpline()).Evaluate(incidence, NumericalApproximation::Extrapolate);
 
      munot = cos(incidence * (PI / 180.0));
 
      old_phase = phase;
      old_incidence = incidence;
      old_emission = emission;
      old_demincidence = demincidence;
      old_dememission = dememission;
    }
 
    GetAtmosModel()->CalcAtmEffect(phase, incidence, emission, &pstd, &trans, &trans0, &sbar,
                                   &transs);
    pflat = pstd + p_normRhobar * (trans * ahInterp * munot /
                                   (1.0 - p_normRhobar * GetAtmosModel()->AtmosAb() * sbar) + trans0 * (psurf -
                                       ahInterp * munot));
    ptilt = pflat + p_normRhobar * pprime * trans0 * eps;
    dpo = ptilt - pstd;
    dpm = (psurf - ahInterp * munot) * trans0;
    q = ahInterp * munot * trans + GetAtmosModel()->AtmosAb() * sbar * dpo + dpm;
    rhotlt = 2.0 * dpo / (q + sqrt(pow(q, 2.0) - 4.0 * GetAtmosModel()->AtmosAb() * sbar * dpo * dpm));
    dpo = pflat - pstd;
    q = ahInterp * munot * trans + GetAtmosModel()->AtmosAb() * sbar * dpo + dpm;
    rhoflat = 2.0 * dpo / (q + sqrt(pow(q, 2.0) - 4.0 * GetAtmosModel()->AtmosAb() * sbar * dpo * dpm));
    pprimeeff = (rhotlt - rhoflat) / (rhoflat * eps);
    slope = (dn - 1.0) / pprimeeff;
    albedo = p_normAout * slope + p_normBout;
  }

  void TopoAtm::SetNormPharef(const double pharef) {
    if(pharef < 0.0 || pharef >= 180.0) {
      std::string msg = "Invalid value of normalization pharef [" + IString(pharef) + "]";
      throw IException(IException::User, msg, _FILEINFO_);
    }
 
    p_normPharef = pharef;
  }

  void TopoAtm::SetNormIncref(const double incref) {
    if(incref < 0.0 || incref >= 90.0) {
      std::string msg = "Invalid value of normalization incref [" + IString(incref) + "]";
      throw IException(IException::User, msg, _FILEINFO_);
    }
 
    p_normIncref = incref;
  }

  void TopoAtm::SetNormEmaref(const double emaref) {
    if(emaref < 0.0 || emaref >= 90.0) {
      std::string msg = "Invalid value of normalization emaref [" + IString(emaref) + "]";
      throw IException(IException::User, msg, _FILEINFO_);
    }
 
    p_normEmaref = emaref;
  }

  void TopoAtm::SetNormAlbedo(const double albedo) {
    p_normAlbedo = albedo;
  }
}
 
extern "C" Isis::NormModel *TopoAtmPlugin(Isis::Pvl &pvl, Isis::PhotoModel &pmodel, Isis::AtmosModel &amodel) {
  return new Isis::TopoAtm(pvl, pmodel, amodel);
}