Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sensor_msgs/CompressedImage: updated description of format field #231

Merged
merged 1 commit into from
Nov 17, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions sensor_msgs/msg/CompressedImage.msg
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,34 @@ std_msgs/Header header # Header timestamp should be acquisition time of image
# +z should point into to plane of the image

string format # Specifies the format of the data
# Acceptable values:
# jpeg, png, tiff
# Acceptable values differ by the image transport used:
# - compressed_image_transport:
# ORIG_PIXFMT; CODEC compressed [COMPRESSED_PIXFMT]
# where:
# - ORIG_PIXFMT is pixel format of the raw image, i.e.
# the content of sensor_msgs/Image/encoding with
# values from include/sensor_msgs/image_encodings.h
# - CODEC is one of [jpeg, png, tiff]
# - COMPRESSED_PIXFMT is only appended for color images
# and is the pixel format used by the compression
# algorithm. Valid values for jpeg encoding are:
# [bgr8, rgb8]. Valid values for png encoding are:
# [bgr8, rgb8, bgr16, rgb16].
# If the field is empty or does not correspond to the
# above pattern, the image is treated as bgr8 or mono8
# jpeg image (depending on the number of channels).
# - compressed_depth_image_transport:
# ORIG_PIXFMT; compressedDepth CODEC
# where:
# - ORIG_PIXFMT is pixel format of the raw image, i.e.
# the content of sensor_msgs/Image/encoding with
# values from include/sensor_msgs/image_encodings.h
# It is usually one of [16UC1, 32FC1].
# - CODEC is one of [png, rvl]
# If the field is empty or does not correspond to the
# above pattern, the image is treated as png image.
# - Other image transports can store whatever values they
# need for successful decoding of the image. Refer to
# documentation of the other transports for details.

uint8[] data # Compressed image buffer