WAwandelbotsgmbh
Periphery (Camera)

Capture Boundingbox 3D

Changed on

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

Request

Query parameters

object_classstring[]

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.

camera_prim_pathstring nullable

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

widthinteger

Image width in px

heightinteger

Image height in px

Response

Successfully fetched 3D bounding box data

Changes

  • f4e4cbd85f5bRevision changes
    • info

      added the new optional query request parameter result_type

    • info

      the query request parameter camera_prim_path became optional

    • info

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

    • info

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

    • info

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

    • info

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