voy2isis.cpp

Go to the documentation of this file.

#include "Isis.h"

#include <cstdio>
#include <fstream>
#include <string>

#include "Filename.h"
#include "iException.h"
#include "iString.h"
#include "NaifStatus.h"
#include "ProcessImportPds.h"
#include "ProgramLauncher.h"
#include "Pvl.h"
#include "PvlGroup.h"
#include "PvlTranslationManager.h"
#include "UserInterface.h"

#include "naif/SpiceUsr.h"

#include <iostream>
#include <iomanip>

using namespace std;
using namespace Isis;

void TranslateVoyagerLabels(Pvl &inputLabel, Cube *ocube);
void ConvertComments(Filename file);

void IsisMain() {
  // We should be processing a PDS file
  ProcessImportPds p;
  UserInterface &ui = Application::GetUserInterface();
  Filename in = ui.GetFilename("FROM");

  string tempName = "$TEMPORARY/" + in.Basename() + ".img";
  Filename temp(tempName);

  bool tempFile = false;

  // input files are compressed, use vdcomp to decompress
  iString ext = iString(in.Extension()).UpCase();
  if(ext == "IMQ") {
    try {
      string command = "$ISISROOT/bin/vdcomp " + in.Expanded() + " " + temp.Expanded();
      // don't pretend vdcomp is a standard Isis program, just run it
      ProgramLauncher::RunSystemCommand(command);
      in = temp.Expanded();
      ConvertComments(in);
      tempFile = true;
    }
    catch(iException &e) {
      throw iException::Message(iException::Io,
                                "Unable to decompress input file ["
                                + in.Name() + "].", _FILEINFO_);
    }
  }
  else if (ext == "IMG") {
    // Do nothing
  }
  else {
    string msg = "Input file [" + in.Name() +
                 "] does not appear to be a Voyager EDR";
    throw iException::Message(iException::User, msg, _FILEINFO_);
  }
  // Convert the pds file to a cube
  Pvl pdsLabel;
  try {
    p.SetPdsFile(in.Expanded(), "", pdsLabel);
  }
  catch(iException &e) {
    string msg = "Unable to set PDS file.  Decompressed input file ["
                 + in.Name() + "] does not appear to be a PDS product";
    throw iException::Message(iException::User, msg, _FILEINFO_);
  }

  Cube *ocube = p.SetOutputCube("TO");
  p.StartProcess();
  TranslateVoyagerLabels(pdsLabel, ocube);
  p.EndProcess();

  if(tempFile) remove(temp.Expanded().c_str());
}

/**
 * Converts / * Some comment
 * to       #   Some comment
 * without the extra space.
 */
void ConvertComments(Filename file) {
  char tmp[10240];

  for(unsigned int i = 0; i < sizeof(tmp) / sizeof(char); i++)
    tmp[i] = '\0';

  unsigned int lineStartPos = 0;
  fstream stream;
  iString filename = file.Expanded();
  stream.open(filename.c_str(), fstream::in | fstream::out | fstream::binary);

  lineStartPos = stream.tellg();
  stream.getline(tmp, sizeof(tmp) / sizeof(char));
  while(iString(tmp).find("END") != 0 && stream.good()) {
    iString lineOfData(tmp);

    if(lineOfData.find("/*") != string::npos &&
        lineOfData.find("*/") == string::npos) {
      lineOfData = lineOfData.substr(0, lineOfData.find("/*")) + "# " +
                   lineOfData.substr(lineOfData.find("/*") + 2);
      stream.seekp(lineStartPos);
      stream.write(lineOfData.c_str(), lineOfData.length());
    }

    lineStartPos = stream.tellg();
    stream.getline(tmp, sizeof(tmp) / sizeof(char));
  }

  stream.close();
}


/**
 * @brief Translate labels into Isis3
 *
 * @param inputLabel Reference to pvl label from the input image
 * @param ocube Pointer to output cube
 * @internal
 *   @history 2009-03-11 Jeannie Walldren - Original Version
 */
void TranslateVoyagerLabels(Pvl &inputLabel, Cube *ocube) {
  // Get the directory where the Voyager translation tables are
  PvlGroup &dataDir = Preference::Preferences().FindGroup("DataDirectory");
  iString missionDir = (string) dataDir[(string)inputLabel["SpacecraftName"]];
  Filename transFile(missionDir + "/translations/voyager.trn");

  // Get the translation manager ready
  PvlTranslationManager labelXlater(inputLabel, transFile.Expanded());

  // Pvl output label
  Pvl *outputLabel = ocube->getLabel();
  labelXlater.Auto(*(outputLabel));

  // Add needed keywords that are not in the translation table
  PvlGroup &inst = outputLabel->FindGroup("Instrument", Pvl::Traverse);

  // Add Camera_State_1 and Camera_State_2
  // Camera_State_1 is the first number in ScanModeId
  // Camera_State_2 is from ShutterModeId and is 1 or 0, it is only 1 if
  // it is WA and BSIMAN or BOTSIM
  PvlKeyword sModeId = inst["ScanModeId"];
  string cs1 = sModeId[0].Token(":");
  inst.AddKeyword(PvlKeyword("CameraState1",cs1));

  string shutterMode = inst["ShutterModeId"];
  string cam = inst["InstrumentId"];
  if (cam == "WIDE_ANGLE_CAMERA" && (shutterMode == "BOTSIM" || shutterMode == "BSIMAN")) {
    inst.AddKeyword(PvlKeyword("CameraState2","1"));
  }
  else {
    inst.AddKeyword(PvlKeyword("CameraState2","0"));
  }

  // Add units of measurement to keywords from translation table
  double exposureDuration = inst.FindKeyword("ExposureDuration");
  inst.FindKeyword("ExposureDuration").SetValue(exposureDuration, "seconds");

  // Setup the kernel group
  PvlGroup kern("Kernels");
  iString spacecraftNumber;
  int spacecraftCode = 0;
  iString instId = (string) inst.FindKeyword("InstrumentId");
  if((string) inst.FindKeyword("SpacecraftName") == "VOYAGER_1") {
    spacecraftNumber = "1";
    if(instId == "NARROW_ANGLE_CAMERA") {
      spacecraftCode = -31101;
      kern += PvlKeyword("NaifFrameCode", spacecraftCode);
      instId = "issna";
    }
    else if (instId == "WIDE_ANGLE_CAMERA") {
      spacecraftCode = -31102;
      kern += PvlKeyword("NaifFrameCode", spacecraftCode);
      instId = "isswa";
    }
    else {
      string msg = "Instrument ID [" + instId + "] does not match Narrow or" +
                   "Wide angle camera";
      iException::Message(iException::User, msg, _FILEINFO_);
    }
  }
  else if((string) inst.FindKeyword("SpacecraftName") == "VOYAGER_2") {
    spacecraftNumber = "2";
    if(instId == "NARROW_ANGLE_CAMERA") {
      spacecraftCode = -32101;
      kern += PvlKeyword("NaifFrameCode", spacecraftCode);
      instId = "issna";
    }
    else if (instId == "WIDE_ANGLE_CAMERA") {
      spacecraftCode = -32102;
      kern += PvlKeyword("NaifFrameCode", spacecraftCode);
      instId = "isswa";
    }
    else {
      string msg = "Instrument ID [" + instId + "] does not match Narrow or" +
                   "Wide angle camera";
      iException::Message(iException::User, msg, _FILEINFO_);
    }
  }
  else {
    string msg = "Spacecraft name [" + (string)inst.FindKeyword("SpacecraftName") +
                 "] does not match Voyager1 or Voyager2 spacecraft";
    iException::Message(iException::User, msg, _FILEINFO_);
  }
  ocube->putGroup(kern);

  // Modify time to remove Z from end
  iString time = inst.FindKeyword("StartTime")[0];
  time.Remove("Z");
  inst.FindKeyword("StartTime").SetValue(time);

  // Fix image number - remove the period, if Wide angle camera and one of two
  // shutter modes, we must fix the wide angle image number for use below.
  // Before #####.##     After #######
  iString imgNumber = inst["SpacecraftClockCount"][0];
  imgNumber.Replace(".", "");
  // Save this change
  inst["SpacecraftClockCount"] = imgNumber;

  // From vgrfixlabel documentation in Isis2.
  // Wide Angle (WA) images off of CD's will have a fake image
  // number (NA image_number + scan_mode_id) written over the
  // image_number label, which would have gotten the FSC count
  // rather than the FSD count if a Narrow Angle was shuttered
  // simultaneously.  What I want is to figure out the NA image-
  // number, which will allow me to find the shutter time (same
  // for both NA & WA).  So run backward, WA image_number - scan_
  // mode_id.
  // If BSIMAN or BOTSIM and WA, go ahead.
  if((inst["ShutterModeId"][0] == "BSIMAN" ||
      inst["ShutterModeId"][0] == "BOTSIM") &&
      inst["InstrumentId"][0] == "WIDE_ANGLE_CAMERA") {
    iString scanId = inst["ScanModeId"][0];
    int scanNum = iString(scanId.substr(0, 1)).ToInteger();
    int imgNum = imgNumber.ToInteger();

    // We'll use this later, however, we do not write it to the labels.
    // if we didn't get in here, we'll be using the original image number,
    // otherwise, we'll use this modified image number.
    imgNumber = iString((imgNum - scanNum));
  }

  // This next section handles modifying the starttime slightly and requires
  // the leapsecond kernel, the spacecraft clock kernel, and a correct
  // spacecraft clock.
  // This functionality was copied from Isis2 by Mackenzie Boyd, the
  // documentation from Isis2 is here: (from vgrfixlabel.c)
  /*******************************************************************
    Get spacecraftClock from image FSC.

    Calculate the START_TIME keyword value from FSC to get fractional
    seconds (PDS START_TIME provided is only to the nearest whole
    second).  The algorithm below was extracted from the NAIF
    document Viking Orbiter Time Tag Analysis and Restoration by
    Boris Semenov and Chuck Acton and was modified for Voyager by
    Debbie Cook and K Teal Thompson.

    1.  Determine instCode, spacecraftCode.
        Get FSC (FDS_COUNT) from IMAGE_NUMBER to use as
        spacecraftClock.  This was already done above when the
        IMAGE_NUMBER was read into imagenum.
        //Already accomplished above

    2.  Need to calc the image number for wide Angle images when
        SHUTTER_MODE_ID = BOTSIM or BSIMAN because the IMAGE_NUMBER
        on the labels is set to the readout count instead of the FDS
        (FLIGHT DATA SUBSYSTEM) count.  In the old code, SCAN_MODE_ID
        is used to add to the image_number to get a new image_number
        for WA.  In this code, take WA image number and subtract
        scan_mode id to get the narrow angle image_number.
        // This is also accomplished above

    3.  Load a leap second kernel and the appropriate FSC spacecraft
        clock kernel based on the spacecraft (Voyager 1 or Voyager
        2).  Then convert image_number/spacecraftClock to et.


    4.  Convert et to UTC calendar format and write to labels as
        START_TIME


  ********************************************************************/

  // We've already handled a couple of the steps mentioned above.
  NaifStatus::CheckErrors();
  //* 3 *//
  // Leapsecond kernel
  string lsk = "$ISIS3DATA/base/kernels/lsk/naif????.tls";
  Filename lskName(lsk);
  lskName.HighestVersion();
  furnsh_c(lskName.Expanded().c_str());

  // Spacecraft clock kernel
  string sclk = "$ISIS3DATA/voyager";
  sclk.append(spacecraftNumber);
  sclk.append("/kernels/sclk/vg");
  sclk.append(spacecraftNumber);
  sclk.append("?????.tsc");
  Filename sclkName(sclk);
  sclkName.HighestVersion();
  furnsh_c(sclkName.Expanded().c_str());

  // The purpose of the next two steps, getting the spacecraft clock count,
  // are simply to get get the partition, the very first number 1/...
  double approxEphemeris = 0.0;
  utc2et_c(inst["StartTime"][0].c_str(), &approxEphemeris);
  char approxSpacecraftClock[80];

  // sce2s_c requires the spacecraft number, not the instrument number as
  // we've found elsewhere, either -31 or -32 in this case.
  int spacecraftClockNumber = -30;
  spacecraftClockNumber -= spacecraftNumber.ToInteger();
  sce2s_c(spacecraftClockNumber, approxEphemeris, 80, approxSpacecraftClock);

  /*
   * For our next trick, we will substitute the image number we got earlier
   * into this image number. The image number is in the format #######,
   * 7 digits, our freshly gotten image number is in the form #/#####:##:##
   * We want to save the first digit, before the /, and then substitute
   * the previously found image number into the next 7 digits, keeping the colon,
   * and then removing the last :## colon and two digits. Here goes.
   * BTW, our imageNumber from above and this number may be identical,
   * in which case this won't change anything in it. However, since the
   * conversion from ET to spacecraftClock is a range of ETs all mapping to one
   * clock count, even if we don't modifiy the spacecraft clock count, we'll
   * come out with a slightly different starttime which is, in theory, more accurate.
   * To rephrase, ETs are continuous, Spacecraft clock is discrete. For later
   * we will use the Starttime, the ET, so we want it to match the spacecraft clock
   * exactly. But, the original starttime holds valuable information... enough.
   */

  // Get first digit and the /
  iString newClockCount = string(approxSpacecraftClock).substr(0, 2);
  // Get first five digits of imgNumber and append
  newClockCount.append(imgNumber.substr(0, 5));
  // I'll stop commenting now, you can read code as well as me
  newClockCount.append(":");
  // I lied ;) get the last two digits.
  newClockCount.append(imgNumber.substr(5, 2));

  scs2e_c(spacecraftClockNumber, newClockCount.c_str(), &approxEphemeris);

  //* 4 *//
  char utcOut[25];
  et2utc_c(approxEphemeris, "ISOC", 3, 26, utcOut);
  NaifStatus::CheckErrors();
  inst["StartTime"].SetValue(iString(utcOut));

  // Set up the nominal reseaus group
  PvlGroup res("Reseaus");
  Pvl nomRes("$voyager" + spacecraftNumber + "/reseaus/nominal.pvl");
  PvlKeyword samps, lines, type, valid;
  lines = PvlKeyword("Line");
  samps = PvlKeyword("Sample");
  type = PvlKeyword("Type");
  valid = PvlKeyword("Valid");

  PvlKeyword key = nomRes.FindKeyword("VG" + spacecraftNumber + "_"
                                      + instId.UpCase() + "_RESEAUS");
  int numRes = nomRes["VG" + spacecraftNumber + "_" + instId.UpCase()
                      + "_NUMBER_RESEAUS"];
  for(int i = 0; i < numRes * 3; i += 3) {
    lines += key[i];
    samps += key[i+1];
    type += key[i+2];
    valid += 0;
  }
  res += lines;
  res += samps;
  res += type;
  res += valid;
  res += PvlKeyword("Template", "$voyager" + spacecraftNumber + "/reseaus/vg"
                    + spacecraftNumber + "." + instId.DownCase()
                    + ".template.cub");
  res += PvlKeyword("Status", "Nominal");
  ocube->putGroup(res);
}