Cube.h

Go to the documentation of this file.

#ifndef Cube_h
#define Cube_h

#include <vector>

// This is needed for the QVariant macro
#include <QMetaType>

#include "Endian.h"
#include "PixelType.h"

class QFile;
class QMutex;
class QString;

namespace Isis {
  class Blob;
  class Buffer;
  class Camera;
  class CubeAttributeOutput;
  class CubeCachingAlgorithm;
  class CubeIoHandler;
  class FileName;
  class Projection;
  class Pvl;
  class PvlGroup;
  class Statistics;
  class Histogram;

  class Cube {
    public:
      Cube();
      Cube(const FileName &fileName, QString access = "r");
      virtual ~Cube();

      enum Format {
        Bsq,
        Tile
      };

      bool isOpen() const;
      bool isProjected() const;
      bool isReadOnly() const;
      bool isReadWrite() const;
      bool labelsAttached() const;

      void close(bool remove = false);
      Cube *copy(FileName newFile, const CubeAttributeOutput &newFileAttributes);
      void create(const QString &cfile);
      void create(const QString &cfile, const CubeAttributeOutput &att);
      void open(const QString &cfile, QString access = "r");
      void reopen(QString access = "r");

      void read(Blob &blob) const;
      void read(Buffer &rbuf) const;
      void write(Blob &blob);
      void write(Buffer &wbuf);

      void setBaseMultiplier(double base, double mult);
      void setMinMax(double min, double max);
      void setByteOrder(ByteOrder byteOrder);
      void setDimensions(int ns, int nl, int nb);
      void setExternalDnData(FileName cubeFileWithDnData);
      void setFormat(Format format);
      void setLabelsAttached(bool attached);
      void setLabelSize(int labelBytes);
      void setPixelType(PixelType pixelType);
      void setVirtualBands(const QList<QString> &vbands);
      void setVirtualBands(const std::vector<QString> &vbands);

      void relocateDnData(FileName dnDataFile);
//       static void relocateDnData(FileName externalLabelFile, FileName dnDataFile);

      int bandCount() const;
      double base() const;
      ByteOrder byteOrder() const;
      Camera *camera();
      FileName externalCubeFileName() const;
      QString fileName() const;
      Format format() const;
      Histogram *histogram(const int &band = 1,
                           QString msg = "Gathering histogram");
      Histogram *histogram(const int &band, const double &validMin,
                           const double &validMax,
                           QString msg = "Gathering histogram");
      Pvl *label() const;
      int labelSize(bool actual = false) const;
      int lineCount() const;
      double multiplier() const;
      PixelType pixelType() const;
      int physicalBand(const int &virtualBand) const;
      Projection *projection();
      int sampleCount() const;
      Statistics *statistics(const int &band = 1,
                             QString msg = "Gathering statistics");
      Statistics *statistics(const int &band, const double &validMin,
                             const double &validMax,
                             QString msg = "Gathering statistics");
      bool storesDnData() const;

      void addCachingAlgorithm(CubeCachingAlgorithm *);
      void clearIoCache();
      bool deleteBlob(QString BlobType, QString BlobName);
      void deleteGroup(const QString &group);
      PvlGroup &group(const QString &group) const;
      bool hasGroup(const QString &group) const;
      bool hasTable(const QString &name);
      void putGroup(const PvlGroup &group);

    private:
      void applyVirtualBandsToLabel();
      void cleanUp(bool remove);

      void construct();
      QFile *dataFile() const;
      FileName realDataFileName() const;

      void initialize();
      void initCoreFromLabel(const Pvl &label);
      void initLabelFromFile(FileName labelFileName, bool readWrite);
      void openCheck();
      Pvl realDataFileLabel() const;
      void reformatOldIsisLabel(const QString &oldCube);
      void writeLabels();

    private:
      QFile *m_labelFile;
      QFile *m_dataFile;

      CubeIoHandler *m_ioHandler;

      ByteOrder m_byteOrder;

      Format m_format;

      PixelType m_pixelType;

      QMutex *m_mutex;

      Camera *m_camera;

      Projection *m_projection;

      FileName *m_labelFileName;

      FileName *m_dataFileName;

      FileName *m_tempCube;

      FileName *m_formatTemplateFile;

      bool m_attached;

      bool m_storesDnData;

      Pvl *m_label;

      int m_labelBytes;

      int m_samples;

      int m_lines;

      int m_bands;

      double m_base;

      double m_multiplier;

      QList<int> *m_virtualBandList;
  };
}

Q_DECLARE_METATYPE(Isis::Cube *);

#endif