Sign in
Periphery (Camera)

Capture Boundingbox 3D

Retrieves 3D bounding box data for specified object classes from the scene. Use the set_semantic_label endpoint to assign labels to scene entities.

  • The json format carries the box extents and the transform that places them; the image formats draw the wireframes onto the captured frame.
get/periphery/cameras/capture/bounding-box-3d

Query parameters

object_classstring[]

Classes of objects to include in the 3D bounding box output. If not specified, returns all labeled instances.

Classes of objects to include in the 3D bounding box output. If not specified, returns all labeled instances.

result_type'json' | 'rgb_png' | 'jpeg'

Format which will be used to represent the captured data. 'json' carries the measurements; 'rgb_png' and 'jpeg' draw them onto the captured frame.

Format which will be used to represent the captured data. 'json' carries the measurements; 'rgb_png' and 'jpeg' draw them onto the captured frame.

camera_prim_pathstring nullable

Path of camera prim. Leave it out to capture through the active viewport camera.

Path of camera prim. Leave it out to capture through the active viewport camera.

widthinteger

Image width in px

Image width in px

heightinteger

Image height in px

Image height in px

Response

Successfully fetched 3D bounding box data

labelstring required

Class label for the detected object

bboxnumber[] required

Bounding box coordinates [x_min, y_min, z_min, x_max, y_max, z_max]

prim_pathstring required

Path to the USD prim of the detected object

semantic_idinteger required

Semantic ID of the detected object

Changes

Changed in 1 of the 13 revisions of this API.6

  • f4e4cbd85f5b6See the full diff
    • ○

      added the new optional query request parameter result_type

      new-optional-request-parameter

    • ○

      the query request parameter camera_prim_path became optional

      request-parameter-became-optional

    • ○

      query request parameter camera_prim_path list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      for the query request parameter camera_prim_path, the type was generalized from string to no type

      request-parameter-type-generalized

    • ○

      added the media type image/jpeg for the response with the status

      response-media-type-added

    • ○

      added the media type image/png for the response with the status

      response-media-type-added