hydromt_wflow.workflows.river.river_floodplain_volume#

river_floodplain_volume(ds: ~xarray.core.dataset.Dataset, ds_model: ~xarray.core.dataset.Dataset, river_upa: float = 30, flood_depths: list[float] = [0.5, 1.0, 1.5, 2.0, 2.5], dtype: ~numpy.dtype = <class 'numpy.float64'>)[source]#

Calculate floodplain volume at given flood depths based on (subgrid) HAND map.

Parameters:

  • ds (xr.Dataset) – hydrography dataset containing “flwdir”, “uparea”, “elevtn” variables;

  • ds_model (xr.Dataset, optional) – Model dataset with output grid, must contain “rivmsk”, “rivwth”, “rivlen” for subgrid must contain “x_out”, “y_out”.

  • river_upa (float) – minimum threshold to define the river when calculating HAND, by default 30 [km2]

  • flood_depths (list of float, optional) – flood depths at which a volume is derived, by default [0.5,1.0,1.5,2.0,2.5]

  • dtype (numpy.dtype, optional) – output dtype

Returns:

da_out – Floodplain volume [m3]

Return type:

xr.DataArray with dims (flood_depth, y, x)

On this page