set_predictions_callback
  • 1 Minute to read

set_predictions_callback


Article summary

This method allows you to set either a synchronous or an asynchronous callback, which will be triggered each time a new message arrives in the predictions topic. If callback_async is defined, the callback is ignored. One of the callbacks must be defined.

Reference

Arguments

ArgumentsTypeDefault valueDescription
callbackcallableNoneCallback that will be invoked when a prediction arrives.
callback_asynccallableNoneAsync callback that will be invoked when a prediction arrives.
as_dictboolFalseIf set to true, the predictions will be returned as a dictionary; otherwise, they will be returned as a list.
call_without_predictionsboolFalseIf it is set to true, the callback will be called even when there are no predictions. If it is set to false, the callback will not be called when there are no predictions.

Return

None

Exceptions

None

See the complete list of cv exceptions.

Examples

def callback_prediction(self, msg):
    self.prediction_received = True
...
self.predictor.set_predictions_callback(
        callback=self.callback_prediction,
        as_dict=True,
        call_without_detections=True,
    )
...
...

Was this article helpful?