pyflwdir.FlwdirRaster.ucat_volume#

FlwdirRaster.ucat_volume(idxs_out: ndarray, hand: ndarray, depths: ndarray | None = None) → tuple[ndarray, ndarray][source]#

Return the high-resolution unit-catchment map and flood volumes by depth.

Parameters:

  • idxs_out (1D or 2D array of int) – Linear indices of unit-catchment outlet cells.

  • hand (2D array of float) – Height Above Nearest Drain (HAND) raster [m]; see hand().

  • depths (1D array of float, optional) – Flood depths [m] at which to calculate volume. By default, uses 0.5, 1.0, 1.5, 2.0, and 2.5 m.

Returns:

  • ucat_map (2D array of int with self.shape) – Unit-catchment ID for each high-resolution cell.

  • ucat_vol (array of float with shape (depths.size, *idxs_out.shape)) – Flood volume for each outlet at each depth [m3].