supervision-js
    Preparing search index...

    Interface DepthAnnotationRenderer

    Colours the session's depth map over the media.

    The map comes from the session's depth option, not from detections, and is stretched over the whole media rectangle. Changing a setting here recolours the map without reloading or re-uploading it. Descriptors with distinct ids may coexist, for example two colormaps split by wipe.

    interface DepthAnnotationRenderer {
        id: string;
        kind: "depth";
        colormap?: DepthColormap;
        quantity?: DepthQuantity;
        range?: DepthRange | "auto" | "clip";
        opacity?: number;
        sampling?: DepthSampling;
        wipe?: number;
        noDepthColor?: number | null;
    }

    Hierarchy

    • BaseAnnotationRenderer
      • DepthAnnotationRenderer
    Index
    id: string

    Stable identity within one presentation.

    kind: "depth"
    colormap?: DepthColormap

    Colour table, with the near end warm or bright. Defaults to "turbo".

    quantity?: DepthQuantity

    Colours disparity (inverse depth) or metric depth. Defaults to "disparity". Depth needs metric data or a camera; without one the map is coloured as disparity.

    range?: DepthRange | "auto" | "clip"

    "clip" uses the map's own display range, "auto" the frame's 2nd to 98th percentile, and { min, max } a fixed range in the quantity's unit: pixels of disparity, or metres of depth. Without a camera, a metric map's disparity is inverse depth in 1/m; relative inverse depth keeps its own unit. Values outside clamp to the ends. Defaults to "clip", which behaves as "auto" for a map without a display range.

    opacity?: number

    Overall alpha from 0 to 1. Defaults to 1.

    sampling?: DepthSampling

    "auto" samples the nearest map pixel when the map is at least media size and filters edge-aware when it is smaller. Defaults to "auto".

    wipe?: number

    Share of the media width, from the left, the map covers. Defaults to 1.

    noDepthColor?: number | null

    0xRRGGBB painted where the map has no depth, or null to leave those pixels unpainted. Defaults to null.