geost.base.CptCollection.to_vtm#

CptCollection.to_vtm(outfile: str | Path, data_columns: str | List[str], radius: float = 1, vertical_factor: float = 1.0, relative_to_vertical_reference: bool = True, **kwargs)#

Save data as VTM (Multiblock file, an XML VTK file pointing to multiple other VTK files) for viewing in external GUI software like ParaView or other VTK viewers.

Parameters:

  • outfile (str | Path) – Path to vtm file to be written.

  • 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, by default 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.

  • **kwargs – pyvista.MultiBlock.save kwargs. See relevant Pyvista documentation.