geost.analysis.combine.add_voxelmodel_variable#

geost.analysis.combine.add_voxelmodel_variable(collection: Collection, model: VoxelModel, variable: str) → Collection[source]#

Add a information from a variable of a VoxelModel instance as a column to the data of a BoreholeCollection or CptCollection instance. This checks for each data object in the Collection instance in which voxel stack the object is located and adds the relevant layer boundaries of the variable to the data object of the Collection based on depth.

Note

If the variable name is already present in the columns of the data attribute of the collection, the present column is overwritten. To avoid this, rename the variable before either in collection.data or in the voxelmodel.

Parameters:

  • collection (Collection) – Any GeoST Collection object such as a BoreholeCollection or CptCollection to add the VoxelModel variable to.

  • model (VoxelModel) – VoxelModel instance to add the information from to the Collection instance.

  • variable (str) – Name of the variable in the VoxelModel to add.

Returns:

New Collection (same type as the input) object with the variable added to the data object of the Collection.

Return type:

Collection

Raises:

NotImplementedError – Raises error for geost data object types that are not yet implemented such as LineData (future developments).