Unverified Commit 3cea8356 authored by paarongiroux's avatar paarongiroux Committed by GitHub
Browse files

Camstats normalization and test refactor (#3696) 

* Abstracted campt app.

* Revert "Merge branch 'campt' of https://github.com/kaitlyndlee/ISIS3

 into dev"

This reverts commit 521dd44a6831b488052aa0e21e65ca3c5f40f7f1, reversing
changes made to 2874acf6.

* normalized camstats, added functional tests

* removed old test makefile

* added docstring

Co-authored-by: default avatarKaitlyn Lee <kdl222@nau.edu>
parent 57b229f2

isis/src/base/apps/camstats/camstats.cpp

0 → 100644
+227 −0
Original line number Diff line number Diff line 


#include "camstats.h"

#include "Camera.h"

#include "CameraStatistics.h"

#include "Cube.h"

#include "Distance.h"

#include "IString.h"

#include "UserInterface.h"

#include "Process.h"

#include "Progress.h"

#include "Statistics.h"





using namespace std;

using namespace Isis;



namespace Isis {

  //function to build stats data

  void buildStats(Camera *cam, int &sample, int &line);

  void writeFlat(ofstream &os, const Statistics *s);

  string valueToString(const double &value);



  /**

   * Outputs camera statistics for a cube specified in ui parameters.

   * 

   * @param ui UserInterface object containing camstats parameters

   * @param(out) log the Pvl that camstat results log to

   */

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

    Process p;



    CubeAttributeInput cai;

    Cube *icube = p.SetInputCube(ui.GetFileName("FROM"), cai, ReadWrite);

    camstats(icube, ui, log);



    p.EndProcess();

  }





  void camstats(Cube *icube, UserInterface &ui, Pvl *log) {

    Process p;

    p.SetInputCube(icube);

    Camera *cam = icube->camera();





    QString from = icube->fileName();

    int sinc = ui.GetInteger("SINC");

    int linc = ui.GetInteger("LINC");

    CameraStatistics camStats(cam, sinc, linc, from);



    // Send the Output to the log area

    Pvl statsPvl = camStats.toPvl();

    for (int i = 0; i < statsPvl.groups(); i++) {

      log->addGroup(statsPvl.group(i));

    }



    if(ui.WasEntered("TO")) {

      QString outfile = FileName(ui.GetFileName("TO")).expanded();

      bool exists = FileName(outfile).fileExists();

      bool append = ui.GetBoolean("APPEND");



      // If the user chose a format of PVL, then write to the output file ("TO")

      if(ui.GetString("FORMAT") == "PVL") {

        (append) ? statsPvl.append(outfile) : statsPvl.write(outfile);

      }

      else {

        // Create a flatfile of the data with columhn headings the flatfile is

        // comma-delimited and can be imported in to spreadsheets

        ofstream os;

        bool writeHeader = true;

        if(append) {

          os.open(outfile.toLatin1().data(), ios::app);

          if(exists) {

            writeHeader = false;

          }

        }

        else {

          os.open(outfile.toLatin1().data(), ios::out);

        }



        // if new file or append and no file exists then write header

        if(writeHeader) {

          os << "Filename," <<

             "LatitudeMinimum," <<

             "LatitudeMaximum," <<

             "LatitudeAverage," <<

             "LatitudeStandardDeviation," <<

             "LongitudeMinimum," <<

             "LongitudeMaximum," <<

             "LongitudeAverage," <<

             "LongitudeStandardDeviation," <<

             "SampleResolutionMinimum," <<

             "SampleResolutionMaximum," <<

             "SampleResolutionAverage," <<

             "SampleResolutionStandardDeviation," <<

             "LineResolutionMinimum," <<

             "LineResolutionMaximum," <<

             "LineResolutionAverage," <<

             "LineResolutionStandardDeviation," <<

             "ResolutionMinimum," <<

             "ResolutionMaximum," <<

             "ResolutionAverage," <<

             "ResolutionStandardDeviation," <<

             "AspectRatioMinimum," <<

             "AspectRatioMaximum," <<

             "AspectRatioAverage," <<

             "AspectRatioStandardDeviation," <<

             "PhaseMinimum," <<

             "PhaseMaximum," <<

             "PhaseAverage," <<

             "PhaseStandardDeviation," <<

             "EmissionMinimum," <<

             "EmissionMaximum," <<

             "EmissionAverage," <<

             "EmissionStandardDeviation," <<

             "IncidenceMinimum," <<

             "IncidenceMaximum," <<

             "IncidenceAverage," <<

             "IncidenceStandardDeviation," <<

             "LocalSolarTimeMinimum," <<

             "LocalSolarTimeMaximum," <<

             "LocalSolarTimeAverage," <<

             "LocalSolarTimeStandardDeviation," <<

             "LocalRadiusMaximum," <<

             "LocalRadiusMaximum," <<

             "LocalRadiusAverage," <<

             "LocalRadiusStandardDeviation," <<

             "NorthAzimuthMinimum," <<

             "NorthAzimuthMaximum," <<

             "NorthAzimuthAverage," <<

             "NorthAzimuthStandardDeviation," <<

             "ObliqueResolutionMinimum," <<

             "ObliqueResolutionMaximum," <<

             "ObliqueResolutionAverage," <<

             "ObliqueResolutionStandardDeviation," <<

             "ObliqueLineResolutionMinimum," <<

             "ObliqueLineResolutionMaximum," <<

             "ObliqueLineResolutionAverage," <<

             "ObliqueLineResolutionStandardDeviation," <<

             "ObliqueSampleResolutionMinimum," <<

             "ObliqueSampleResolutionMaximum," <<

             "ObliqueSampleResolutionAverage," <<

             "ObliqueSampleResolutionStandardDeviation," << endl;





        }

        os << FileName(from).expanded() << ",";

        //call the function to write out the values for each group

        writeFlat(os, camStats.getLatStat());

        writeFlat(os, camStats.getLonStat());

        writeFlat(os, camStats.getSampleResStat());

        writeFlat(os, camStats.getLineResStat());

        writeFlat(os, camStats.getResStat());

        writeFlat(os, camStats.getAspectRatioStat());

        writeFlat(os, camStats.getPhaseStat());

        writeFlat(os, camStats.getEmissionStat());

        writeFlat(os, camStats.getIncidenceStat());

        writeFlat(os, camStats.getLocalSolarTimeStat());

        writeFlat(os, camStats.getLocalRaduisStat());

        writeFlat(os, camStats.getNorthAzimuthStat());

        writeFlat(os,camStats.getObliqueResStat());

        writeFlat(os,camStats.getObliqueLineResStat());

        writeFlat(os,camStats.getObliqueSampleResStat());

        os << endl;

      }

    }



    if(ui.GetBoolean("ATTACH")) {

      QString cam_name = "CameraStatistics";



      //Creates new CameraStatistics Table

      TableField fname("Name", Isis::TableField::Text, 45);

      TableField fmin("Minimum", Isis::TableField::Double);

      TableField fmax("Maximum", Isis::TableField::Double);

      TableField favg("Average", Isis::TableField::Double);

      TableField fstd("StandardDeviation", Isis::TableField::Double);



      TableRecord record;

      record += fname;

      record += fmin;

      record += fmax;

      record += favg;

      record += fstd;



      Table table(cam_name, record);



      // Place all the gathered camera statistics in a table and attach it to the

      // cube. Skip "User Parameters" group.

      for (int i = 1; i < statsPvl.groups(); i++) {

        PvlGroup &group = statsPvl.group(i);



        int entry = 0;

        record[entry] = group.name();

        entry++;

        for (int j = 0; j < group.keywords(); j++) {

          record[entry] = toDouble(group[j][0]);

          entry++;

        }

        table += record;

      }



      icube->reopen("rw");

      icube->write(table);

      p.WriteHistory(*icube);

      icube->close();

    }

  }





  //function to write the stats values to flat file

  void writeFlat(ofstream &os, const Statistics *s) {

    os << valueToString(s->Minimum()) << "," <<

       valueToString(s->Maximum()) << "," <<

       valueToString(s->Average()) << "," <<

       valueToString(s->StandardDeviation()) << ",";

  }





  string valueToString(const double &value) {

    if(IsSpecial(value)) {

      return (string("NULL"));

    }

    else {

      return ((string) IString(value));

    }

  }

}

isis/src/base/apps/camstats/camstats.h

0 → 100644
+12 −0
Original line number Diff line number Diff line 
#ifndef camstats_h

#define camstats_h



#include "Pvl.h"

#include "UserInterface.h"



namespace Isis{

  extern void camstats(UserInterface &ui, Pvl *log);

  extern void camstats(Cube *icube, UserInterface &ui, Pvl *log);

}



#endif

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

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



#include "Camera.h"

#include "CameraStatistics.h"

#include "Cube.h"

#include "Distance.h"

#include "IString.h"

#include "UserInterface.h"

#include "Process.h"

#include "Progress.h"

#include "Statistics.h"

#include "camstats.h"



#include "Application.h"

#include "Pvl.h"



using namespace std;

using namespace Isis;



//function to build stats data

void buildStats(Camera *cam, int &sample, int &line);

void writeFlat(ofstream &os, const Statistics *s);

string valueToString(const double &value);





void IsisMain() {

  Process p;

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

  Camera *cam = icube->camera();



  UserInterface &ui = Application::GetUserInterface();



  QString from = ui.GetFileName("FROM");

  int sinc = ui.GetInteger("SINC");

  int linc = ui.GetInteger("LINC");

  CameraStatistics camStats(cam, sinc, linc, from);



  // Send the Output to the log area

  Pvl statsPvl = camStats.toPvl();

  for (int i = 0; i < statsPvl.groups(); i++) {

    Application::Log(statsPvl.group(i));

  }



  if(ui.WasEntered("TO")) {

    QString outfile = FileName(ui.GetFileName("TO")).expanded();

    bool exists = FileName(outfile).fileExists();

    bool append = ui.GetBoolean("APPEND");



    // If the user chose a format of PVL, then write to the output file ("TO")

    if(ui.GetString("FORMAT") == "PVL") {

      (append) ? statsPvl.append(outfile) : statsPvl.write(outfile);

    }

    else {

      // Create a flatfile of the data with columhn headings the flatfile is

      // comma-delimited and can be imported in to spreadsheets

      ofstream os;

      bool writeHeader = true;

      if(append) {

        os.open(outfile.toLatin1().data(), ios::app);

        if(exists) {

          writeHeader = false;

        }

      }

      else {

        os.open(outfile.toLatin1().data(), ios::out);

      }



      // if new file or append and no file exists then write header

      if(writeHeader) {

        os << "Filename," <<

           "LatitudeMinimum," <<

           "LatitudeMaximum," <<

           "LatitudeAverage," <<

           "LatitudeStandardDeviation," <<

           "LongitudeMinimum," <<

           "LongitudeMaximum," <<

           "LongitudeAverage," <<

           "LongitudeStandardDeviation," <<

           "SampleResolutionMinimum," <<

           "SampleResolutionMaximum," <<

           "SampleResolutionAverage," <<

           "SampleResolutionStandardDeviation," <<

           "LineResolutionMinimum," <<

           "LineResolutionMaximum," <<

           "LineResolutionAverage," <<

           "LineResolutionStandardDeviation," <<

           "ResolutionMinimum," <<

           "ResolutionMaximum," <<

           "ResolutionAverage," <<

           "ResolutionStandardDeviation," <<

           "AspectRatioMinimum," <<

           "AspectRatioMaximum," <<

           "AspectRatioAverage," <<

           "AspectRatioStandardDeviation," <<

           "PhaseMinimum," <<

           "PhaseMaximum," <<

           "PhaseAverage," <<

           "PhaseStandardDeviation," <<

           "EmissionMinimum," <<

           "EmissionMaximum," <<

           "EmissionAverage," <<

           "EmissionStandardDeviation," <<

           "IncidenceMinimum," <<

           "IncidenceMaximum," <<

           "IncidenceAverage," <<

           "IncidenceStandardDeviation," <<

           "LocalSolarTimeMinimum," <<

           "LocalSolarTimeMaximum," <<

           "LocalSolarTimeAverage," <<

           "LocalSolarTimeStandardDeviation," <<

           "LocalRadiusMaximum," <<

           "LocalRadiusMaximum," <<

           "LocalRadiusAverage," <<

           "LocalRadiusStandardDeviation," <<

           "NorthAzimuthMinimum," <<

           "NorthAzimuthMaximum," <<

           "NorthAzimuthAverage," <<

           "NorthAzimuthStandardDeviation," <<

           "ObliqueResolutionMinimum," <<

           "ObliqueResolutionMaximum," <<

           "ObliqueResolutionAverage," <<

           "ObliqueResolutionStandardDeviation," <<

           "ObliqueLineResolutionMinimum," <<

           "ObliqueLineResolutionMaximum," <<

           "ObliqueLineResolutionAverage," <<

           "ObliqueLineResolutionStandardDeviation," <<

           "ObliqueSampleResolutionMinimum," <<

           "ObliqueSampleResolutionMaximum," <<

           "ObliqueSampleResolutionAverage," <<

           "ObliqueSampleResolutionStandardDeviation," << endl;





      }

      os << FileName(from).expanded() << ",";

      //call the function to write out the values for each group

      writeFlat(os, camStats.getLatStat());

      writeFlat(os, camStats.getLonStat());

      writeFlat(os, camStats.getSampleResStat());

      writeFlat(os, camStats.getLineResStat());

      writeFlat(os, camStats.getResStat());

      writeFlat(os, camStats.getAspectRatioStat());

      writeFlat(os, camStats.getPhaseStat());

      writeFlat(os, camStats.getEmissionStat());

      writeFlat(os, camStats.getIncidenceStat());

      writeFlat(os, camStats.getLocalSolarTimeStat());

      writeFlat(os, camStats.getLocalRaduisStat());

      writeFlat(os, camStats.getNorthAzimuthStat());

      writeFlat(os,camStats.getObliqueResStat());

      writeFlat(os,camStats.getObliqueLineResStat());

      writeFlat(os,camStats.getObliqueSampleResStat());

      os << endl;

  Pvl appLog;

  try {

    camstats(ui, &appLog);

  }

  catch (...) {

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

      Application::Log(*grpIt);

    }



  if(ui.GetBoolean("ATTACH")) {



    QString cam_name = "CameraStatistics";



    //Creates new CameraStatistics Table

    TableField fname("Name", Isis::TableField::Text, 45);

    TableField fmin("Minimum", Isis::TableField::Double);

    TableField fmax("Maximum", Isis::TableField::Double);

    TableField favg("Average", Isis::TableField::Double);

    TableField fstd("StandardDeviation", Isis::TableField::Double);



    TableRecord record;

    record += fname;

    record += fmin;

    record += fmax;

    record += favg;

    record += fstd;



    Table table(cam_name, record);



    // Place all the gathered camera statistics in a table and attach it to the

    // cube. Skip "User Parameters" group.

    for (int i = 1; i < statsPvl.groups(); i++) {

      PvlGroup &group = statsPvl.group(i);



      int entry = 0;

      record[entry] = group.name();

      entry++;

      for (int j = 0; j < group.keywords(); j++) {

        record[entry] = toDouble(group[j][0]);

        entry++;

      }

      table += record;

    throw;

  }



    icube->reopen("rw");

    icube->write(table);

    p.WriteHistory(*icube);

    icube->close();

  }

}





//function to write the stats values to flat file

void writeFlat(ofstream &os, const Statistics *s) {

  os << valueToString(s->Minimum()) << "," <<

     valueToString(s->Maximum()) << "," <<

     valueToString(s->Average()) << "," <<

     valueToString(s->StandardDeviation()) << ",";

}





string valueToString(const double &value) {

  if(IsSpecial(value)) {

    return (string("NULL"));

  }

  else {

    return ((string) IString(value));

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

    Application::Log(*grpIt);

  }

}

isis/src/base/apps/camstats/tsts/default/Makefile

deleted100644 → 0
+0 −8
Original line number Diff line number Diff line 
APPNAME = camstats



include $(ISISROOT)/make/isismake.tsts

 

commands:

	$(APPNAME) FROM=$(INPUT)/input.cub TO=$(OUTPUT)/output.pvl > /dev/null;

	$(CP) $(INPUT)/input.cub $(OUTPUT)/attached.cub;

	$(APPNAME) FROM=$(OUTPUT)/attached.cub ATTACH=true > /dev/null;

isis/src/base/objs/CameraStatistics/CameraStatistics.cpp

+1 −1
Original line number Diff line number Diff line
@@ -441,6 +441,7 @@ namespace Isis { 


    PvlGroup pAspectRatio("AspectRatio");

    pAspectRatio += constructKeyword("AspectRatioMinimum", m_aspectRatioStat->Minimum());

    // Note: Maximum is spelled wrong here.

    pAspectRatio += constructKeyword("AspectRatioMaximun", m_aspectRatioStat->Maximum());

    pAspectRatio += constructKeyword("AspectRatioAverage", m_aspectRatioStat->Average());

    pAspectRatio += constructKeyword("AspectRatioStandardDeviation",
@@ -513,4 +514,3 @@ namespace Isis { 
    return returnPvl;

  }

}