Statistics.h

Go to the documentation of this file.

#ifndef Statistics_h
#define Statistics_h
 
/* SPDX-License-Identifier: CC0-1.0 */
 
#include <QObject>
#include <QString>
 
#include "Constants.h"
#include "PvlGroup.h"
#include "SpecialPixel.h"
#include "XmlStackedHandler.h"
 
class QDataStream;
class QUuid;
class QXmlStreamWriter;
 
namespace Isis {
  class Project;// ??? does xml stuff need project???
  class XmlStackedHandlerReader;
  class Statistics : public QObject {
    Q_OBJECT
    public:
      Statistics(QObject *parent = 0);
      Statistics(Project *project, XmlStackedHandlerReader *xmlReader, QObject *parent = 0); 
      Statistics(const PvlGroup &inStats, QObject *parent = 0);
      // TODO: does xml read/write stuff need Project input???
      Statistics(const Statistics &other);
      virtual ~Statistics();
      Statistics &operator=(const Statistics &other);
 
      void Reset();
 
      void AddData(const double *data, const unsigned int count);
      void AddData(const double data);
 
      void RemoveData(const double *data, const unsigned int count);
      void RemoveData(const double data);
 
      void SetValidRange(const double minimum = Isis::ValidMinimum,
                         const double maximum = Isis::ValidMaximum);
 
      double ValidMinimum() const;
      double ValidMaximum() const;
      bool InRange(const double value);
      bool AboveRange(const double value);
      bool BelowRange(const double value);
 
      double Average() const;
      double StandardDeviation() const;
      double Variance() const;
      double Sum() const;
      double SumSquare() const;
      double Rms() const;
 
      double Minimum() const;
      double Maximum() const;
      double ChebyshevMinimum(const double percent = 99.5) const;
      double ChebyshevMaximum(const double percent = 99.5) const;
      double BestMinimum(const double percent = 99.5) const;
      double BestMaximum(const double percent = 99.5) const;
      double ZScore(const double value) const;
 
      BigInt TotalPixels() const;
      BigInt ValidPixels() const;
      BigInt OverRangePixels() const;
      BigInt UnderRangePixels() const;
      BigInt NullPixels() const;
      BigInt LisPixels() const;
      BigInt LrsPixels() const;
      BigInt HisPixels() const;
      BigInt HrsPixels() const;
      BigInt OutOfRangePixels() const;
      bool RemovedData() const;
 
      PvlGroup toPvl(QString name = "Statistics") const;
 
      void save(QXmlStreamWriter &stream, const Project *project) const;
      // TODO: does xml stuff need project???
    
      QDataStream &write(QDataStream &stream) const;
      QDataStream &read(QDataStream &stream);
 
    private:
 
      void fromPvl(const PvlGroup &inStats);
 
      class XmlHandler : public XmlStackedHandler {
        public:
          XmlHandler(Statistics *statistics, Project *project);
          // TODO: does xml stuff need project???
          ~XmlHandler();
   
          virtual bool startElement(const QString &namespaceURI, const QString &localName,
                                    const QString &qName, const QXmlAttributes &atts);
          virtual bool characters(const QString &ch);
          virtual bool endElement(const QString &namespaceURI, const QString &localName,
                                    const QString &qName);
   
        private:
          Q_DISABLE_COPY(XmlHandler);
   
          Statistics *m_xmlHandlerStatistics;
          Project *m_xmlHandlerProject;
          // TODO: does xml stuff need project???
          QString m_xmlHandlerCharacters;
      };
 
//      QUuid *m_id; /**< A unique ID for this object (useful for others to reference
//                        this object when saving to disk).*/
      double m_sum;              
      double m_sumsum;           
      double m_minimum;          
      double m_maximum;          
      double m_validMinimum;     
      double m_validMaximum;     
      BigInt m_totalPixels;      
      BigInt m_validPixels;      
      BigInt m_nullPixels;       
      BigInt m_lrsPixels;        
      BigInt m_lisPixels;        
      BigInt m_hrsPixels;        
      BigInt m_hisPixels;        
      BigInt m_underRangePixels; 
      BigInt m_overRangePixels;  
      bool   m_removedData;      
  };
 
  // operators to read/write Statistics to/from binary data
  QDataStream &operator<<(QDataStream &stream, const Statistics &statistics);
  QDataStream &operator>>(QDataStream &stream, Statistics &statistics);
 
} // end namespace isis
 
#endif