Detailed Description
template<class T>
class gnsstk::StatsFilterBase< T >
Build a wrapper for these Stats classes that allows interchangeability in a statistical 'filter' designed for a times series of (x,y) data. The pure virtual class StatsFilterBase will define the interface.
Definition at line 129 of file WindowFilter.hpp.
#include <WindowFilter.hpp>
Public Member Functions | |
| virtual void | Add (const T &x, const T &y)=0 |
| Add data to the statistics; in 1-sample stats the x is ignored. More... | |
| virtual std::string | asString () const =0 |
| return the stats as a single string More... | |
| virtual T | Average () const =0 |
| return the average; in 2-sample stats this is AverageY() More... | |
| virtual T | Evaluate (T x) const =0 |
| return the predicted Y at the given X; in 1-sample stats this is Average() More... | |
| virtual T | Intercept () const =0 |
| virtual unsigned int | N () const =0 |
| return the sample size More... | |
| virtual void | Reset ()=0 |
| reset, i.e. ignore earlier data and restart sampling More... | |
| virtual T | Slope () const =0 |
| StatsFilterBase () | |
| constructor More... | |
| virtual T | StdDev () const =0 |
| return computed standard deviation, in 2-sample stats this is SigmaYX() More... | |
| virtual void | Subtract (const T &x, const T &y)=0 |
| Subtract data from the statistics; in 1-sample stats the x is ignored. More... | |
| virtual T | Variance () const =0 |
| return computed variance, in 2-sample stats this is VarianceYX() More... | |
Constructor & Destructor Documentation
◆ StatsFilterBase()
|
inline |
constructor
Definition at line 133 of file WindowFilter.hpp.
Member Function Documentation
◆ Add()
|
pure virtual |
Add data to the statistics; in 1-sample stats the x is ignored.
Implemented in gnsstk::TwoSampleStatsFilter< T >, and gnsstk::OneSampleStatsFilter< T >.
◆ asString()
|
pure virtual |
return the stats as a single string
Implemented in gnsstk::TwoSampleStatsFilter< T >, and gnsstk::OneSampleStatsFilter< T >.
◆ Average()
|
pure virtual |
return the average; in 2-sample stats this is AverageY()
Implemented in gnsstk::TwoSampleStatsFilter< T >, and gnsstk::OneSampleStatsFilter< T >.
◆ Evaluate()
|
pure virtual |
return the predicted Y at the given X; in 1-sample stats this is Average()
Implemented in gnsstk::TwoSampleStatsFilter< T >, and gnsstk::OneSampleStatsFilter< T >.
◆ Intercept()
|
pure virtual |
return the intercept of the best-fit line Y=slope*X+intercept; in 1-sample stats this is Average()
Implemented in gnsstk::TwoSampleStatsFilter< T >, and gnsstk::OneSampleStatsFilter< T >.
◆ N()
|
pure virtual |
return the sample size
Implemented in gnsstk::TwoSampleStatsFilter< T >, and gnsstk::OneSampleStatsFilter< T >.
◆ Reset()
|
pure virtual |
reset, i.e. ignore earlier data and restart sampling
Implemented in gnsstk::TwoSampleStatsFilter< T >, and gnsstk::OneSampleStatsFilter< T >.
◆ Slope()
|
pure virtual |
return the slope of the best-fit line Y=slope*X+intercept; in 1-sample stats this is 0.0
Implemented in gnsstk::TwoSampleStatsFilter< T >, and gnsstk::OneSampleStatsFilter< T >.
◆ StdDev()
|
pure virtual |
return computed standard deviation, in 2-sample stats this is SigmaYX()
Implemented in gnsstk::TwoSampleStatsFilter< T >, and gnsstk::OneSampleStatsFilter< T >.
◆ Subtract()
|
pure virtual |
Subtract data from the statistics; in 1-sample stats the x is ignored.
Implemented in gnsstk::TwoSampleStatsFilter< T >, and gnsstk::OneSampleStatsFilter< T >.
◆ Variance()
|
pure virtual |
return computed variance, in 2-sample stats this is VarianceYX()
Implemented in gnsstk::TwoSampleStatsFilter< T >, and gnsstk::OneSampleStatsFilter< T >.
The documentation for this class was generated from the following file: