dense_voxel_feature_map

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.

dense_voxel_feature_map(field: VoxelFeatureField, feature: str | int | None = None, *, fill_value: float = nan) → np.ndarray[source]

Scatter one VoxelFeatureField column into a dense volume.

Voxels outside the field’s voxel_index receive fill_value (default NaN) so matplotlib can leave them transparent.

Parameters:

  • field – Sparse ROI feature table with (z, y, x) indices.

  • feature – Column name or index; optional when the field has one column.

  • fill_value – Value written outside the ROI (prefer NaN for display).

Returns:

Float array with shape field.geometry.shape.

Raises:

HABITAPIError – On unresolved feature names or invalid geometry.