CorrelationMatrix.h

Go to the documentation of this file.

#ifndef CorrelationMatrix_h
#define CorrelationMatrix_h

#include "FileName.h"

#include <QDebug>
#include <QList>
#include <QMap>
#include <QString>
#include <QStringList>

#include <boost/numeric/ublas/matrix_sparse.hpp>

template <typename A, typename B> class QMap;
template <typename A> class QList;

namespace Isis {
  class FileName;
  class MosaicSceneWidget;
  class PvlObject;
  class SparseBlockColumnMatrix;


  class CorrelationMatrix {
    public:
      CorrelationMatrix();
      CorrelationMatrix(PvlObject storedMatrixData);
      CorrelationMatrix(const CorrelationMatrix &other);
      ~CorrelationMatrix();
      
      CorrelationMatrix &operator=(const CorrelationMatrix &other);

      void computeCorrelationMatrix();
      void retrieveVisibleElements(int x, int y);

      bool isValid();
      bool hasCovMat();
     //const bool hasCovMat() const;

      void setCorrelationFileName(FileName correlationFileName);
      void setCovarianceFileName(FileName covarianceFileName);
      void setImagesAndParameters(QMap<QString, QStringList> imagesAndParameters);

      SparseBlockColumnMatrix correlationMatrixFromFile(QDataStream inStream);
      //might need something called deleteLater(), called from MatrixTreeWidgetItem constructor.

      //if cov filename is null we need to ask the user to find it.

      FileName correlationFileName();
      FileName covarianceFileName();
      QMap<QString, QStringList> *imagesAndParameters();

      void retrieveWholeMatrix();
      void retrieveThreeVisibleBlocks();

      // Need these for range used to pick colors....
      QList<SparseBlockColumnMatrix> *visibleBlocks();

      PvlObject pvlObject();

      QDataStream &write(QDataStream &stream) const;
      QDataStream &read(QDataStream &stream);

    private:
      QMap<QString, QStringList> *m_imagesAndParameters;

      FileName *m_covarianceFileName;

      FileName *m_correlationFileName;

      QList<double> *m_diagonals;

      QList<SparseBlockColumnMatrix> *m_visibleBlocks;
  };
  // operators to read/write CorrelationMatrix to/from binary disk file
  QDataStream &operator<<(QDataStream &stream, const CorrelationMatrix &matrix);
  QDataStream &operator>>(QDataStream &stream, CorrelationMatrix &matrix);
};

Q_DECLARE_METATYPE(Isis::CorrelationMatrix);

#endif