Skip to content

ROSBag: parse the RealSense image footer instead of guessing it - #154

Open
TianHengZhuang wants to merge 1 commit into
petercorke:mainfrom
TianHengZhuang:fix/realsense-image-footer
Open

TianHengZhuang wants to merge 1 commit into
petercorke:mainfrom
TianHengZhuang:fix/realsense-image-footer

Conversation

@TianHengZhuang

Copy link
Copy Markdown

Problem

RealSense SDK bags append four extra bytes to every image message: a little-endian float32 holding the depth scale (0.001 for 16UC1 depth). The reader currently strips four bytes from every connection as soon as one realsense_msgs connection is present, so the value is discarded instead of being exposed, and recordings whose messages are self-contained (for example Intel's published single_depth_color_640x480.bag) lose the last four bytes of every image.

Change

  • sensor_msgs Image and CompressedImage are self-describing, so the payload end is computed from the field layout and only the bytes past that boundary are treated as a footer.
  • The footer is unpacked as a little-endian float and attached to the yielded Image as depth_units.
  • Trim amounts are probed in the order 0, 4, 8 with the untrimmed buffer first, so self-contained messages are never truncated. rosbags SerdeError is retried the same way as AssertionError.
  • Connections that are not images fall back to the untrimmed buffer when a trailer was inferred from another connection.

CDR encoded messages (ROS 2 wire format inside a ROS 1 container) use the same approach with CDR alignment.

Tests

tests/create_ros_fixture.py now also writes test_ros1_realsense.bag (four byte footer on every image, 0.001 on the depth stream) and test_ros1_realsense_notrailer.bag (same topics, no footer).

TestRosBagRealSense covers topic detection, decoding of both streams, depth_units == 0.001 on depth, 0.0 on colour, and the absence of the attribute for self-contained recordings.

The rosbag tests need the ros extra and the generated fixtures. I checked the decode path of both new bags and of the existing ROS 1 and ROS 2 fixtures with rosbags directly; the full suite runs in CI.

RealSense SDK bags append a 4-byte little-endian float to every image
message, holding the depth scale.  The reader now derives the payload
boundary from the sensor_msgs layout, decodes only the message bytes and
exposes the footer value as Image.depth_units.  Recordings of the same
topics without a footer keep all their pixel data.

Adds RealSense-style ROS 1 fixtures, generated by create_ros_fixture.py,
covering both trailed and self-contained messages.

Closes petercorke#151
@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 28 complexity · 2 duplication

Metric Results
Complexity 28
Duplication 2

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant