CustomBoxObjectData Class Reference

Container to store the externally detected objects. More...

Functions

def unique_object_id (self)
 Unique ID to help identify and track AI detections. More...
 
def bounding_box_2d (self)
 2D bounding box of the object represented as four 2D points starting at the top left corner and rotation clockwise. More...
 
def label (self)
 Object label, this information is passed-through and can be used to improve object tracking.
 
def probability (self)
 Detection confidence. More...
 
def is_grounded (self)
 Provides hypothesis about the object movements (degrees of freedom) to improve the object tracking
True: means 2 DoF projected alongside the floor plane, It is the default for objects standing on the ground such as person, vehicle, etc
False: 6 DoF full 3D movements are allowed.
 

Detailed Description

Container to store the externally detected objects.

The objects can be ingested using sl.Camera.ingest_custom_box_objects() functions to extract 3D information and tracking over time

Functions

◆ unique_object_id()

def unique_object_id (   self)

Unique ID to help identify and track AI detections.

Can be either generated externally, or using generate_unique_id() or left empty

◆ bounding_box_2d()

def bounding_box_2d (   self)

2D bounding box of the object represented as four 2D points starting at the top left corner and rotation clockwise.

Expressed in pixels on the original image resolution, where [0,0] is the top left corner.

A ------ B
| Object |
D ------ C

◆ probability()

def probability (   self)

Detection confidence.

Should be [0-1]. It can be used to improve the object tracking