Collection of statistics for a scalar signal.
More...
#include <math/gzmath.hh>
|
std::unique_ptr< SignalStatsPrivate > | dataPtr |
| Pointer to private data. More...
|
|
Collection of statistics for a scalar signal.
◆ SignalStats() [1/3]
Constructor.
- Deprecated:
- See ignition::math::SignalStats
◆ SignalStats() [2/3]
Ignition math copy constructor.
- Parameters
-
◆ ~SignalStats()
◆ SignalStats() [3/3]
Copy constructor.
- Parameters
-
- Deprecated:
- See ignition::math::SignalStats
◆ Count()
Get number of data points in first statistic.
Technically you can have different numbers of data points in each statistic if you call InsertStatistic after InsertData, but this is not a recommended use case.
- Returns
- Number of data points in first statistic.
◆ Ign()
ignition::math::SignalStats Ign |
( |
| ) |
const |
Get this object as an ignition::math::SignalStats.
- Returns
- This as an ignition math object.
◆ InsertData()
void InsertData |
( |
const double |
_data | ) |
|
Add a new sample to the statistical measures.
- Parameters
-
[in] | _data | New signal data point. |
◆ InsertStatistic()
bool InsertStatistic |
( |
const std::string & |
_name | ) |
|
Add a new type of statistic.
- Parameters
-
[in] | _name | Short name of new statistic. Valid values include: "maxAbs" "mean" "rms" |
- Returns
- True if statistic was successfully added, false if name was not recognized or had already been inserted.
◆ InsertStatistics()
bool InsertStatistics |
( |
const std::string & |
_names | ) |
|
Add multiple statistics.
- Parameters
-
[in] | _names | Comma-separated list of new statistics. For example, all statistics could be added with: "maxAbs,mean,rms" |
- Returns
- True if all statistics were successfully added, false if any names were not recognized or had already been inserted.
◆ Map()
std::map<std::string, double> Map |
( |
| ) |
const |
Get the current values of each statistical measure, stored in a map using the short name as the key.
- Returns
- Map with short name of each statistic as key and value of statistic as the value.
◆ operator=()
SignalStats& operator= |
( |
const ignition::math::SignalStats & |
_s | ) |
|
Assignment operator for ignition math.
- Parameters
-
- Returns
- Reference to this
◆ Reset()
Forget all previous data.
◆ dataPtr
std::unique_ptr<SignalStatsPrivate> dataPtr |
|
protected |
The documentation for this class was generated from the following file: