ObjectsBatch Class Reference

Class containing batched data of a detected objects from the object detection module. More...

Functions

int id (self)
 Id of the batch.
 
OBJECT_CLASS label (self)
 Objects class/category to identify the object type.
 
OBJECT_SUBCLASS sublabel (self)
 Objects sub-class/sub-category to identify the object type.
 
OBJECT_TRACKING_STATE tracking_state (self)
 Objects tracking state.
 
np.array[float][float] positions (self)
 NumPy array of positions for each object.
 
np.array[float][float] position_covariances (self)
 NumPy array of positions' covariances for each object.
 
np.array[float][float] velocities (self)
 NumPy array of 3D velocities for each object.
 
list[Timestamptimestamps (self)
 List of timestamps for each object.
 
np.array[float][float][float] bounding_boxes (self)
 NumPy array of 3D bounding boxes for each object. More...
 
np.array[int][int][int] bounding_boxes_2d (self)
 NumPy array of 2D bounding boxes for each object. More...
 
np.array[float] confidences (self)
 NumPy array of confidences for each object.
 
list[OBJECT_ACTION_STATEaction_states (self)
 List of action states for each object.
 
np.array[int][int][int] head_bounding_boxes_2d (self)
 NumPy array of 2D bounding box of the head for each object (person). More...
 
np.array[float][float][float] head_bounding_boxes (self)
 NumPy array of 3D bounding box of the head for each object (person). More...
 
np.array[float][float] head_positions (self)
 NumPy array of 3D centroid of the head for each object (person). More...
 

Detailed Description

Class containing batched data of a detected objects from the object detection module.

This class can be used to store trajectories.

Functions

◆ bounding_boxes()

np.array[float][float][float] bounding_boxes (   self)

NumPy array of 3D bounding boxes for each object.

Note
They are defined in sl.InitParameters.coordinate_units and expressed in sl.RuntimeParameters.measure3D_reference_frame.
1 ------ 2
/ /|
0 ------ 3 |
| Object | 6
| |/
4 ------ 7

◆ bounding_boxes_2d()

np.array[int][int][int] bounding_boxes_2d (   self)

NumPy array of 2D bounding boxes for each object.

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

◆ head_bounding_boxes_2d()

np.array[int][int][int] head_bounding_boxes_2d (   self)

NumPy array of 2D bounding box of the head for each object (person).

Note
Expressed in pixels on the original image resolution, [0, 0] is the top left corner.
Warning
Not available with sl.OBJECT_DETECTION_MODEL.MULTI_CLASS_BOX_XXX.

◆ head_bounding_boxes()

np.array[float][float][float] head_bounding_boxes (   self)

NumPy array of 3D bounding box of the head for each object (person).

Note
They are defined in sl.InitParameters.coordinate_units and expressed in sl.RuntimeParameters.measure3D_reference_frame.
Warning
Not available with sl.OBJECT_DETECTION_MODEL.MULTI_CLASS_BOX_XXX.

◆ head_positions()

np.array[float][float] head_positions (   self)

NumPy array of 3D centroid of the head for each object (person).

Note
They are defined in sl.InitParameters.coordinate_units and expressed in sl.RuntimeParameters.measure3D_reference_frame.
Warning
Not available with sl.OBJECT_DETECTION_MODEL.MULTI_CLASS_BOX_XXX.