plot_simpleitk_ingest
Note
This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.
- plot_simpleitk_ingest(image: object, labels: object, *, title: str = 'From SimpleITK to habitats', panel_title: str = 'Habitats', crop_pad: int = 8) Figure[source]
Diagram for the SimpleITK route: voxel-cube badge -> habitat overlay.
- Parameters:
image – Anatomy volume (array or
ImageVolume) of one subject.labels – Habitat label map (array or
HabitatMap) on the same grid.title – Figure title (ASCII-sanitised).
panel_title – Title of the cropped data panel.
crop_pad – Context voxels around the habitat bounding box (default
8).
- Returns:
A matplotlib
Figurewith the stylised SimpleITK badge on the left and the cropped habitat overlay on the right.