geost.base.CptCollection.to_pyvista_cylinders

CptCollection.to_pyvista_cylinders(displayed_variables: str | List[str], radius: float = 1, vertical_factor: float = 1.0, relative_to_vertical_reference: bool = True)

Create a Pyvista MultiBlock object of cylinder-shaped geometries to represent boreholes. Although cylinders are prettier when visualized, they are quite costly to render in large numbers. Consider using to_pyvista_grid() instead for large datasets.

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.

• vertical_factor (float, optional) – Factor to correct vertical scale. For example, when layer boundaries are given in cm, use 0.01 to convert to m. The default is 1.0, so no correction is applied. It is not recommended to use this for vertical exaggeration, use viewer functionality for that instead.

• relative_to_vertical_reference (bool, optional) – If True, the depth of the objects in the vtm file will be with respect to a reference plane (e.g. “NAP”, “TAW”). If False, the depth will be with respect to 0.0. The default is True.

Returns:

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

Return type:

pyvista.MultiBlock