geost.base.Collection.select_within_bbox#

Collection.select_within_bbox(xmin: int | float, ymin: int | float, xmax: int | float, ymax: int | float, invert: bool = False)[source]#

Make a selection of the collection based on a bounding box.

Parameters:
  • xmin (int | float) – Minimum x-coordinate of the bounding box.

  • ymin (int | float) – Minimum y-coordinate of the bounding box.

  • xmax (int | float) – Maximum x-coordinate of the bounding box.

  • ymax (int | float) – Maximum y-coordinate of the bounding box.

  • invert (bool, optional) – Invert the selection, then selects all objects outside of the bounding box. The default is False.

Returns:

New Collection instance containing only the surveys that are located within the bounding box.

Return type:

Collection