imod.mf6.StructuredDiscretization.clip_box#

StructuredDiscretization.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) → Package#

Clip a package by a bounding box (time, layer, y, x).

Slicing intervals may be half-bounded, by providing None:

  • To select 500.0 <= x <= 1000.0: clip_box(x_min=500.0, x_max=1000.0).

  • To select x <= 1000.0: clip_box(x_min=None, x_max=1000.0) or clip_box(x_max=1000.0).

  • To select x >= 500.0: clip_box(x_min = 500.0, x_max=None.0) or clip_box(x_min=1000.0).

Parameters:

  • time_min (optional)

  • time_max (optional)

  • layer_min (optional, int)

  • layer_max (optional, int)

  • x_min (optional, float)

  • x_max (optional, float)

  • y_min (optional, float)

  • y_max (optional, float)

  • top (optional, GridDataArray)

  • bottom (optional, GridDataArray)

  • state_for_boundary (optional, GridDataArray)

Returns:

clipped

Return type:

Package