Structure that store externally detected objects. More...
Attributes | |
| string | uniqueObjectID |
| Unique id to help identify and track AI detections. More... | |
| Vector2[] | boundingBox2D |
| 2D bounding box of the object represented as four 2D points starting at the top left corner and rotation clockwise. More... | |
| int | label |
| Object label. More... | |
| float | probability |
| Detection confidence value of the object. More... | |
| bool | isGrounded |
| Provide hypothesis about the object movements (degrees of freedom or DoF) to improve the object tracking. More... | |
| bool | isStatic |
| Provide hypothesis about the object staticity to improve the object tracking. More... | |
| float | trackingTimeout |
| Maximum tracking time threshold (in seconds) before dropping the tracked object when unseen for this amount of time. By default, let the tracker decide internally based on the internal sub class of the tracked object. More... | |
| float | trackingMaxDist |
| Maximum tracking distance threshold(in meters) before dropping the tracked object when unseen for this amount of meters. By default, do not discard tracked object based on distance. Only valid for static object. More... | |
| float | maxBoxWidthMeters |
| Maximum allowed 3D width. Any prediction bigger than that will be either discarded (if object is tracked and in SEARCHING state) or clamped. Default: -1 (no filtering) More... | |
| float | minBoxWidthMeters |
| Minimum allowed 3D width. Any prediction smaller than that will be either discarded (if object is tracked and in SEARCHING state) or clamped. Default: -1 (no filtering) More... | |
| float | maxBoxHeightMeters |
| Maximum allowed 3D height. Any prediction bigger than that will be either discarded (if object is tracked and in SEARCHING state) or clamped. Default: -1 (no filtering) More... | |
| float | minBoxHeightMeters |
| Minimum allowed 3D height. Any prediction smaller than that will be either discarded (if object is tracked and in SEARCHING state) or clamped. Default: -1 (no filtering) More... | |
| float | maxAllowedAcceleration |
| Manually override the acceleration preset. If set, this value takes precedence over the selected preset, allowing for a custom maximum acceleration. Unit is m/s^2. More... | |
| float | velocitySmoothingFactor |
| Smoothing factor applied to the estimated velocity, between 0 and 1. Default: -1 (use the module default) More... | |
| float | minVelocityThreshold |
| Velocity below which the object is considered still, in meters per second. Default: -1 (use the module default) More... | |
| float | predictionTimeout_s |
| How long a lost object keeps being predicted before it is discarded, in seconds. Default: -1 (use the module default) More... | |
| float | minConfirmationTime_s |
| How long an object must be seen before it is confirmed as tracked, in seconds. Default: -1 (use the module default) More... | |
Structure that store externally detected objects.
The objects can be ingested with sl.Camera.IngestCustomBoxObjects() to extract 3D and tracking information over time.
| string uniqueObjectID |
Unique id to help identify and track AI detections.
It can be either generated externally, or by using sl.Camera.GenerateUniqueID() or left empty.
| Vector2 [] boundingBox2D |
2D bounding box of the object represented as four 2D points starting at the top left corner and rotation clockwise.
[0, 0] is the top left corner. | int label |
Object label.
This information is passed-through and can be used to improve object tracking.
| float probability |
Detection confidence value of the object.
[0-1]. | bool isGrounded |
Provide hypothesis about the object movements (degrees of freedom or DoF) to improve the object tracking.
| bool isStatic |
Provide hypothesis about the object staticity to improve the object tracking.
| float trackingTimeout |
Maximum tracking time threshold (in seconds) before dropping the tracked object when unseen for this amount of time. By default, let the tracker decide internally based on the internal sub class of the tracked object.
| float trackingMaxDist |
Maximum tracking distance threshold(in meters) before dropping the tracked object when unseen for this amount of meters. By default, do not discard tracked object based on distance. Only valid for static object.
| float maxBoxWidthMeters |
Maximum allowed 3D width. Any prediction bigger than that will be either discarded (if object is tracked and in SEARCHING state) or clamped. Default: -1 (no filtering)
| float minBoxWidthMeters |
Minimum allowed 3D width. Any prediction smaller than that will be either discarded (if object is tracked and in SEARCHING state) or clamped. Default: -1 (no filtering)
| float maxBoxHeightMeters |
Maximum allowed 3D height. Any prediction bigger than that will be either discarded (if object is tracked and in SEARCHING state) or clamped. Default: -1 (no filtering)
| float minBoxHeightMeters |
Minimum allowed 3D height. Any prediction smaller than that will be either discarded (if object is tracked and in SEARCHING state) or clamped. Default: -1 (no filtering)
| float maxAllowedAcceleration |
Manually override the acceleration preset. If set, this value takes precedence over the selected preset, allowing for a custom maximum acceleration. Unit is m/s^2.
| float velocitySmoothingFactor |
Smoothing factor applied to the estimated velocity, between 0 and 1. Default: -1 (use the module default)
| float minVelocityThreshold |
Velocity below which the object is considered still, in meters per second. Default: -1 (use the module default)
| float predictionTimeout_s |
How long a lost object keeps being predicted before it is discarded, in seconds. Default: -1 (use the module default)
| float minConfirmationTime_s |
How long an object must be seen before it is confirmed as tracked, in seconds. Default: -1 (use the module default)