Histogram.h

Go to the documentation of this file.

#ifndef Histogram_h
#define Histogram_h

#include "Cube.h"
#include "Constants.h"
#include "IException.h"
#include "Progress.h"
#include "SpecialPixel.h"
#include "Statistics.h"

namespace Isis {
  class ControlNet;
  class ControlMeasure;
  class Histogram : public Statistics {
    public:
      Histogram(double minimum, double maximum,
                int bins = 1024);
      Histogram(Cube &cube, int statsBand, Progress *progress = NULL,
                double startSample = 1.0, double startLine = 1.0,
                double endSample = Null, double endLine = Null, int bins = 0,
                bool addCubeData = false);

      //constuctors that use ControlNetworks to build histograms of ControlMeasure data
      Histogram(ControlNet &net, double(ControlMeasure::*statFunc)() const, int bins);
      Histogram(ControlNet &net, double(ControlMeasure::*statFunc)() const, double binWidth);

      ~Histogram();

      void SetBins(const int bins);

      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);

      double Median() const;
      double Mode() const;
      double Percent(const double percent) const;
      double Skew() const;

      BigInt BinCount(const int index) const;
      void BinRange(const int index, double &low, double &high) const;
      double BinMiddle(const int index) const;
      double BinSize() const;
      int Bins() const;
      BigInt MaxBinCount() const;

      double BinRangeStart() const {
        return p_binRangeStart;
      }
      double BinRangeEnd() const {
        return p_binRangeEnd;
      }
      //void SetBinRange(double binStart, double binEnd);
      void SetValidRange(const double minimum = Isis::ValidMinimum,
                                       const double maximum = Isis::ValidMaximum);

    private:
      void InitializeFromCube(Cube &cube, int statsBand, Progress *progress,
          int nbins = 0, double startSample = Null, double startLine = Null,
          double endSample = Null, double endLine = Null);

      void addMeasureDataFromNet(ControlNet &net, double(ControlMeasure::*statFunc)() const);
      void rangesFromNet(ControlNet &net, double(ControlMeasure::*statFunc)() const);

      std::vector<BigInt> p_bins;
      double p_binRangeStart, p_binRangeEnd;
  };
};

#endif