xrspatial.hydro.sink_d8.sink_d8#

xrspatial.hydro.sink_d8.sink_d8(flow_dir: DataArray, name: str = 'sink') → DataArray[source]#

Identify and label depression cells in a D8 flow direction grid.

Finds cells with direction code 0 (pit/flat with no downhill neighbor) and labels connected groups using 8-connected component labeling.

Parameters:

  • flow_dir (xarray.DataArray or xr.Dataset) – 2D D8 flow direction grid (codes 0/1/2/4/8/16/32/64/128; NaN for nodata).

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

Returns:

2D float64 array where each sink cell is labeled with a unique group ID. Non-sink cells and NaN cells are NaN.

Return type:

xarray.DataArray or xr.Dataset