Skip to main content

Module heatmap

Module heatmap 

Source
Expand description

Bounded scalar-grid projection as a domain-neutral scene/heatmap.

The caller owns detector semantics and prepares the exact values and mask that may be displayed. This module derives a display budget from open SurfaceCaps metadata, refuses data that exceeds it, and never downsamples or otherwise changes the caller’s grid. A domain’s detail projection preserves source cells and must refuse an undersized target; detector integration is a separate upstream operation that integrates every covered source cell before this module sees the result. Detector labels, advisories, and evidence remain caller-owned metadata rather than claims manufactured by the generic view.

Structs§

HeatmapBudget
Checked cell and scalar-payload ceilings derived from display metadata.
HeatmapData
Caller-prepared scalar grid projected by heatmap_view.

Constants§

BLUE_RED_PALETTE
Named diverging palette for signed or reference-centred scalar data.
CYCLIC_PHASE_PALETTE
Named cyclic palette for phase-like scalar data whose endpoints meet.
MAX_HEATMAP_BYTES
Absolute scalar-payload ceiling for one heatmap Scene.
MAX_HEATMAP_CELLS
Absolute cell ceiling for one heatmap Scene, independent of surface claims.
VIRIDIS_PALETTE
Named sequential palette for monotonically ordered scalar data.

Functions§

heatmap_budget
Derive the checked heatmap budget for a surface.
heatmap_byte_budget
Return only the checked scalar-payload byte ceiling from heatmap_budget.
heatmap_cell_budget
Return only the checked cell ceiling from heatmap_budget.
heatmap_view
Validate and project caller-prepared data to one scene/heatmap.