Collection of statistics for a scalar signal.
More...
#include <math/gzmath.hh>
Collection of statistics for a scalar signal.
gazebo::math::SignalStats::SignalStats 
( 
 ) 

gazebo::math::SignalStats::~SignalStats 
( 
 ) 

size_t gazebo::math::SignalStats::Count 
( 
 ) 
const 
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.
void gazebo::math::SignalStats::InsertData 
( 
const double 
_data  ) 

Add a new sample to the statistical measures.
 Parameters

[in]  _data  New signal data point. 
bool gazebo::math::SignalStats::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.
bool gazebo::math::SignalStats::InsertStatistics 
( 
const std::string & 
_names  ) 

Add multiple statistics.
 Parameters

[in]  _names  Commaseparated 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.
std::map<std::string, double> gazebo::math::SignalStats::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.
void gazebo::math::SignalStats::Reset 
( 
 ) 

Forget all previous data.
The documentation for this class was generated from the following file: