Detailed Description
template<class T>
class gnsstk::OneSampleStatsFilter< T >
A StatsFilter class for one-sample statistics that inherits StatsFilterBase.
Definition at line 177 of file WindowFilter.hpp.
#include <WindowFilter.hpp>
Public Member Functions | |
| void | Add (const T &x, const T &y) |
| Add data to the statistics; in 1-sample stats the x is ignored. More... | |
| std::string | asString () const |
| return the stats as a single string More... | |
| T | Average () const |
| return the average More... | |
| T | Evaluate (T x) const |
| T | Intercept () const |
| unsigned int | N () const |
| return the sample size More... | |
| OneSampleStatsFilter () | |
| constructor More... | |
| void | Reset () |
| reset, i.e. ignore earlier data and restart sampling More... | |
| T | Slope () const |
| T | StdDev () const |
| return computed standard deviation More... | |
| void | Subtract (const T &x, const T &y) |
| Subtract data from the statistics; in 1-sample stats the x is ignored. More... | |
| T | Variance () const |
| return computed variance More... | |
 Public Member Functions inherited from gnsstk::StatsFilterBase< T > | |
| StatsFilterBase () | |
| constructor More... | |
Private Attributes | |
| gnsstk::Stats< T > | S |
Constructor & Destructor Documentation
◆ OneSampleStatsFilter()
|
inline |
constructor
Definition at line 181 of file WindowFilter.hpp.
Member Function Documentation
◆ Add()
|
inlinevirtual |
Add data to the statistics; in 1-sample stats the x is ignored.
Implements gnsstk::StatsFilterBase< T >.
Definition at line 190 of file WindowFilter.hpp.
◆ asString()
|
inlinevirtual |
return the stats as a single string
Implements gnsstk::StatsFilterBase< T >.
Definition at line 223 of file WindowFilter.hpp.
◆ Average()
|
inlinevirtual |
return the average
Implements gnsstk::StatsFilterBase< T >.
Definition at line 202 of file WindowFilter.hpp.
◆ Evaluate()
|
inlinevirtual |
return the predicted Y at the given X; in 1-sample stats this is Average() and x is ignored
Implements gnsstk::StatsFilterBase< T >.
Definition at line 208 of file WindowFilter.hpp.
◆ Intercept()
|
inlinevirtual |
return the intercept of the best-fit line Y=slope*X+intercept; in 1-sample stats this is Average()
Implements gnsstk::StatsFilterBase< T >.
Definition at line 220 of file WindowFilter.hpp.
◆ N()
|
inlinevirtual |
return the sample size
Implements gnsstk::StatsFilterBase< T >.
Definition at line 187 of file WindowFilter.hpp.
◆ Reset()
|
inlinevirtual |
reset, i.e. ignore earlier data and restart sampling
Implements gnsstk::StatsFilterBase< T >.
Definition at line 184 of file WindowFilter.hpp.
◆ Slope()
|
inlinevirtual |
return the slope of the best-fit line Y=slope*X+intercept; in 1-sample stats this is 0.0
Implements gnsstk::StatsFilterBase< T >.
Definition at line 214 of file WindowFilter.hpp.
◆ StdDev()
|
inlinevirtual |
return computed standard deviation
Implements gnsstk::StatsFilterBase< T >.
Definition at line 196 of file WindowFilter.hpp.
◆ Subtract()
|
inlinevirtual |
Subtract data from the statistics; in 1-sample stats the x is ignored.
Implements gnsstk::StatsFilterBase< T >.
Definition at line 193 of file WindowFilter.hpp.
◆ Variance()
|
inlinevirtual |
return computed variance
Implements gnsstk::StatsFilterBase< T >.
Definition at line 199 of file WindowFilter.hpp.
Member Data Documentation
◆ S
|
private |
Definition at line 226 of file WindowFilter.hpp.
The documentation for this class was generated from the following file: