Albedo.cpp

 
/* SPDX-License-Identifier: CC0-1.0 */
 
#include "Albedo.h"
#include "SpecialPixel.h"
#include "IException.h"
#include "IString.h"
#include "NormModel.h"
 
namespace Isis {
  Albedo::Albedo(Pvl &pvl, PhotoModel &pmodel) : NormModel(pvl, pmodel) {
    PvlGroup &algorithm = pvl.findObject("NormalizationModel").findGroup("Algorithm", Pvl::Traverse);
 
    SetNormPharef(0.0);
    SetNormIncref(0.0);
    SetNormEmaref(0.0);
    SetNormIncmat(0.0);
    SetNormThresh(30.0);
    SetNormAlbedo(1.0);
 
    // Get value from user
    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("Incmat")) {
      SetNormIncmat(algorithm["Incmat"]);
    }
 
    if(algorithm.hasKeyword("Thresh")) {
      SetNormThresh(algorithm["Thresh"]);
    }
 
    if(algorithm.hasKeyword("Albedo")) {
      SetNormAlbedo(algorithm["Albedo"]);
    }
 
    // Calculate normalization at standard conditions.
    GetPhotoModel()->SetStandardConditions(true);
    p_normPsurfref = GetPhotoModel()->CalcSurfAlbedo(p_normPharef, p_normIncref, p_normEmaref);
    GetPhotoModel()->SetStandardConditions(false);
  }
 

  void Albedo::NormModelAlgorithm(double phase, double incidence,
                                  double emission, double demincidence, double dememission,
                                  double dn, double &albedo, double &mult, double &base) {
    double psurf;
    double result;
 
    // code for scaling each pixel
    psurf = GetPhotoModel()->CalcSurfAlbedo(phase, demincidence, dememission);
 
    // thresh is a parameter limiting how much we amplify the dns
    if(p_normPsurfref > psurf * p_normThresh) {
      result = NULL8;
      albedo = NULL8;
      mult = 0.0;
      base = 0.0;
    }
    else {
      if(psurf == 0.0) {
        QString msg = "Albedo math divide by zero error";
        throw IException(IException::Unknown, msg, _FILEINFO_);
      }
      else {
        result = dn * p_normPsurfref / psurf;
        albedo = result;
        mult = p_normPsurfref / psurf;
        base = 0.0;
      }
    }
  }
 
  
  void Albedo::SetNormPharef(const double pharef) {
    if(pharef < 0.0 || pharef >= 180.0) {
      QString msg = "Invalid value of normalization pharef [" +
                        toString(pharef) + "]";
      throw IException(IException::User, msg, _FILEINFO_);
    }
    p_normPharef = pharef;
  }

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

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

  void Albedo::SetNormIncmat(const double incmat) {
    if(incmat < 0.0 || incmat >= 90.0) {
      QString msg = "Invalid value of normalization incmat [" +
                        toString(incmat) + "]";
      throw IException(IException::User, msg, _FILEINFO_);
    }
    p_normIncmat = incmat;
  }

  void Albedo::SetNormAlbedo(const double albedo) {
    p_normAlbedo = albedo;
  }

  void Albedo::SetNormThresh(const double thresh) {
    p_normThresh = thresh;
  }
}
 
extern "C" Isis::NormModel *AlbedoPlugin(Isis::Pvl &pvl, Isis::PhotoModel &pmodel) {
  return new Isis::Albedo(pvl, pmodel);
}