robot_msgs

TimeOffsetEstimate

An estimated time_offset_s and what it bought.

Full docstring
`offset_s` has `align`'s sign (how late the measured clock runs), so
``compare(reference, measured, time_offset_s=estimate.offset_s)`` is the shifted comparison.
`rms_before` / `rms_after` are the RMS of the position error at offset 0 and at the estimate
(over every position-error element), so a small gain says the offset was not the problem.
`max_offset_s` is the search range the estimate was limited to.
Import
from robot_msgs.compare import TimeOffsetEstimate
ROS 2no ROS equivalent

Fields

NameTypeDefault
offset_sfloatrequired
rms_beforefloatrequired
rms_afterfloatrequired
max_offset_sfloatrequired

Example

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

TimeOffsetEstimate(offset_s=2.6090336920311634e-07, rms_before=0.11062183061741973, rms_after=0.09918472798836632, max_offset_s=0.25)
to_dict() as JSON
{
  "_type": "compare/TimeOffsetEstimate",
  "offset_s": 2.6090336920311634e-07,
  "rms_before": 0.11062183061741973,
  "rms_after": 0.09918472798836632,
  "max_offset_s": 0.25
}

Long arrays are cut after 16 values and say so with “…”.

Functions

Constructors

Classmethods and staticmethods: ways to build one.

from_dict

from Msg
from_dict(data: Mapping[str, Any]) -> M

No docstring.

Methods

Return new values; messages are never mutated.

replace

from Msg
replace(**changes: Any) -> M

A copy with some fields changed. Validation runs again.

to_dict

from Msg
to_dict() -> dict[str, Any]

JSON-safe dict with a "_type" key; arrays keep their dtype and shape.

No other type refers to it, and it refers to none.

robot_msgs 0.2.0 @ 22ec67fGitHub · MIT license · generated from the package, not written per type