Sign in
Periphery (Camera)

Capture Instance Segmentation

Retrieves instance segmentation data for specified object classes, with each detected object uniquely identified. Use the set_semantic_label endpoint to assign labels to scene entities.

get/periphery/cameras/capture/instance-segmentation

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.

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 segmentation. If not specified, returns all labeled instances.

Classes of objects to include in segmentation. 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.

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 instance segmentation data

Changes

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

  • f4e4cbd85f5b5See the full diff
    • ○

      the query request parameter camera_prim_path became optional

      request-parameter-became-optional

    • ○

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

      request-parameter-enum-value-added

    • ○

      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