geost.base.BoreholeCollection.get_layer_base#

BoreholeCollection.get_layer_base(column: str, values: str | List[str], min_thickness: float = 0, min_depth: float = 0, max_depth: float = None, include_in_header: bool = False)[source]#

Find the depth at which a specified layer occurs last, starting at min_depth and looking downwards until the first layer of min_thickness is found of the specified layer.

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 base of.

  • min_thickness (float, optional) – Minimal thickness of the layer to be considered. The default is 0.

  • min_depth (float, optional) – Minimal depth of the layer to be considered. The default is 0.

  • max_depth (float, optional) – Maximal depth of the layer to be considered. The default is None.

  • 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 base levels of selected layers in meters below the surface.

Return type:

pd.DataFrame

Examples

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

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

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

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