SerialNumberList.cpp

 
/* SPDX-License-Identifier: CC0-1.0 */
#include "SerialNumberList.h"
 
#include <QString>
 
#include "IException.h"
#include "FileList.h"
#include "FileName.h"
#include "ObservationNumber.h"
#include "Progress.h"
#include "Pvl.h"
#include "SerialNumber.h"
 
namespace Isis {
  SerialNumberList::SerialNumberList(bool checkTarget) {
    m_checkTarget = checkTarget;
    m_target.clear();
  }
 
 
  SerialNumberList::SerialNumberList(const QString &listfile,
                                     bool checkTarget,
                                     Progress *progress) {
    m_checkTarget = checkTarget;
    m_target.clear();
 
    try {
      FileList flist(listfile);
      if (progress != NULL) {
        progress->SetText("Creating Isis serial numbers from list file.");
        progress->SetMaximumSteps((int) flist.size() + 1);
        progress->CheckStatus();
      }
      for (int i = 0; i < flist.size(); i++) {
        add(flist[i].toString());
        if (progress != NULL) {
          progress->CheckStatus();
        }
      }
    }
    catch (IException &e) {
      QString msg = "Can't open or invalid file list [" + listfile + "].";
      throw IException(e, IException::User, msg, _FILEINFO_);
    }
 
  }
 
 
  SerialNumberList::~SerialNumberList() {
  }
 
 
  void SerialNumberList::remove(const QString &sn) {
    int index = serialNumberIndex(sn);
    QString sFileName = fileName(sn);
 
    // Delete the reference to this serial number in the vector and the maps
    m_pairs.erase(m_pairs.begin() + index);
    m_serialMap.erase(sn);
    m_fileMap.erase(sFileName);
  }
 
 
  void SerialNumberList::add(const QString &filename, bool def2filename) {
    Pvl p(Isis::FileName(filename).expanded());
    PvlObject cubeObj = p.findObject("IsisCube");
 
    try {
 
      // Test the target name if desired
      if (m_checkTarget) {
        QString target;
        PvlGroup targetGroup;
        if (cubeObj.hasGroup("Instrument")) {
          targetGroup = cubeObj.findGroup("Instrument");
        }
        else if (def2filename) {
          // No instrument, try Mapping
          if (cubeObj.hasGroup("Mapping")) {
            targetGroup = cubeObj.findGroup("Mapping");
          }
          else {
            QString msg = "Unable to find Instrument or Mapping group in "
                          + filename + " for comparing target.";
            throw IException(IException::User, msg, _FILEINFO_);
          }
        }
        else {
          // No Instrument group
          QString msg = "Unable to find Instrument group in " + filename
                        + " for comparing target.";
          throw IException(IException::User, msg, _FILEINFO_);
        }
 
        target = targetGroup["TargetName"][0];
        target = target.toUpper();
        if (m_target.isEmpty()) {
          m_target = target;
        }
        else if (m_target != target) {
          QString msg = "Target name of [" + target + "] from file ["
                        + filename + "] does not match [" + m_target + "].";
          throw IException(IException::User, msg, _FILEINFO_);
        }
      }
 
      // Create the SN
      QString sn = SerialNumber::Compose(p, def2filename);
      QString on = ObservationNumber::Compose(p, def2filename);
      if (sn == "Unknown") {
        QString msg = "Invalid serial number [Unknown] from file ["
                      + filename + "].";
        throw IException(IException::User, msg, _FILEINFO_);
      }
      else if (hasSerialNumber(sn)) {
        int index = serialNumberIndex(sn);
        QString msg = "Duplicate serial number [" + sn + "] from files ["
                      + SerialNumberList::fileName(sn) + "] and [" + fileName(index) + "].";
        throw IException(IException::User, msg, _FILEINFO_);
      }
 
      Pair nextpair;
      nextpair.filename = Isis::FileName(filename).expanded();
      nextpair.serialNumber = sn;
      nextpair.observationNumber = on;
 
      // If a CSM cube, obtain the CSMPlatformID and CSMInstrumentId from the CsmInfo
      // group for use in bundle adjustment
      if (cubeObj.hasGroup("CsmInfo")) {
        PvlGroup csmGroup = cubeObj.findGroup("CsmInfo");
        if (csmGroup.hasKeyword("CSMPlatformID") && csmGroup.hasKeyword("CSMInstrumentId")) {
          nextpair.spacecraftName = cubeObj.findGroup("CsmInfo")["CSMPlatformID"][0];
          nextpair.instrumentId = cubeObj.findGroup("CsmInfo")["CSMInstrumentId"][0];
        }
      }
 
      // Otherwise obtain the SpacecraftName and InstrumentId from the Instrument
      // group for use in bundle adjustment
      else if (cubeObj.hasGroup("Instrument")) {
        PvlGroup instGroup = cubeObj.findGroup("Instrument");
        if (instGroup.hasKeyword("SpacecraftName") && instGroup.hasKeyword("InstrumentId")) {
          nextpair.spacecraftName = cubeObj.findGroup("Instrument")["SpacecraftName"][0];
          nextpair.instrumentId = cubeObj.findGroup("Instrument")["InstrumentId"][0];
        }
      }
 
      m_pairs.push_back(nextpair);
      m_serialMap.insert(std::pair<QString, int>(sn, (int)(m_pairs.size() - 1)));
      m_fileMap.insert(std::pair<QString, int>(nextpair.filename, (int)(m_pairs.size() - 1)));
    }
    catch (IException &e) {
      QString msg = "FileName [" + Isis::FileName(filename).expanded() +
                        "] can not be added to serial number list.";
      throw IException(e, IException::User, msg, _FILEINFO_);
    }
 
  }
 
 
  void SerialNumberList::add(const char *serialNumber, const char *filename) {
    add((QString)serialNumber, (QString)filename);
  }
 
 
  void SerialNumberList::add(const QString &serialNumber, const QString &filename) {
    Pvl p(Isis::FileName(filename).expanded());
    PvlObject cubeObj = p.findObject("IsisCube");
 
    try {
 
      // Test the target name if desired
      if (m_checkTarget) {
        QString target;
        PvlGroup targetGroup;
        if (cubeObj.hasGroup("Instrument")) {
          targetGroup = cubeObj.findGroup("Instrument");
        }
        else if (cubeObj.hasGroup("Mapping")) {
          // No instrument, try Mapping
          targetGroup = cubeObj.findGroup("Mapping");
        }
        else {
            QString msg = "Unable to find Instrument or Mapping group in "
                          + filename + " for comparing target.";
            throw IException(IException::User, msg, _FILEINFO_);
        }
 
        target = targetGroup["TargetName"][0];
        target = target.toUpper();
        if (m_target.isEmpty()) {
          m_target = target;
        }
        else if (m_target != target) {
          QString msg = "Target name of [" + target + "] from file ["
                        + filename + "] does not match [" + m_target + "].";
          throw IException(IException::User, msg, _FILEINFO_);
        }
      }
 
      QString observationNumber = "Unknown";
      if (serialNumber == "Unknown") {
        QString msg = "Invalid serial number [Unknown] from file ["
                      + filename + "].";
        throw IException(IException::User, msg, _FILEINFO_);
      }
      else if (hasSerialNumber(serialNumber)) {
        int index = serialNumberIndex(serialNumber);
        QString msg = "Duplicate, serial number [" + serialNumber + "] from files ["
                      + SerialNumberList::fileName(serialNumber)
                      + "] and [" + fileName(index) + "].";
        throw IException(IException::User, msg, _FILEINFO_);
      }
 
      // Check if it is not a CSM label before checking SpacecraftName and InstrumentId
      if (!cubeObj.hasGroup("CsmInfo")) {
 
        // Need to obtain the SpacecraftName and InstrumentId from the Instrument
        // group for use in bundle adjustment
        if (!cubeObj.hasGroup("Instrument")) {
          QString msg = "Unable to find Instrument group in " + filename
                        + " needed for performing bundle adjustment.";
          throw IException(IException::User, msg, _FILEINFO_);
        }
        PvlGroup instGroup = cubeObj.findGroup("Instrument");
        if (!instGroup.hasKeyword("SpacecraftName") || !instGroup.hasKeyword("InstrumentId")) {
          QString msg = "Unable to find SpacecraftName or InstrumentId keywords in " + filename
                        + " needed for performing bundle adjustment.";
          throw IException(IException::User, msg, _FILEINFO_);
        }
      }
      // Check if CSM label has CSMPlatformID and CSMInstrumentId
      else {
        PvlGroup csmGroup = cubeObj.findGroup("CSMInfo");
        if (!csmGroup.hasKeyword("CSMPlatformID") || !csmGroup.hasKeyword("CSMInstrumentId")) {
          QString msg = "Unable to find CSMPlatformID or CSMInstrumentId keywords in " + filename
                        + " needed for performing bundle adjustment.";
          throw IException(IException::User, msg, _FILEINFO_);
        }
      }
 
      Pair nextpair;
      nextpair.filename = Isis::FileName(filename).expanded();
      nextpair.serialNumber = serialNumber;
      nextpair.observationNumber = observationNumber;
 
      // If a CSM cube, obtain the CSMPlatformID and CSMInstrumentId from the CsmInfo
      // group for use in bundle adjustment
      if (cubeObj.hasGroup("CsmInfo")) {
        PvlGroup csmGroup = cubeObj.findGroup("CsmInfo");
        if (csmGroup.hasKeyword("CSMPlatformID") && csmGroup.hasKeyword("CSMInstrumentId")) {
          nextpair.spacecraftName = cubeObj.findGroup("CsmInfo")["CSMPlatformID"][0];
          nextpair.instrumentId = cubeObj.findGroup("CsmInfo")["CSMInstrumentId"][0];
        }
      }
 
      // Otherwise obtain the SpacecraftName and InstrumentId from the Instrument
      // group for use in bundle adjustment
      else if (cubeObj.hasGroup("Instrument")) {
        PvlGroup instGroup = cubeObj.findGroup("Instrument");
        if (instGroup.hasKeyword("SpacecraftName") && instGroup.hasKeyword("InstrumentId")) {
          nextpair.spacecraftName = cubeObj.findGroup("Instrument")["SpacecraftName"][0];
          nextpair.instrumentId = cubeObj.findGroup("Instrument")["InstrumentId"][0];
        }
      }
 
      m_pairs.push_back(nextpair);
      m_serialMap.insert(std::pair<QString, int>(serialNumber, (int)(m_pairs.size() - 1)));
      m_fileMap.insert(std::pair<QString, int>(nextpair.filename, (int)(m_pairs.size() - 1)));
    }
    catch (IException &e) {
      QString msg = "[SerialNumber, FileName] = [" + serialNumber + ", "
                    + Isis::FileName(filename).expanded()
                    + "] can not be added to serial number list.";
      throw IException(e, IException::User, msg, _FILEINFO_);
    }
 
  }
 
 
  bool SerialNumberList::hasSerialNumber(QString sn) {
    if (m_serialMap.find(sn) == m_serialMap.end()) return false;
    return true;
  }
 
 
  int SerialNumberList::size() const {
    return m_pairs.size();
  }
 
 
  QString SerialNumberList::fileName(const QString &sn) {
    if (hasSerialNumber(sn)) {
      int index = m_serialMap.find(sn)->second;
      return m_pairs[index].filename;
    }
    else {
      QString msg = "Unable to get the FileName. The given serial number ["
                    + sn + "] does not exist in the list.";
      throw IException(IException::Programmer, msg, _FILEINFO_);
    }
  }
 
 
  QString SerialNumberList::serialNumber(const QString &filename) {
    if (m_fileMap.find(Isis::FileName(filename).expanded()) == m_fileMap.end()) {
      QString msg = "Unable to get the SerialNumber. The given file name ["
                    + Isis::FileName(filename).expanded() + "] does not exist in the list.";
      throw IException(IException::Programmer, msg, _FILEINFO_);
    }
    int index = fileNameIndex(filename);
    return m_pairs[index].serialNumber;
  }
 
 
  QString SerialNumberList::serialNumber(int index) {
    if (index >= 0 && index < (int) m_pairs.size()) {
      return m_pairs[index].serialNumber;
    }
    else {
      QString msg = "Unable to get the SerialNumber. The given index ["
                    + toString(index) + "] is invalid.";
      throw IException(IException::Programmer, msg, _FILEINFO_);
    }
  }
 
 
  QString SerialNumberList::observationNumber(int index) {
    if (index >= 0 && index < (int) m_pairs.size()) {
      return m_pairs[index].observationNumber;
    }
    else {
      QString msg = "Unable to get the ObservationNumber. The given index ["
                    + toString(index) + "] is invalid.";
      throw IException(IException::Programmer, msg, _FILEINFO_);
    }
  }
 
 
  int SerialNumberList::serialNumberIndex(const QString &sn) {
    if (hasSerialNumber(sn)) {
      return m_serialMap.find(sn)->second;
    }
    else {
      QString msg = "Unable to get the SerialNumber index. The given serial number ["
                    + sn + "] does not exist in the list.";
      throw IException(IException::Programmer, msg, _FILEINFO_);
    }
  }
 
 
  int SerialNumberList::fileNameIndex(const QString &filename) {
    std::map<QString, int>::iterator pos;
    if ((pos = m_fileMap.find(Isis::FileName(filename).expanded())) == m_fileMap.end()) {
      QString msg = "Unable to get the FileName index. The given file name ["
                    + Isis::FileName(filename).expanded() + "] does not exist in the list.";
      throw IException(IException::Programmer, msg, _FILEINFO_);
    }
    return pos->second;
  }
 
 
  QString SerialNumberList::fileName(int index) {
    if (index >= 0 && index < (int) m_pairs.size()) {
      return m_pairs[index].filename;
    }
    else {
      QString msg = "Unable to get the FileName. The given index ["
                    + toString(index) + "] is invalid.";
      throw IException(IException::Programmer, msg, _FILEINFO_);
    }
  }
 
 
  QString SerialNumberList::spacecraftInstrumentId(int index) {
    if (index >= 0 && index < (int) m_pairs.size()) {
      QString scid = (m_pairs[index].spacecraftName + "/" + m_pairs[index].instrumentId).toUpper();
 
      // silence 'unused-result' warnings with arbitrary cast
      (void)scid.simplified();
      return scid.replace(" ","");
    }
    else {
      QString msg = "Unable to get the Spacecraft InstrumentId. The given index ["
                    + toString(index) + "] is invalid.";
      throw IException(IException::Programmer, msg, _FILEINFO_);
    }
  }
 
 
  QString SerialNumberList::spacecraftInstrumentId(const QString &sn) {
    if (hasSerialNumber(sn)) {
      int index = m_serialMap.find(sn)->second;
      QString scid = (m_pairs[index].spacecraftName + "/" + m_pairs[index].instrumentId).toUpper();
 
      // silence 'unused-result' warnings with arbitrary cast
      (void)scid.simplified();
      return scid.replace(" ","");
    }
    else {
      QString msg = "Unable to get the Spacecraft InstrumentId. The given serial number ["
                    + sn + "] does not exist in the list.";
      throw IException(IException::Programmer, msg, _FILEINFO_);
    }
  }
 
 
  std::vector<QString> SerialNumberList::possibleSerialNumbers(const QString &on) {
    std::vector<QString> numbers;
    for (unsigned index = 0; index < m_pairs.size(); index++) {
      if (m_pairs[index].observationNumber == on) {
        numbers.push_back(m_pairs[index].serialNumber);
      }
    }
    if (numbers.size() > 0) {
      return numbers;
    }
    else {
      QString msg = "Unable to get the possible serial numbers. The given observation number ["
                    + on + "] does not exist in the list.";
      throw IException(IException::Programmer, msg, _FILEINFO_);
    }
  }
 
 
}