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 Collection instance. This checks for each survey in the Collection in which voxel stack the survey 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) – Collection 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:

Collection instance with the information from the VoxelModel variable added to the data table.

Return type:

Collection