Isis 3.0 Developer's Reference (API)

Home

---

Cube.h

Go to the documentation of this file.

#ifndef Cube_h
#define Cube_h

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

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

class QFile;
class QMutex;

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

  class Cube {
    public:
      Cube();
      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);
      void create(const iString &cfile);
      void open(const iString &cfile, iString access = "r");
      void reopen(iString access = "r");

      void read(Blob &blob) const;
      void read(Buffer &rbuf);
      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 setFormat(Format format);
      void setLabelsAttached(bool attached);
      void setLabelSize(int labelBytes);
      void setPixelType(PixelType pixelType);
      void setVirtualBands(const QList<iString> &vbands);
      void setVirtualBands(const std::vector<std::string> &vbands);

      int getBandCount() const;
      double getBase() const;
      ByteOrder getByteOrder() const;
      Camera *getCamera();
      iString getFilename() const;
      Format getFormat() const;
      Histogram *getHistogram(const int &band = 1,
                               iString msg = "Gathering histogram");
      Histogram *getHistogram(const int &band, const double &validMin,
                               const double &validMax,
                               iString msg = "Gathering histogram");
      Pvl *getLabel() const;
      int getLabelSize(bool actual = false) const;
      int getLineCount() const;
      double getMultiplier() const;
      PixelType getPixelType() const;
      int getPhysicalBand(const int &virtualBand) const;
      Projection *getProjection();
      int getSampleCount() const;
      Statistics *getStatistics(const int &band = 1,
                                 iString msg = "Gathering statistics");
      Statistics *getStatistics(const int &band, const double &validMin,
                                 const double &validMax,
                                 iString msg = "Gathering statistics");

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

    private:
      void cleanUp(bool remove);
      QFile *getDataFile() const;
      void initialize();
      void openCheck();
      void reformatOldIsisLabel(const iString &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;

      iString *m_labelFilename;

      iString *m_dataFilename;

      iString *m_tempCube;

      iString *m_formatTemplateFile;

      bool m_attached;

      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