Capture Depth Image
Retrieves depth (distance) data from the captured image.
- In the json format, returns the per-pixel Euclidean range in the requested unit (pixels without geometry are returned as 0.0), the unit it is expressed in, and the camera intrinsics in pixels for the requested resolution, so callers can convert the range to planar depth themselves.
- In the rgb_png format, returns a colorized visualization instead; a PNG carries neither intrinsics nor a unit.
Query parameters
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.
Near end of the PNG colour ramp, in stage units. Leave it out to fit the ramp to the frame.
Near end of the PNG colour ramp, in stage units. Leave it out to fit the ramp to the frame.
Far end of the PNG colour ramp, in stage units. Leave it out to fit the ramp to the frame.
Far end of the PNG colour ramp, in stage units. Leave it out to fit the ramp to the frame.
Length unit for the returned depth values.
Length unit for the returned depth values.
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.
Image width in px
Image width in px
Image height in px
Image height in px
Response
Successfully fetched depth data