geost.base.BoreholeCollection.select_within_bbox#

BoreholeCollection.select_within_bbox(xmin: Coordinate, ymin: Coordinate, xmax: Coordinate, ymax: Coordinate, invert: bool = False)#

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

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

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

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

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

  • invert (bool, optional) – Invert the selection, so select all objects outside of the bounding box in this case, by default False.

Returns:

New instance of the current object containing only the selection resulting from application of this method. e.g. if you are calling this method from a Collection, you will get an instance of a Collection back.

Return type:

New instance of the current object.