hydromt.gis.flw.stream_map#

hydromt.gis.flw.stream_map(ds, *, stream=None, **stream_kwargs)[source]#

Return a stream mask DataArray.

Parameters:

ds (xarray.Dataset) – dataset containing all maps for stream criteria
stream (2D array of bool, optional) – Initial mask of stream cells. If a stream if provided, it is combined with the threshold based map using a logical AND operation.
stream_kwargs (dict, optional) – Parameter: minimum threshold pairs to define streams. Multiple threshold will be combined using a logical AND operation.

Returns:

stream – stream mask

Return type:

xarray.DataArray of bool