regionOfInterest QML Value Type

This message is used to specify a region of interest within an image. More...

Properties

• doRectify : bool
• height : uint32_t
• width : uint32_t
• xOffset : uint32_t
• yOffset : uint32_t

Detailed Description

When used to specify the ROI setting of the camera when the image was taken, the height and width fields should either match the height and width fields for the associated image; or height = width = 0 indicates that the full resolution image was captured.

regionOfInterest is a structured value type usable in QML. It maps directly to the sensor_msgs::msg::RegionOfInterest ROS 2 message type.

Construct a regionOfInterest in QML by assigning a JavaScript object whose keys are its component properties, or by setting those properties individually.

See also RegionOfInterestPublisher and RegionOfInterestSubscriber.

Property Documentation

doRectify : bool

True if a distinct rectified ROI should be calculated from the "raw"

ROI in this message. Typically this should be False if the full image is captured (ROI not used), and True if a subwindow is captured (ROI used).

height : uint32_t

(0 if the ROI includes the top edge of the image)

width : uint32_t

xOffset : uint32_t

yOffset : uint32_t

(0 if the ROI includes the left edge of the image)