segmentation_image.md

title
SegmentationImage

An image made up of integer class-ids.

The shape of the TensorData must be mappable to an HxW tensor. Each pixel corresponds to a class-id that will be mapped to a color based on annotation context.

In the case of floating point images, the label will be looked up based on rounding to the nearest integer value.

Leading and trailing unit-dimensions are ignored, so that 1x640x480x1 is treated as a 640x480 image.

Components

Required: TensorData

Optional: DrawOrder

Shown in

• Spatial2DView
• Spatial3DView (if logged under a projection)

API reference links

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

Example

Simple segmentation image

snippet: archetypes/segmentation_image_simple