geost.accessors.header.PointHeader.get

PointHeader.get(selection_values: str | Iterable, column: str = 'nr') → GeoDataFrame

Get a subset of a header through a string or iterable of object id(s). Optionally uses a different column than “nr” (the column with object ids).

Parameters:

• selection_values (str | Iterable) – Values to select.

• column (str, optional) – In which column of the header to look for selection values, by default “nr”.

Returns:

GeoDataFrame instance containing only objects selected by this method.

Return type:

gpd.GeoDataFrame

Examples

Select the objects with id “obj1” and “obj2” in the “nr” column:

>>> self.get(["obj1", "obj2"])

Suppose we have a number of boreholes that we have joined with geological map units using the method get_area_labels(). We have added this data to the header table in the column ‘geological_unit’. Using:

>>> self.get(["unit1", "unit2"], column="geological_unit")

will return a gpd.GeoDataFrame with all boreholes that are located in “unit1” and “unit2” geological map areas.