geost.analysis.classification.nen5104_to_lithoclass#

geost.analysis.classification.nen5104_to_lithoclass(df: DataFrame, names: bool = False, lithology: str = 'lith', sand_median_class: str = 'zmk', sand_median: str = 'zm', sand_admixture: str = 'az', silt_admixture: str = 'asilt', clay_admixture: str = 'ak', lutum_pct: str = 'lutum_pct') → Series[source]#

Map NEN5104 descriptions to lithoclasses that are used in e.g. GeoTOP. It is based on the TNO lithoklassificatie function, but vectorized to be fast when applied to a DataFrame. The classification is based on columns for lithology, sand median class, sand median, sand admixture, silt admixture, clay admixture, and lutum percentage.

  • lithology, e.g. “Z”, “K”, “L”, “G”, “SHE”, etc.

  • sand median class, e.g. “ZFC”, “ZUF”, “ZUFO”, “ZZF”, “ZZFO”

  • sand median in μm, e.g. 63, 150, 300, 2000

  • sand admixture, e.g. “ZX”, “Z1”, “Z2”, “Z3”

  • silt admixture, e.g. “SX”, “S3”, “S1”

  • clay admixture, e.g. “K3”, “KX”

  • lutum percentage, e.g. 5, 10, 20,

Parameters:

  • df (pd.DataFrame) – DataFrame containing the following required columns.

  • names (bool, optional) – If True, return the lithoclass names instead of numeric codes.

  • lithology (str, optional) – Column name for lithology. By default, “lith”, in accordance to DINO database.

  • sand_median_class (str, optional) – Column name for sand median class. By default, “zmk”, in accordance to DINO database.

  • sand_median (str, optional) – Column name for sand median. By default, “zm”, in accordance to DINO database.

  • sand_admixture (str, optional) – Column name for sand admixture. By default, “az”, in accordance to DINO database.

  • silt_admixture (str, optional) – Column name for silt admixture. By default, “asilt”, in accordance to DINO database.

  • clay_admixture (str, optional) – Column name for clay admixture. By default, “ak”, in accordance to DINO database.

  • lutum_pct (str, optional) – Column name for lutum percentage. By default, “lutum_pct”, in accordance to DINO database.

Returns:

Lithology classification.

Return type:

pd.Series