Auterion App SDK
Auterion SDK is a library that can be used by AuterionOS apps to communicate with the system.
Loading...
Searching...
No Matches
auterion::DetectionProviderOptions Struct Reference

Configures an ObjectDetectionProvider: where detections go, and their class names. More...

#include <auterion_sdk/object_detection/object_detection_provider.hpp>

Public Member Functions

DetectionProviderOptionswithRos (bool enable)
 Enable or disable the ROS detections topic.
 
DetectionProviderOptionswithMavlink (bool enable)
 Enable or disable the MAVLink detection output.
 
DetectionProviderOptionswithClassCatalog (ClassCatalog catalog)
 Set the class catalog the ground station shows.
 

Public Attributes

bool ros {true}
 
bool mavlink {true}
 Send detections to the ground station. A batch without image dimensions is not sent.
 
ClassCatalog class_catalog {}
 names for the class ids reported; empty is valid
 

Detailed Description

Configures an ObjectDetectionProvider: where detections go, and their class names.

Both channels are on by default, and at most one provider per vehicle may send to the ground station. The launch-time parameter overrides object_detection_ros_output and object_detection_mavlink_output switch either channel without rebuilding the app.

Member Function Documentation

◆ withClassCatalog()

DetectionProviderOptions & auterion::DetectionProviderOptions::withClassCatalog ( ClassCatalog  catalog)
inline

Set the class catalog the ground station shows.

Parameters
catalogNames for the class ids the detector reports. An empty catalog is valid; the ground station then renders the raw ids.
Returns
Reference to this object for method chaining.

◆ withMavlink()

DetectionProviderOptions & auterion::DetectionProviderOptions::withMavlink ( bool  enable)
inline

Enable or disable the MAVLink detection output.

At most one provider per vehicle may enable this.

Parameters
enableTrue to emit TRACKER_DETECTION_2D / TRACKER_STATUS.
Returns
Reference to this object for method chaining.

◆ withRos()

DetectionProviderOptions & auterion::DetectionProviderOptions::withRos ( bool  enable)
inline

Enable or disable the ROS detections topic.

Parameters
enableTrue to publish detections on the ROS topic.
Returns
Reference to this object for method chaining.

Member Data Documentation

◆ ros

bool auterion::DetectionProviderOptions::ros {true}

publish the on-board ROS detections topic, in source pixels


The documentation for this struct was generated from the following file: