SignalStats Class Reference
Collection of statistics for a scalar signal. More...
#include <ignition/math/SignalStats.hh>
Public Member Functions  
SignalStats ()  
Constructor. More...  
SignalStats (const SignalStats &_ss)  
Copy constructor. More...  
~SignalStats ()  
Destructor. More...  
size_t  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. More...  
void  InsertData (const double _data) 
Add a new sample to the statistical measures. More...  
bool  InsertStatistic (const std::string &_name) 
Add a new type of statistic. More...  
bool  InsertStatistics (const std::string &_names) 
Add multiple statistics. More...  
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. More...  
SignalStats &  operator= (const SignalStats &_s) 
Assignment operator. More...  
void  Reset () 
Forget all previous data. More...  
Detailed Description
Collection of statistics for a scalar signal.
Constructor & Destructor Documentation
◆ SignalStats() [1/2]
SignalStats  (  ) 
Constructor.
◆ ~SignalStats()
~SignalStats  (  ) 
Destructor.
◆ SignalStats() [2/2]
SignalStats  (  const SignalStats &  _ss  ) 
Copy constructor.
 Parameters

[in] _ss SignalStats to copy
Member Function Documentation
◆ Count()
size_t 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.
◆ 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 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.
◆ 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 SignalStats &  _s  ) 
◆ Reset()
void Reset  (  ) 
Forget all previous data.
The documentation for this class was generated from the following file: