xrspatial.hydro.flow_path_dinf.flow_path_dinf#

xrspatial.hydro.flow_path_dinf.flow_path_dinf(flow_dir_dinf: DataArray, start_points: DataArray, name: str = 'flow_path_dinf') → DataArray[source]#

Trace downstream flow paths using D-infinity dominant neighbor.

Parameters:

  • flow_dir_dinf (xarray.DataArray or xr.Dataset) – 2D D-infinity flow direction grid. Values are continuous angles in radians [0, 2*pi), with -1.0 for pits and NaN for nodata.

  • start_points (xarray.DataArray) – 2D raster where non-NaN cells are path starting locations. Values are preserved as labels along the traced path.

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

Returns:

Same-shape grid where each cell on a traced path carries the label of its originating start point. All other cells are NaN. If paths overlap, the last start point in raster-scan order wins.

Return type:

xarray.DataArray or xr.Dataset