Unverified Commit 6b4a3b8d authored by acpaquette's avatar acpaquette Committed by GitHub
Browse files

Shadow App and Test Update (#4118) 

* Add dn populated dem fixture

* Convert the shapow app into the new app format

* Translate the base and multiplier from a label

* Add dem cube and updated tests

* Removed old shadow tests

* Fixed demCube fixed label loading

* Updated shadow tests and demCube fixture
parent 98c09e28

isis/src/base/apps/shadow/main.cpp

+12 −160
Original line number Diff line number Diff line 
#include "Isis.h"



#include <SpiceUsr.h>

#include "shadow.h"



#include "Application.h"

#include "Distance.h"

#include "iTime.h"

#include "KernelDb.h"

#include "NaifStatus.h"

#include "ProcessByBrick.h"

#include "ShadowFunctor.h"

#include "SpicePosition.h"

#include "UserInterface.h"

#include "Pvl.h"



using namespace std;

using namespace Isis;





QStringList kernels(QString kernelType, Kernel (KernelDb::*kernelDbAccessor)(Pvl &), Pvl &labels);



void IsisMain() {

  UserInterface &ui = Application::GetUserInterface();



  ProcessByBrick p;

  Cube *demCube = p.SetInputCube("FROM");

  p.SetBrickSize(demCube->sampleCount(), 128, 1);



  ShadowFunctor functor(demCube);



  PvlKeyword kernelsUsed("Kernels");

  kernelsUsed.addCommentWrapped("These NAIF kernels were furnished in order to compute the "

                                "position of the sun relative to the DEM's target body, in the "

                                "target body's reference frame. For more information, please see "

                                "http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/"

                                "spkpos_c.html");



  if (ui.GetString("SUNPOSITIONSOURCE") == "MATCH") {

    functor.setSunPosition(ui.GetFileName("MATCH"));

  }

  else {

    QStringList allKernelFiles;



    allKernelFiles.append(kernels("PCK", &KernelDb::targetAttitudeShape, *demCube->label()));

    allKernelFiles.append(kernels("SPK", &KernelDb::targetPosition, *demCube->label()));



    NaifStatus::CheckErrors();



    foreach (QString kernelFile, allKernelFiles) {

      kernelsUsed += kernelFile;

      furnsh_c(FileName(kernelFile).expanded().toLatin1().data());

    }



    // Find the NAIF target code for the DEM's target

    QString name = demCube->label()->findGroup("Mapping", Pvl::Traverse)["TargetName"];

    SpiceDouble sunPosition[3];

    SpiceDouble lightTime;



    NaifStatus::CheckErrors();

    iTime time(ui.GetString("TIME"));



    // Get actual sun position, relative to target

    QString bodyFixedFrame = QString("IAU_%1").arg(name.toUpper());

    spkpos_c("SUN", time.Et(), bodyFixedFrame.toLatin1().data(), "NONE",

             name.toUpper().toLatin1().data(), sunPosition, &lightTime);



    NaifStatus::CheckErrors();



    // Adjusted for light time

    spkpos_c("SUN", time.Et() - lightTime, bodyFixedFrame.toLatin1().data(), "NONE",

             name.toUpper().toLatin1().data(), sunPosition, &lightTime);



    NaifStatus::CheckErrors();



    // Convert sun position units: KM -> M

    sunPosition[0] *= 1000;

    sunPosition[1] *= 1000;

    sunPosition[2] *= 1000;



    foreach (QString kernelFile, allKernelFiles) {

      unload_c(FileName(kernelFile).expanded().toLatin1().data());

    }



    NaifStatus::CheckErrors();

    functor.setSunPosition(sunPosition);

  }



  functor.enableShadowTraceToSunEdge(ui.GetBoolean("SUNEDGE"),

                                     Distance(ui.GetDouble("SOLARRADIUS"), Distance::SolarRadii));



  QString preset = ui.GetString("PRESET");



  if (preset == "NOSHADOW") {

    functor.enableShadowCalculations(false);

  Pvl appLog;

  try {

    shadow(ui, &appLog);

  }

  if (preset == "BALANCED") {

    functor.setQuickSettings(ShadowFunctor::BalancedPerformance);

  catch (...) {

    for (auto grpIt = appLog.beginGroup(); grpIt!= appLog.endGroup(); grpIt++) {

      Application::Log(*grpIt);

    }

  else if (preset == "ACCURATE") {

    functor.setQuickSettings(ShadowFunctor::HighAccuracy);

    throw;

  }

  else {

    functor.setRayPrecision(ui.GetDouble("PRECISION"));



    functor.enableInterpolatedOptimizations(ui.GetBoolean("CACHEINTERPOLATEDVALUES"));

    functor.enableShadowMap(ui.GetBoolean("SHADOWMAP"), ui.GetInteger("BASESHADOWCACHESIZE"));

    functor.enableLightCurtain(ui.GetBoolean("LIGHTCURTAIN"),

                               ui.GetBoolean("LOWERLIGHTCURTAIN"),

                               ui.GetInteger("BASELIGHTCACHESIZE"));

    functor.enableWalkingOverShadows(ui.GetBoolean("SKIPOVERSHADOW"),

                                     ui.GetInteger("MAXSKIPOVERSHADOWSTEPS"));

  for (auto grpIt = appLog.beginGroup(); grpIt!= appLog.endGroup(); grpIt++) {

    Application::Log(*grpIt);

  }



  Cube *outputCube = p.SetOutputCube("TO");



  p.ProcessCube(functor, false);



  PvlGroup functorLogData = functor.report();



  if (kernelsUsed.size()) {

    functorLogData += kernelsUsed;

  }



  Application::Log(functorLogData);



  // Look for shape model object and remove it from output

  Pvl &outputCubeLabel = *outputCube->label();

  for (int objectIndex = 0; objectIndex < outputCubeLabel.objects(); objectIndex++) {

    PvlObject &object = outputCubeLabel.object(objectIndex);



    if (object.isNamed("Table") && object.hasKeyword("Name") &&

        object["Name"][0] == "ShapeModelStatistics") {

      outputCubeLabel.deleteObject(objectIndex);

    }

  }

}





/**

 * Get the NAIF kernels of a particular type that need to be furnished (PCK or SPK).

 *

 * @param kernelType "PCK" or "SPK"

 * @param kernelDbAccessor The method on KernelDb to call in order to get the correct kernels

 * @param labels The labels to use for matching in the kernels.????.db files

 *

 * @return Kernel file names

 */

QStringList kernels(QString kernelType, Kernel (KernelDb::*kernelDbAccessor)(Pvl &), Pvl &labels) {

  QStringList results;



  UserInterface &ui = Application::GetUserInterface();

  if (ui.WasEntered(kernelType.toUpper().toLatin1().data())) {

    std::vector<QString> userInput;



    ui.GetAsString(kernelType.toUpper().toLatin1().data(), userInput);



    for (int i = 0; i < (int)userInput.size(); i++) {

      results.append(userInput[i]);

    }

  }

  else {

    QString kernelDbFile = QString("$base/kernels/%1/kernels.????.db").arg(kernelType.toLower());



    int allowed = Kernel::typeEnum("PREDICTED") |

                  Kernel::typeEnum("RECONSTRUCTED") |

                  Kernel::typeEnum("SMITHED");

    KernelDb kernelDb(FileName(kernelDbFile).highestVersion().expanded(), allowed);



    Kernel detectedKernels = (kernelDb.*kernelDbAccessor)(labels);



    for (int i = 0; i < detectedKernels.size(); i++) {

      results.append(detectedKernels[i]);

    }

  }



  return results;

}

isis/src/base/apps/shadow/shadow.cpp

0 → 100644
+189 −0
Original line number Diff line number Diff line 
#include "shadow.h"



#include <SpiceUsr.h>



#include "Application.h"

#include "Distance.h"

#include "iTime.h"

#include "KernelDb.h"

#include "NaifStatus.h"

#include "ProcessByBrick.h"

#include "ShadowFunctor.h"

#include "SpicePosition.h"



namespace Isis {

  QStringList kernels(QString kernelType,

                      Kernel (KernelDb::*kernelDbAccessor)(Pvl &),

                      Pvl &labels,

                      UserInterface &ui);



  void shadow(UserInterface &ui, Pvl *log) {

    Cube *demCube = new Cube(ui.GetFileName("FROM"));



    shadow(demCube, ui, log);

  }



  void shadow(Cube *demCube, UserInterface &ui, Pvl *log) {

    ProcessByBrick p;

    p.SetInputCube(demCube);

    p.SetBrickSize(demCube->sampleCount(), 128, 1);



    ShadowFunctor functor(demCube);



    PvlKeyword kernelsUsed("Kernels");

    kernelsUsed.addCommentWrapped("These NAIF kernels were furnished in order to compute the "

                                  "position of the sun relative to the DEM's target body, in the "

                                  "target body's reference frame. For more information, please see "

                                  "http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/"

                                  "spkpos_c.html");



    if (ui.GetString("SUNPOSITIONSOURCE") == "MATCH") {

      functor.setSunPosition(ui.GetFileName("MATCH"));

    }

    else {

      QStringList allKernelFiles;



      allKernelFiles.append(kernels("PCK", &KernelDb::targetAttitudeShape, *demCube->label(), ui));

      allKernelFiles.append(kernels("SPK", &KernelDb::targetPosition, *demCube->label(), ui));



      NaifStatus::CheckErrors();



      foreach (QString kernelFile, allKernelFiles) {

        kernelsUsed += kernelFile;

        furnsh_c(FileName(kernelFile).expanded().toLatin1().data());

      }



      // Find the NAIF target code for the DEM's target

      QString name = demCube->label()->findGroup("Mapping", Pvl::Traverse)["TargetName"];

      SpiceDouble sunPosition[3];

      SpiceDouble lightTime;



      NaifStatus::CheckErrors();

      iTime time(ui.GetString("TIME"));



      // Get actual sun position, relative to target

      QString bodyFixedFrame = QString("IAU_%1").arg(name.toUpper());

      spkpos_c("SUN", time.Et(), bodyFixedFrame.toLatin1().data(), "NONE",

               name.toUpper().toLatin1().data(), sunPosition, &lightTime);



      NaifStatus::CheckErrors();



      // Adjusted for light time

      spkpos_c("SUN", time.Et() - lightTime, bodyFixedFrame.toLatin1().data(), "NONE",

               name.toUpper().toLatin1().data(), sunPosition, &lightTime);



      NaifStatus::CheckErrors();





      // Convert sun position units: KM -> M

      sunPosition[0] *= 1000;

      sunPosition[1] *= 1000;

      sunPosition[2] *= 1000;



      foreach (QString kernelFile, allKernelFiles) {

        unload_c(FileName(kernelFile).expanded().toLatin1().data());

      }



      NaifStatus::CheckErrors();

      functor.setSunPosition(sunPosition);

    }



    functor.enableShadowTraceToSunEdge(ui.GetBoolean("SUNEDGE"),

                                       Distance(ui.GetDouble("SOLARRADIUS"), Distance::SolarRadii));



    QString preset = ui.GetString("PRESET");



    if (preset == "NOSHADOW") {

      functor.enableShadowCalculations(false);

    }

    if (preset == "BALANCED") {

      functor.setQuickSettings(ShadowFunctor::BalancedPerformance);

    }

    else if (preset == "ACCURATE") {

      functor.setQuickSettings(ShadowFunctor::HighAccuracy);

    }

    else {

      functor.setRayPrecision(ui.GetDouble("PRECISION"));



      functor.enableInterpolatedOptimizations(ui.GetBoolean("CACHEINTERPOLATEDVALUES"));

      functor.enableShadowMap(ui.GetBoolean("SHADOWMAP"), ui.GetInteger("BASESHADOWCACHESIZE"));

      functor.enableLightCurtain(ui.GetBoolean("LIGHTCURTAIN"),

                                 ui.GetBoolean("LOWERLIGHTCURTAIN"),

                                 ui.GetInteger("BASELIGHTCACHESIZE"));

      functor.enableWalkingOverShadows(ui.GetBoolean("SKIPOVERSHADOW"),

                                       ui.GetInteger("MAXSKIPOVERSHADOWSTEPS"));

    }



    Isis::CubeAttributeOutput &atts = ui.GetOutputAttribute("TO");

    int ns = demCube->sampleCount();

    int nl = demCube->lineCount();

    int nb = demCube->bandCount();

    Cube *outputCube = p.SetOutputCube(ui.GetFileName("TO"), atts, ns, nl, nb);



    p.ProcessCube(functor, false);



    PvlGroup functorLogData = functor.report();



    if (kernelsUsed.size()) {

      functorLogData += kernelsUsed;

    }



    if (log) {

      log->addGroup(functorLogData);

    }



    // Look for shape model object and remove it from output

    Pvl &outputCubeLabel = *outputCube->label();

    for (int objectIndex = 0; objectIndex < outputCubeLabel.objects(); objectIndex++) {

      PvlObject &object = outputCubeLabel.object(objectIndex);



      if (object.isNamed("Table") && object.hasKeyword("Name") &&

          object["Name"][0] == "ShapeModelStatistics") {

        outputCubeLabel.deleteObject(objectIndex);

      }

    }

  }





  /**

   * Get the NAIF kernels of a particular type that need to be furnished (PCK or SPK).

   *

   * @param kernelType "PCK" or "SPK"

   * @param kernelDbAccessor The method on KernelDb to call in order to get the correct kernels

   * @param labels The labels to use for matching in the kernels.????.db files

   *

   * @return Kernel file names

   */

  QStringList kernels(QString kernelType,

                      Kernel (KernelDb::*kernelDbAccessor)(Pvl &),

                      Pvl &labels,

                      UserInterface &ui) {

    QStringList results;



    if (ui.WasEntered(kernelType.toUpper().toLatin1().data())) {

      std::vector<QString> userInput;



      ui.GetAsString(kernelType.toUpper().toLatin1().data(), userInput);



      for (int i = 0; i < (int)userInput.size(); i++) {

        results.append(userInput[i]);

      }

    }

    else {

      QString kernelDbFile = QString("$base/kernels/%1/kernels.????.db").arg(kernelType.toLower());



      int allowed = Kernel::typeEnum("PREDICTED") |

                    Kernel::typeEnum("RECONSTRUCTED") |

                    Kernel::typeEnum("SMITHED");

      KernelDb kernelDb(FileName(kernelDbFile).highestVersion().expanded(), allowed);



      Kernel detectedKernels = (kernelDb.*kernelDbAccessor)(labels);



      for (int i = 0; i < detectedKernels.size(); i++) {

        results.append(detectedKernels[i]);

      }

    }



    return results;

  }

}

isis/src/base/apps/shadow/shadow.h

0 → 100644
+13 −0
Original line number Diff line number Diff line 
#ifndef shadow_h

#define shadow_h



#include "Pvl.h"

#include "UserInterface.h"



namespace Isis{

  extern void shadow(UserInterface &ui, Pvl *log=nullptr);



  extern void shadow(Cube *demCube, UserInterface &ui, Pvl *log=nullptr);

}



#endif

isis/src/base/apps/shadow/tsts/Makefile

deleted100644 → 0
+0 −4
Original line number Diff line number Diff line 
BLANKS = "%-6s"    

LENGTH = "%-40s"



include $(ISISROOT)/make/isismake.tststree

isis/src/base/apps/shadow/tsts/errors/Makefile

deleted100644 → 0
+0 −12
Original line number Diff line number Diff line 
APPNAME = shadow



include $(ISISROOT)/make/isismake.tsts



# The seds erase cube names from []'s in the output error messages

commands:

	$(APPNAME) from=$(INPUT)/ab102401.dem.cub match=$(INPUT)/isisTruth.cub \

	  to=$(OUTPUT)/error1.cub 2>&1 | sed 's/\[.*cub/[/g' > $(OUTPUT)/error1.txt || true;

	$(APPNAME) from=$(INPUT)/ab102401.almostdem.cub match=$(INPUT)/isisTruth.cub \

	  to=$(OUTPUT)/error1.cub 2>&1 | sed 's/\[.*cub/[/g' > $(OUTPUT)/error2.txt || true;

	$(APPNAME) from=$(INPUT)/isisTruth.cub match=$(INPUT)/isisTruth.cub \

	  to=$(OUTPUT)/error2.cub 2>&1 | sed 's/\[.*cub/[/g' > $(OUTPUT)/error3.txt || true;