geost.base.CptCollection.to_multiblock#

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

Create a Pyvista MultiBlock object from the data that can be used for 3D plotting and other spatial analyses.

Parameters:

  • data_columns (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”, “Ostend height”). 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:

MultiBlock