ProcessExportPds.h

Go to the documentation of this file.

#ifndef ProcessExportPds_h
#define ProcessExportPds_h
/*
 *   Unless noted otherwise, the portions of Isis written by the
 *   USGS are public domain. See individual third-party library
 *   and package descriptions for intellectual property
 *   information,user agreements, and related information.
 *
 *   Although Isis has been used by the USGS, no warranty, expressed or implied,
 *   is made by the USGS as to the accuracy and functioning of such software
 *   and related material nor shall the fact of distribution constitute any such
 *   warranty, and no responsibility is assumed by the USGS in connection
 *   therewith.
 *
 *   For additional information, launch
 *   $ISISROOT/doc//documents/Disclaimers/Disclaimers.html in a browser or see
 *   the Privacy & Disclaimers page on the Isis website,
 *   http://isis.astrogeology.usgs.gov, and the USGS privacy and disclaimers on
 *   http://www.usgs.gov/privacy.html.
 */

#include "ProcessExport.h"
#include <vector>

class QString;

namespace Isis {
  class PvlFormatPds;
  class Table;

  class ProcessExportPds : public Isis::ProcessExport {
    public:
      enum PdsFileType   {
        Image,        
        Qube,         
        SpectralQube, 
        JP2Image      
      };

      enum PdsResolution {
        Meter,    
        Kilometer 
      };

      enum PdsExportType {
        Stream, 
        Fixed   
      };

      ProcessExportPds();
      ~ProcessExportPds();

      // Work with PDS labels for all data set types
      void StandardAllMapping(Pvl &mainPvl);

      // Work with PDS labels for data sets of type IMAGE
      void StreamImageRoot(Pvl &mainPvl);
      void FixedImageRoot(Pvl &mainPvl);
      void StreamJP2ImageRoot(Pvl &mainPvl);
      void FixedJP2ImageRoot(Pvl &mainPvl);
      void StandardImageImage(Pvl &mainPvl);
      void StandardJP2Image(Pvl &mainPvl);

      void SetPdsResolution(PdsResolution resolutionUnits);
      void SetExportType(PdsExportType recordFormat);

      virtual Pvl &StandardPdsLabel(ProcessExportPds::PdsFileType type);

      void OutputLabel(std::ofstream &pdsFileStream);
      void updateChecksumInLabel(std::ofstream &pdsFileStream);
      void OutputDetachedLabel();

      void ExportTable(Isis::Table isisTable, QString detachedPdsTableFileName="");

      // include this using declaration to indicate that ProcessExportPds
      // objects that call a StartProcess() method that has not been overridden
      // here should use the corresponding base class definitions
      using ProcessExport::StartProcess;
      void StartProcess(std::ofstream &fout);

      // Accessors
      bool Detached();
      bool Attached();

      // Mutators
      void SetDetached(QString detachedLabelFile);
      void SetAttached();
      void ForceBands(bool force);
      void ForceBandName(bool force);
      void ForceCenterFilterWavelength(bool force);
      void ForceBandwidth(bool force);
      void ForceBandStorageType(bool force);
      void ForceOffset(bool force);
      void ForceScalingFactor(bool force);
      void ForceSampleBits(bool force);
      void ForceSampleBitMask(bool force);
      void ForceSampleType(bool force);
      void ForceCoreNull(bool force);
      void ForceCoreLrs(bool force);
      void ForceCoreLis(bool force);
      void ForceCoreHrs(bool force);
      void ForceCoreHis(bool force);

    protected:
      int LineBytes();
      int LabelSize();
      virtual void CreateImageLabel();
      void CreateQubeLabel();
      void CreateSpectralQubeLabel();

      QString ProjectionName(Pvl &inputLabel);

      PvlFormatPds *m_formatter;  
      Pvl *m_label;               
      PdsExportType m_exportType; 

    private:
      PdsResolution m_exportResolution; 
      bool m_forceBands;             
      bool m_forceBandName;          
      bool m_forceCenterFilterWavelength; 
      bool m_forceBandwidth;         
      bool m_forceBandStorageType;   
      bool m_forceOffset;            
      bool m_forceScalingFactor;     
      bool m_forceSampleBits;        
      bool m_forceSampleBitMask;     
      bool m_forceSampleType;        
      bool m_forceCoreNull;          
      bool m_forceCoreLrs;           
      bool m_forceCoreLis;           
      bool m_forceCoreHrs;           
      bool m_forceCoreHis;           
      bool m_detachedLabel;          
      QString m_detachedPdsLabelFile;
      PdsFileType m_pdsFileType;     
      std::vector<int> m_tableStartRecord;
      std::vector<int> m_tableRecords; 
      std::vector<char *> m_tableBuffers; 
  };
}

#endif