Isis Developer Reference
GaussianDistribution.h
Go to the documentation of this file.
1 #ifndef GaussianDistribution_h
2 #define GaussianDistribution_h
3 
8 /* SPDX-License-Identifier: CC0-1.0 */
9 
10 #include "Statistics.h"
11 #include "IException.h"
12 #include "Constants.h"
13 
14 namespace Isis {
38  public:
39  GaussianDistribution(const double mean = 0.0, const double standardDeviation = 1.0) ;
41 
42  double Probability(const double value);
43  double CumulativeDistribution(const double value);
44  double InverseCumulativeDistribution(const double percent);
45 
51  inline double Mean() const {
52  return p_mean;
53  };
54 
60  inline double StandardDeviation() const {
61  return p_stdev;
62  };
63 
64  private:
66  double p_mean;
68  double p_stdev;
69 
70  // functions used for computing the ICDF
71  double A(const double x);
72  double B(const double x);
73  double C(const double x);
74  double D(const double x);
75  };
76 };
77 
78 #endif
Isis::Statistics
This class is used to accumulate statistics on double arrays.
Definition: Statistics.h:94
Isis::GaussianDistribution::Probability
double Probability(const double value)
Computes and returns the probability of the specified value on the gaussian distribution.
Definition: GaussianDistribution.cpp:34
Isis::PI
const double PI
The mathematical constant PI.
Definition: Constants.h:40
Isis::GaussianDistribution::GaussianDistribution
GaussianDistribution(const double mean=0.0, const double standardDeviation=1.0)
Constructs a gaussian distribution object.
Definition: GaussianDistribution.cpp:20
Isis::GaussianDistribution::StandardDeviation
double StandardDeviation() const
Returns the standard deviation.
Definition: GaussianDistribution.h:60
GaussianDistribution.h
_FILEINFO_
#define _FILEINFO_
Macro for the filename and line number.
Definition: IException.h:24
Isis::GaussianDistribution::CumulativeDistribution
double CumulativeDistribution(const double value)
Computes and returns the cumulative distribution up to the specified value on the gaussian distributi...
Definition: GaussianDistribution.cpp:48
Isis::GaussianDistribution
gaussian distribution class
Definition: GaussianDistribution.h:37
Isis::IException
Isis exception class.
Definition: IException.h:91
Statistics.h
IException.h
std
Namespace for the standard library.
Isis::GaussianDistribution::Mean
double Mean() const
Returns the mean.
Definition: GaussianDistribution.h:51
Isis::GaussianDistribution::InverseCumulativeDistribution
double InverseCumulativeDistribution(const double percent)
Computes and returns the inverse cumulative distribution evaluated at the specified percentage value ...
Definition: GaussianDistribution.cpp:90
Constants.h
Isis::GaussianDistribution::~GaussianDistribution
~GaussianDistribution()
Definition: GaussianDistribution.h:40
Isis
This is free and unencumbered software released into the public domain.
Definition: Apollo.h:16
Message.h