Statistics.h

Go to the documentation of this file.

#ifndef Statistics_h
#define Statistics_h

#include "SpecialPixel.h"
#include "Constants.h"

namespace Isis {
  class Statistics {
    public:
      Statistics();
      ~Statistics();

      void Reset();
      void AddData(const double *data, const unsigned int count);
      inline void AddData(const double data) {
        p_totalPixels++;
        if(Isis::IsValidPixel(data) && InRange(data)) {
          p_sum += data;
          p_sumsum += data * data;
          if(data < p_minimum) p_minimum = data;
          if(data > p_maximum) p_maximum = data;
          p_validPixels++;
        }
        else if(Isis::IsNullPixel(data)) {
          p_nullPixels++;
        }
        else if(Isis::IsHisPixel(data)) {
          p_hisPixels++;
        }
        else if(Isis::IsHrsPixel(data)) {
          p_hrsPixels++;
        }
        else if(Isis::IsLisPixel(data)) {
          p_lisPixels++;
        }
        else if(Isis::IsLrsPixel(data)) {
          p_lrsPixels++;
        }
        else if(AboveRange(data)) {
          p_overRangePixels++;
        }
        else {
          p_underRangePixels++;
        }
      }

      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 {
        return p_validMinimum;
      }
      double ValidMaximum() const {
        return p_validMaximum;
      }
      bool InRange(const double value) {
        return (value >= p_validMinimum && value <= p_validMaximum);
      }
      bool AboveRange(const double value) {
        return (value > p_validMaximum);
      }
      bool BelowRange(const double value) {
        return (value < p_validMinimum);
      }

      double Average() const;
      double StandardDeviation() const;
      double Variance() 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;


      double Sum() const {
        return p_sum;
      };

      double SumSquare() const {
        return p_sumsum;
      };

    private:
      double p_sum;           
      double p_sumsum;        
      double p_minimum;       
      double p_maximum;       
      double p_validMinimum;  
      double p_validMaximum;  
      BigInt p_totalPixels;   
      BigInt p_validPixels;   
      BigInt p_nullPixels;    
      BigInt p_lrsPixels;     
      BigInt p_lisPixels;     
      BigInt p_hrsPixels;     
      BigInt p_hisPixels;     
      BigInt p_underRangePixels; 
      BigInt p_overRangePixels; 
      bool   p_removedData;   
  };
} // end namespace isis

#endif