geost.analysis.grainsize.calculate_bhrgt_grainsize_percentiles#

geost.analysis.grainsize.calculate_bhrgt_grainsize_percentiles(sample_data: pd.DataFrame | Collection, percentiles: int | float | list[int | float] = 50, only_sand: bool = False) → pd.DataFrame | Collection[source]#
geost.analysis.grainsize.calculate_bhrgt_grainsize_percentiles(sample_data: DataFrame, percentiles: int | float | list[int | float], only_sand: bool) → DataFrame

Calculate the grain size percentiles (e.g. D10, D50, D90) for each sample in the provided DataFrame.

Parameters:

  • sample_data (pd.DataFrame | Collection) – DataFrame or Collection containing the grain size distribution data for multiple boreholes and samples following the minimum requirements for a GeoST-BHRGT-samples grainsize data table.

  • percentiles (int | float | list[int | float], optional) – Percentiles to calculate (e.g. 10, 50, 90). The default is 50 (D50).

  • only_sand (bool, optional) – If True, only calculate percentiles based on the sand fractions (i.e. ignore fractions smaller than 63um and larger than 2mm). The default is False.

Returns:

DataFrame containing the estimated grain size percentiles for each sample. The percentile columns are named “d{percentile}” (e.g. “d50”) or “d{percentile}_sand” (e.g. “d50_sand”) if only_sand is True.

Return type:

pd.DataFrame