geost.base.CptCollection.get_area_labels#

CptCollection.get_area_labels(polygon_gdf: str | Path | GeoDataFrame, column_name: str, include_in_header=False) → DataFrame#

Find in which area (polygons) the point data locations fall. e.g. to determine in which geomorphological unit points are located.

Parameters:

  • polygon_gdf (str | Path | gpd.GeoDataFrame) – GeoDataFrame with polygons.

  • column_name (str) – The column name to find the labels in.

  • include_in_header (bool, optional) – Whether to add the acquired data to the header table or not, by default False.

Returns:

Borehole ids and the polygon label they are in. If include_in_header = True, a column containing the generated data will be added inplace to the header.

Return type:

pd.DataFrame