SignalRootMeanSquare Class Reference
Computing the square root of the mean squared value of a discretely sampled signal. More...
#include <gz/math/SignalStats.hh>
Public Member Functions | |
| virtual void | InsertData (const double _data) override |
| Add a new sample to the statistical measure. | |
| virtual std::string | ShortName () const override |
| Get a short version of the name of this statistical measure. | |
| virtual double | Value () const override |
| Get the current value of the statistical measure. | |
 Public Member Functions inherited from SignalStatistic | |
| SignalStatistic () | |
| Constructor. | |
| SignalStatistic (const SignalStatistic &_ss)=default | |
| Copy constructor. | |
| SignalStatistic (SignalStatistic &&_ss)=default | |
| Move constructor. | |
| virtual | ~SignalStatistic ()=default |
| Destructor. | |
| virtual size_t | Count () const |
| Get number of data points in measurement. | |
| SignalStatistic & | operator= (const SignalStatistic &_s)=default |
| Assignment operator. | |
| SignalStatistic & | operator= (SignalStatistic &&_s)=default |
| Move assignment operator. | |
| virtual void | Reset () |
| Forget all previous data. | |
Additional Inherited Members | |
| Protected Attributes inherited from SignalStatistic | |
| ::gz::utils::ImplPtr< Implementation > | dataPtr |
Detailed Description
Computing the square root of the mean squared value of a discretely sampled signal.
Member Function Documentation
◆ InsertData()
Add a new sample to the statistical measure.
- Parameters
-
[in] _data New signal data point.
Implements SignalStatistic.
◆ ShortName()
|
overridevirtual |
Get a short version of the name of this statistical measure.
- Returns
- "rms"
Implements SignalStatistic.
◆ Value()
Get the current value of the statistical measure.
- Returns
- Current value of the statistical measure.
Implements SignalStatistic.
The documentation for this class was generated from the following file: