read_mask

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.

read_mask(path: str | Path, *, labels: Tuple[int, ...] = (), label_names: Mapping[int, str] | None = None, subject_id: str | None = None) → MaskVolume[source]

Read a mask file into a geometry-aware MaskVolume.

Examples using habit.image.read_mask

Load from NIfTI files

Load from NIfTI files