xrspatial.flood.inundation#

xrspatial.flood.inundation(hand_agg: DataArray, water_level: float, name: str = 'inundation') → DataArray[source]#

Create a binary inundation mask from a HAND raster.

Returns 1.0 where HAND <= water_level, 0.0 elsewhere. NaN cells in the input remain NaN.

Parameters:

  • hand_agg (xarray.DataArray) – 2D HAND raster (output of hand()).

  • water_level (float) – Water surface elevation above the drainage network (>= 0).

  • name (str, default 'inundation') – Name of the output DataArray.

Returns:

2D float64 binary mask.

Return type:

xarray.DataArray

Notes

Supports NumPy, CuPy, Dask with NumPy, and Dask with CuPy backed xarray DataArrays.

Examples

>>> import numpy as np
>>> import xarray as xr
>>> from xrspatial import inundation
>>> hand = xr.DataArray(
...     np.array([[0.0, 2.0], [5.0, 10.0]]), dims=['y', 'x'])
>>> mask = inundation(hand, water_level=5.0)