Isis 3.0 Programmer Reference
Back | Home
MultivariateStatistics.h
Go to the documentation of this file.
1 
24 #ifndef MultivariateStatistics_h
25 #define MultivariateStatistics_h
26 
27 #include "Constants.h"
28 #include "PvlObject.h"
29 #include "SpecialPixel.h"
30 #include "Statistics.h"
31 
32 namespace Isis {
33 
72  public:
74  MultivariateStatistics(const PvlObject &inStats);
76 
77  void Reset();
78  void AddData(const double *x, const double *y,
79  const unsigned int count);
80  void AddData(double x, double y, unsigned int count = 1);
81  void RemoveData(const double *x, const double *y,
82  const unsigned int count);
83 
84  Isis::Statistics X() const;
85  Isis::Statistics Y() const;
86  double SumXY() const;
87  double Covariance() const;
88  double Correlation() const;
89 
90  void LinearRegression(double &a, double &b) const;
91 
92  BigInt ValidPixels() const;
93  BigInt InvalidPixels() const;
94  BigInt TotalPixels() const;
95 
96  PvlObject toPvl(QString name = "MultivariateStatistics") const;
97 
98  private:
99 
100  void fromPvl(const PvlObject &inStats);
101 
106 
108  double p_sumxy;
124  };
125 };
126 
127 #endif
BigInt p_invalidPixels
The number of invalid (ignored) pixels.
double p_sumxy
The sum of x and y.
double Correlation() const
Computes and returns the coefficient of correlation (between -1.0 and 1.0) of the two data sets...
~MultivariateStatistics()
Destructs a MultivariateStatistics object.
MultivariateStatistics()
Constructs a Multivariate Statistics object with accumulators and counters set to zero...
void LinearRegression(double &a, double &b) const
Fits a line through the data.
double SumXY() const
Returns the sum of x*y for all data given through the AddData method.
Isis::Statistics p_x
A Statistics object holding x data.
This class is used to accumulate statistics on double arrays.
Definition: Statistics.h:109
Container of multivariate statistics.
BigInt p_totalPixels
The total number of pixels (invalid and valid).
Isis::Statistics p_y
A Statistics object holding y data.
double Covariance() const
Computes and returns the covariance between the two data sets If there are no valid data (pixels) the...
PvlObject toPvl(QString name="MultivariateStatistics") const
Serializes a multivariate statistics object as a PvlObject.
BigInt InvalidPixels() const
Returns the number of invalid pixels encountered.
BigInt p_validPixels
The number of valid (computed) pixels.
Isis::Statistics X() const
Returns a Stats object for all of the X data fed through the AddData method.
BigInt TotalPixels() const
Returns the total number of pixels processed.
Isis::Statistics Y() const
Returns a Stats object for all of the Y data fed through the AddData method.
void RemoveData(const double *x, const double *y, const unsigned int count)
Remove an array of doubles from the accumulators and counters.
void Reset()
Resets all accumulators to zero.
void fromPvl(const PvlObject &inStats)
Unserializes a multivariate statistics object from a PvlObject.
void AddData(const double *x, const double *y, const unsigned int count)
Add two arrays of doubles to the accumulators and counters.
BigInt ValidPixels() const
Returns the number of valid pixels processed.
Contains Pvl Groups and Pvl Objects.
Definition: PvlObject.h:74

U.S. Department of the Interior | U.S. Geological Survey
ISIS | Privacy & Disclaimers | Astrogeology Research Program
To contact us, please post comments and questions on the ISIS Support Center
File Modified: 07/12/2023 23:24:18