ObjectTrackingParametersProxy Class Reference

Class containing a set of runtime properties of a certain class ID for the object detection module using a custom model. More...

Functions

OBJECT_ACCELERATION_PRESET object_acceleration_preset (self)
 Preset defining the expected maximum acceleration of the tracked object. More...
 
float velocity_smoothing_factor (self)
 Values between 0.0 and 1.0. More...
 
float min_velocity_threshold (self)
 Threshold to force an object's velocity to zero. More...
 
float prediction_timeout_s (self)
 Duration to keep predicting a track's position after occlusion. More...
 
float min_confirmation_time_s (self)
 Minimum confirmation time required to validate a track. More...
 

Detailed Description

Class containing a set of runtime properties of a certain class ID for the object detection module using a custom model.

The default constructor sets all parameters to their default settings.

Note
Parameters can be adjusted by the user.

Class containing tracking parameters for object detection.

Used to configure how objects are tracked over time.

Functions

◆ object_acceleration_preset()

OBJECT_ACCELERATION_PRESET object_acceleration_preset (   self)

Preset defining the expected maximum acceleration of the tracked object.

Determines how the ZED SDK interprets object acceleration, affecting tracking behavior and predictions.

Referenced by ObjectTrackingParameters.min_confirmation_time_s(), and ObjectTrackingParametersProxy.min_confirmation_time_s().

◆ velocity_smoothing_factor()

float velocity_smoothing_factor (   self)

Values between 0.0 and 1.0.

  • High value (closer to 1.0): Very smooth, but may lag behind rapid changes.
  • Low value (closer to 0.0): Very responsive to velocity changes, but may be jittery.
  • 0.5: ZED SDK base tuning. Balanced smoothing and responsiveness. A negative value (e.g. -1) lets the ZED SDK interpret the velocity_smoothing_factor. Default: -1

Referenced by ObjectTrackingParameters.min_confirmation_time_s(), and ObjectTrackingParametersProxy.min_confirmation_time_s().

◆ min_velocity_threshold()

float min_velocity_threshold (   self)

Threshold to force an object's velocity to zero.

If the calculated speed (m/s) is below this threshold, the object is considered static. This helps eliminate drift on stationary objects. A negative value (e.g. -1) lets the ZED SDK interpret the min_velocity_threshold. Default: -1

Referenced by ObjectTrackingParameters.min_confirmation_time_s(), and ObjectTrackingParametersProxy.min_confirmation_time_s().

◆ prediction_timeout_s()

float prediction_timeout_s (   self)

Duration to keep predicting a track's position after occlusion.

When an object is no longer visible (occluded or out of frame), the tracker will predict its position for this duration before deleting the track.

  • Short (e.g., 0.2s): Prevents "ghost" objects but may break tracks during short occlusions.
  • Long (e.g., 2.0s): Maintains ID during long occlusions but may report objects that are gone. A negative value (e.g. -1) lets the ZED SDK interpret the prediction_timeout_s. Default: -1

Referenced by ObjectDetectionParameters.__cinit__(), BodyTrackingParameters.__cinit__(), ObjectTrackingParameters.min_confirmation_time_s(), and ObjectTrackingParametersProxy.min_confirmation_time_s().

◆ min_confirmation_time_s()

float min_confirmation_time_s (   self)

Minimum confirmation time required to validate a track.

The minimum duration (in seconds) an object must be continuously detected before it is reported as a valid track. Helps filter out spurious false positives that appear only briefly. A negative value (e.g. -1) lets the ZED SDK interpret the prediction_timeout_s. Default: -1

Referenced by ObjectTrackingParameters.min_confirmation_time_s().