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...

Detailed Description

Structure that store externally detected objects.

The objects can be ingested with sl.Camera.IngestCustomBoxObjects() to extract 3D and tracking information over time.

Variables

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.

Note: Expressed in pixels on the original image resolution, [0, 0] is the top left corner.
A ------ B

| Object |

D ------ C

int label

Object label.

This information is passed-through and can be used to improve object tracking.

Note: It should define an object class. This means that any similar object (in classification) should share the same label number.

float probability

Detection confidence value of the object.

Note: The value should be in [0-1].; It can be used to improve the object tracking.

bool isGrounded

Provide hypothesis about the object movements (degrees of freedom or DoF) to improve the object tracking.

true: 2 DoF projected alongside the floor plane. Case for object standing on the ground such as person, vehicle, etc.
The projection implies that the objects cannot be superposed on multiple horizontal levels.
false: 6 DoF (full 3D movements are allowed).

Note: This parameter cannot be changed for a given object tracking id.; It is advised to set it by labels to avoid issues.