BodyTrackingParameters Struct Reference

Structure containing a set of parameters for the body tracking module. More...

Attributes

uint instanceModuleId
 Id of the module instance. More...
 
bool enableObjectTracking
 Whether the body tracking system includes body/person tracking capabilities across a sequence of images. More...
 
bool enableSegmentation
 Whether the body/person masks will be computed. More...
 
sl.BODY_TRACKING_MODEL detectionModel
 sl.BODY_TRACKING_MODEL to use. More...
 
bool enableBodyFitting
 Whether to apply the body fitting. More...
 
sl.BODY_FORMAT bodyFormat
 Body format to be outputted by the ZED SDK with sl.Camera.RetrieveBodies(). More...
 
sl.BODY_KEYPOINTS_SELECTION bodySelection
 Selection of keypoints to be outputted by the ZED SDK with sl_retrieve_bodies(). More...
 
float maxRange
 Upper depth range for detections. More...
 
float predictionTimeout_s
 Prediction duration of the ZED SDK when an object is not detected anymore before switching its state to sl.OBJECT_TRACKING_STATE.SEARCHING. More...
 
bool allowReducedPrecisionInference
 Whether to allow inference to run at a lower precision to improve runtime and memory usage. More...
 

Detailed Description

Structure containing a set of parameters for the body tracking module.

The default constructor sets all parameters to their default settings.

Note
Parameters can be user adjusted.

Variables

◆ instanceModuleId

uint instanceModuleId

Id of the module instance.

This is used to identify which body tracking module instance is used.

◆ enableObjectTracking

bool enableObjectTracking

Whether the body tracking system includes body/person tracking capabilities across a sequence of images.

Default: true

◆ enableSegmentation

bool enableSegmentation

Whether the body/person masks will be computed.

Default: false

◆ detectionModel

◆ enableBodyFitting

bool enableBodyFitting

Whether to apply the body fitting.

Default: false

◆ bodyFormat

sl.BODY_FORMAT bodyFormat

Body format to be outputted by the ZED SDK with sl.Camera.RetrieveBodies().

◆ bodySelection

Selection of keypoints to be outputted by the ZED SDK with sl_retrieve_bodies().

Default: SL_BODY_KEYPOINTS_SELECTION_FULL

◆ maxRange

float maxRange

Upper depth range for detections.

Default: -1 (value set in sl.InitParameters.depthMaximumDistance)

Note
The value cannot be greater than sl.InitParameters.depthMaximumDistance and its unit is defined in sl.InitParameters.coordinateUnits.

◆ predictionTimeout_s

float predictionTimeout_s

Prediction duration of the ZED SDK when an object is not detected anymore before switching its state to sl.OBJECT_TRACKING_STATE.SEARCHING.

It prevents the jittering of the object state when there is a short misdetection.
The user can define their own prediction time duration.
Default: 0.2f

Note
During this time, the object will have sl.OBJECT_TRACKING_STATE.OK state even if it is not detected.
The duration is expressed in seconds.
Warning
predictionTimeout_s will be clamped to 1 second as the prediction is getting worse with time.
Setting this parameter to 0 disables the ZED SDK predictions.

◆ allowReducedPrecisionInference

bool allowReducedPrecisionInference

Whether to allow inference to run at a lower precision to improve runtime and memory usage.

It might increase the initial optimization time and could include downloading calibration data or calibration cache and slightly reduce the accuracy.

Note
The fp16 is automatically enabled if the GPU is compatible and provides a speed up of almost x2 and reduce memory usage by almost half, no precision loss.
This setting allow int8 precision which can speed up by another x2 factor (compared to fp16, or x4 compared to fp32) and half the fp16 memory usage, however some accuracy could be lost.
The accuracy loss should not exceed 1-2% on the compatible models.
The current compatible models are all sl.AI_MODELS.HUMAN_BODY_XXXX.