load_cached_voxel_field

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.

load_cached_voxel_field(cache_dir: str | Path, subject_id: str, cache_key: str) → VoxelFeatureField | None[source]

Load a cached field when the archive exists and is readable.

Parameters:

  • cache_dir – Directory that holds cached fields.

  • subject_id – Owning subject (must match the archive).

  • cache_key – Digest from voxel_radiomics_cache_key().

Returns:

The stored field, or None on a miss or a corrupt archive.