imod.mf6.River.clip_box#
- River.clip_box(time_min: datetime | datetime64 | str | None = None, time_max: datetime | datetime64 | str | None = None, layer_min: int | None = None, layer_max: int | None = None, x_min: float | None = None, x_max: float | None = None, y_min: float | None = None, y_max: float | None = None, top: DataArray | UgridDataArray | None = None, bottom: DataArray | UgridDataArray | None = None) Self #
Clip a package by a bounding box (time, layer, y, x).
- Parameters:
time_min (optional, np.datetime64) – Start time to select. Data will be forward filled to this date. If time_min is before the start time of the dataset, data is backfilled.
time_max (optional) – End time to select.
layer_min (optional, int) – Minimum layer to select.
layer_max (optional, int) – Maximum layer to select.
x_min (optional, float) – Minimum x-coordinate to select.
x_max (optional, float) – Maximum x-coordinate to select.
y_min (optional, float) – Minimum y-coordinate to select.
y_max (optional, float) – Maximum y-coordinate to select.
top (optional, GridDataArray) – Ignored.
bottom (optional, GridDataArray) – Ignored.
- Returns:
clipped – A new package that is clipped to the specified bounding box.
- Return type:
Package
Examples
Slicing intervals may be half-bounded, by providing None:
To select 500.0 <= x <= 1000.0:
>>> pkg.clip_box(x_min=500.0, x_max=1000.0)
To select x <= 1000.0:
>>> pkg.clip_box(x_max=1000.0)``
To select x >= 500.0:
>>> pkg.clip_box(x_min=500.0)
To select a time interval, you can use datetime64:
>>> pkg.clip_box(time_min=np.datetime64("2020-01-01"), time_max=np.datetime64("2020-12-31"))