Collection of statistics for a Vector3 signal.
More...
#include <ignition/math/Vector3Stats.hh>
Collection of statistics for a Vector3 signal.
§ Vector3Stats()
ignition::math::Vector3Stats::Vector3Stats |
( |
| ) |
|
§ ~Vector3Stats()
ignition::math::Vector3Stats::~Vector3Stats |
( |
| ) |
|
§ InsertData()
void ignition::math::Vector3Stats::InsertData |
( |
const Vector3d & |
_data | ) |
|
Add a new sample to the statistical measures.
- Parameters
-
[in] | _data | New signal data point. |
§ InsertStatistic()
bool ignition::math::Vector3Stats::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 ignition::math::Vector3Stats::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.
§ Mag() [1/2]
const SignalStats& ignition::math::Vector3Stats::Mag |
( |
| ) |
const |
Get statistics for magnitude component of signal.
- Returns
- Statistics for magnitude component of signal.
§ Mag() [2/2]
Get mutable reference to statistics for magnitude of signal.
- Returns
- Statistics for magnitude of signal.
§ Reset()
void ignition::math::Vector3Stats::Reset |
( |
| ) |
|
Forget all previous data.
§ X() [1/2]
const SignalStats& ignition::math::Vector3Stats::X |
( |
| ) |
const |
Get statistics for x component of signal.
- Returns
- Statistics for x component of signal.
§ X() [2/2]
Get mutable reference to statistics for x component of signal.
- Returns
- Statistics for x component of signal.
§ Y() [1/2]
const SignalStats& ignition::math::Vector3Stats::Y |
( |
| ) |
const |
Get statistics for y component of signal.
- Returns
- Statistics for y component of signal.
§ Y() [2/2]
Get mutable reference to statistics for y component of signal.
- Returns
- Statistics for y component of signal.
§ Z() [1/2]
const SignalStats& ignition::math::Vector3Stats::Z |
( |
| ) |
const |
Get statistics for z component of signal.
- Returns
- Statistics for z component of signal.
§ Z() [2/2]
Get mutable reference to statistics for z component of signal.
- Returns
- Statistics for z component of signal.
§ dataPtr
The documentation for this class was generated from the following file: