hydromt_sfincs.workflows.river_boundary_points#
- hydromt_sfincs.workflows.river_boundary_points(region: GeoDataFrame, res: float, gdf_riv: GeoDataFrame | None = None, da_flwdir: DataArray | None = None, da_uparea: DataArray | None = None, river_upa: float = 10, river_len: float = 1000.0, inflow: bool = True) Tuple[GeoDataFrame, GeoDataFrame][source]#
Returns the locations where a river flows in (inflow=True) or out (inflow=False) of the model region.
Rivers are based on either a river network vector data (gdf_riv) or a flow direction raster data (da_flwdir).
- Parameters:
region (geopandas.GeoDataFrame) – Polygon of model region of interest.
res (float) – Model resolution [m].
gdf_riv (geopandas.GeoDataFrame, optional) – River network vector data, by default None.
da_flwdir (xarray.DataArray, optional) – D8 flow direction raster data, by default None.
da_uparea (xarray.DataArray, optional) – River upstream area raster data, by default None.
river_upa (float, optional) – Minimum upstream area threshold for rivers [km2], by default 10.0
river_len (float, optional) – Mimimum river length [m] within the model domain to define river cells, by default 1000 m.
inflow (bool, optional) – If True, return inflow otherwise outflow boundary points, by default True.
- Returns:
gdf_src, gdf_riv – In-/outflow points and river line vector data.
- Return type: