depth_image.md

title
DepthImage

A depth image.

The shape of the TensorData must be mappable to an HxW tensor. Each pixel corresponds to a depth value in units specified by meter.

Components

Required: TensorData

Optional: DepthMeter, DrawOrder, Colormap

Shown in

• Spatial2DView
• Spatial3DView (if logged under a projection)

API reference links

• 🌊 C++ API docs for DepthImage
• 🐍 Python API docs for DepthImage
• 🦀 Rust API docs for DepthImage

Examples

Simple example

snippet: archetypes/depth_image_simple

Depth to 3D example

snippet: archetypes/depth_image_3d