geost.base.BoreholeCollection.to_pyvista_grid#

BoreholeCollection.to_pyvista_grid(displayed_variables: str | List[str], radius: float = 1.0)#

Create a Pyvista UnstructuredGrid object to represent boreholes. This is more efficient than to_pyvista_cylinders() for large datasets, but less visually appealing.

Parameters:

  • displayed_variables (str | List[str]) – Name or names of data columns to include for visualisation. Can be columns that contain an array of floats, ints and strings.

  • radius (float, optional) – Radius of the cylinders in m in the MultiBlock. The default is 1.

Returns:

A grid class holding the data which can be iterated over.

Return type:

pyvista.UniformGrid