WAwandelbotsgmbh
Periphery (Camera)

Capture Boundingbox 2D

Changed on

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

get/periphery/cameras/capture/bounding-box-2d

Request

Query parameters

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

Format which will be used to represent the captured data. 'json' carries the measurements; 'rgb_png' and 'jpeg' are renderings to look at, and jpeg is lossy.

object_classstring[]

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

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 2D bounding box data

Changes

  • f4e4cbd85f5bRevision changes
    • info

      the query request parameter camera_prim_path became optional

    • info

      added the new enum value jpeg to the query request parameter result_type

    • 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