Class containing the motion measured by your motion source over one time interval, to be used by the positional tracking as a prior. More...
Functions | |
| Timestamp | start_timestamp (self) |
| Beginning of the time interval this motion was measured over. More... | |
| Timestamp | end_timestamp (self) |
| End of the time interval this motion was measured over. More... | |
| Transform | motion (self) |
| Motion of your motion source between start_timestamp and end_timestamp. More... | |
| POSE_AXIS | measured_axes (self) |
| Degrees of freedom that your motion source actually measures. More... | |
| npt.NDArray[float] | covariance (self) |
| Uncertainty of motion (NumPy array of 36 values), row-major 6x6, ordered [tx, ty, tz, rx, ry, rz]. More... | |
| bool | is_stationary (self) |
| Whether this sample reports that the camera did not move at all. More... | |
| Transform | sensor_transform (self) |
| Where your motion source is mounted, relative to the camera. More... | |
| float | rejection_threshold (self) |
| How far this motion is allowed to disagree with the images before it is discarded, as a multiple of the uncertainty given in covariance. More... | |
Class containing the motion measured by your motion source over one time interval, to be used by the positional tracking as a prior.
Use it to give wheel odometry, an external visual-inertial system or the difference between two consecutive GNSS fixes to the ZED SDK through Camera.ingest_motion_prior(). The motion prior constrains how far the camera is allowed to have moved between two images; the images still determine the final pose.
| Timestamp start_timestamp | ( | self | ) |
Beginning of the time interval this motion was measured over.
Set it to the end_timestamp of the RelativePoseData you ingested previously, so that consecutive samples follow each other without a gap. For your very first sample, set it to the instant your source started measuring that increment.
| Timestamp end_timestamp | ( | self | ) |
End of the time interval this motion was measured over.
It must use the same time reference as Camera.get_timestamp() with TIME_REFERENCE.IMAGE.
| Transform motion | ( | self | ) |
Motion of your motion source between start_timestamp and end_timestamp.
Give it exactly as your source measures it, along its own axes: the ZED SDK moves it into the camera frame using sensor_transform. Only the parts selected by measured_axes are read, the others can hold anything.
| POSE_AXIS measured_axes | ( | self | ) |
Degrees of freedom that your motion source actually measures.
Default: POSE_AXIS.NONE, so it must be set: a sample that declares no axis is rejected by Camera.ingest_motion_prior().
| npt.NDArray[float] covariance | ( | self | ) |
Uncertainty of motion (NumPy array of 36 values), row-major 6x6, ordered [tx, ty, tz, rx, ry, rz].
Only the rows and columns selected by measured_axes are read, which keeps the correlations between the measured axes, for example the coupling between forward motion and heading on a two-wheeled robot. The remaining entries can be left at 0.
The part that is read must be symmetric and describe a real uncertainty. Values too small to be physically achievable are raised to a minimum by the ZED SDK.
| bool is_stationary | ( | self | ) |
Whether this sample reports that the camera did not move at all.
Default: False
| Transform sensor_transform | ( | self | ) |
Where your motion source is mounted, relative to the camera.
Set the pose of the source (the wheel odometry frame, the external tracker, ...) in the camera frame: its translation is where the source sits, its rotation is how the axes it measures along are oriented. The ZED SDK then brings motion and covariance into the camera frame for you, so you fill them exactly as your source produces them.
Default: identity, meaning that the source already reports the motion of the camera itself, along the camera axes.
| float rejection_threshold | ( | self | ) |
How far this motion is allowed to disagree with the images before it is discarded, as a multiple of the uncertainty given in covariance.
Lower values trust the images more, higher values trust the motion prior more.
Default: 3.0