render_habitat_graph_surface_3d

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.

render_habitat_graph_surface_3d(label_array: ndarray, *, spacing: Tuple[float, float, float] = (1.0, 1.0, 1.0), black_background: bool = True, render_window: int = 1600, surface_smooth_iter: int = 30) → ndarray | None[source]

Render a 3D surface view of the habitat volume (PyVista).

Parameters:

  • label_array – 3D habitat label map (background encoded as 0).

  • spacing – Voxel spacing as (sz, sy, sx).

  • black_background – Whether the scene uses a black background.

  • render_window – Off-screen render window edge length in pixels.

  • surface_smooth_iter – Laplacian smoothing iterations; 0 disables.

Returns:

RGB render of shape (H, W, 3), or None when the volume holds no renderable habitat surface.

Return type:

Optional[np.ndarray]

Raises: