On this page

RegionOfInterestPublisher QML Type

Publishes sensor_msgs::msg::RegionOfInterest messages — This message is used to specify a region of interest within an image. More...

Import Statement: import QtRos2.SensorMsgs
Inherits:

PublisherBase

Status: Experimental Extension

Properties

Methods

  • void publish(regionOfInterest msg)

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.

RegionOfInterestPublisher publishes regionOfInterest values to a ROS 2 topic. Set the topic and node properties, then call publish() to send messages.

See also RegionOfInterestSubscriber and regionOfInterest.

Property Documentation

doRectify : bool

The doRectify field value included in the next publish. Setting this property emits doRectifyChanged and, when autoPublish is true, requests a publish at the end of the current event-loop iteration.

height : uint32_t

The height field value included in the next publish. Setting this property emits heightChanged and, when autoPublish is true, requests a publish at the end of the current event-loop iteration.

width : uint32_t

The width field value included in the next publish. Setting this property emits widthChanged and, when autoPublish is true, requests a publish at the end of the current event-loop iteration.

xOffset : uint32_t

The xOffset field value included in the next publish. Setting this property emits xOffsetChanged and, when autoPublish is true, requests a publish at the end of the current event-loop iteration.

yOffset : uint32_t

The yOffset field value included in the next publish. Setting this property emits yOffsetChanged and, when autoPublish is true, requests a publish at the end of the current event-loop iteration.

Method Documentation

void publish(regionOfInterest msg)

Publishes regionOfInterest msg to the ROS 2 topic set by the topic property. Does nothing if the publisher is not connected.

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.