GoalStats

How a run arrived at the reference's final point, from its samples at or after the end.

Full docstring

- `final_error`: ``reference - measured`` at the last measured sample (a pose: the distance);
  NaN when the run has no sample at or after the reference's end.
- `settling_time`: seconds after the reference's end of the first sample from which
  ``|error| <= band`` for every later sample (0 if inside at the end and staying); NaN if the
  last sample is outside the band or there are no such samples. WHY NaN, not the end of the
  data: a run that never settled must not look like one that settled at its last sample.
- `overshoot`: how far the run went past the final value along the reference's net move
  (same unit as the signal), 0 if it never did; `overshoot_percent`: of that move's size
  (MATLAB ``stepinfo``'s convention), NaN when the reference does not move.
- `band` is the settling band used; `samples_after_end` how many samples it rests on.

Import

from robot_msgs.compare import GoalStats

ROS 2no ROS equivalent

Fields

Name	Type	Default
`final_error`	`float`	`required`
`settling_time`	`float`	`required`
`overshoot`	`float`	`required`
`overshoot_percent`	`float`	`required`
`band`	`float`	`required`
`samples_after_end`	`int`	`required`

Example

One instance from the package's own test catalog; the output is its real repr().

GoalStats(final_error=0.0886459943160588, settling_time=nan, overshoot=0.0886459943160588, overshoot_percent=3.0281693064513893, band=0.05, samples_after_end=1)

to_dict() as JSON

{
  "_type": "compare/GoalStats",
  "final_error": 0.0886459943160588,
  "settling_time": NaN,
  "overshoot": 0.0886459943160588,
  "overshoot_percent": 3.0281693064513893,
  "band": 0.05,
  "samples_after_end": 1
}