geost.base.BoreholeCollection.get_layer_top#

BoreholeCollection.get_layer_top(column: str, values: str | List[str], include_in_header: bool = False)[source]#

Find the depth at which a specified layer first occurs.

Parameters:

  • column (str) – Name of column that contains categorical data.

  • values (str | List[str]) – Value or values of entries in the column that you want to find top of.

  • include_in_header (bool, optional) – If True, include the result in the header table of the collection. In this case, the method does not return a DataFrame. The default is False.

Returns:

Borehole ids and top levels of selected layers in meters below the surface.

Return type:

pd.DataFrame

Examples

Get the top depth of layers in boreholes where the lithology in the “lith” column is sand (“Z”):

>>> boreholes.get_layer_top("lith", "Z")

To include the result in the header object of the collection, use the “include_in_header” option:

>>> boreholes.get_layer_top("lith", "Z", include_in_header=True)