Sign in
Periphery (Camera)

Capture Pointcloud

Retrieves a point cloud from the camera's captured image.

  • Resulting data format depends on stage units (e.g., mm, cm, m).
  • downscale_factor determines compression level: 1.0 = full data, <1.0 = compressed.
  • Points and normals that came out non-finite are returned as zero vectors, since JSON cannot represent them.
get/periphery/cameras/capture/pointcloud

Query parameters

downscale_factornumber

Downscale factor for the point cloud. 1.0 = no compression, 0.1 = heavy compression

Downscale factor for the point cloud. 1.0 = no compression, 0.1 = heavy compression

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 point cloud data

Changes

Changed in 2 of the 13 revisions of this API.13

  • f4e4cbd85f5b3See the full diff
    • ○

      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

  • bed4f7092b751See the full diff
    • ▲

      removed the media type application/json for the response with the status

      response-media-type-removed