Hydrology#

Warning

NaN cells act as impassable barriers in all hydrology functions. Flow cannot cross them. If your DEM has NaN holes (e.g. water bodies masked out), fill or interpolate them first, or expect disconnected drainage networks.

Flow Direction (D8)#

xrspatial.hydro.flow_direction_d8.flow_direction_d8(agg)

Compute D8 flow direction for each cell.

Flow Direction (D-infinity)#

xrspatial.hydro.flow_direction_dinf.flow_direction_dinf(agg)

Compute D-infinity flow direction for each cell.

Flow Direction (MFD)#

xrspatial.hydro.flow_direction_mfd.flow_direction_mfd(agg)

Compute multiple flow direction fractions for each cell.

Flow Accumulation (D8)#

xrspatial.hydro.flow_accumulation_d8.flow_accumulation_d8(...)

Compute flow accumulation from a D8 flow direction grid.

Flow Accumulation (D-infinity)#

xrspatial.hydro.flow_accumulation_dinf.flow_accumulation_dinf(...)

Compute flow accumulation from a D-infinity flow direction grid.

Flow Accumulation (MFD)#

xrspatial.hydro.flow_accumulation_mfd.flow_accumulation_mfd(...)

Compute flow accumulation from an MFD flow direction grid.

Flow Length (D8)#

xrspatial.hydro.flow_length_d8.flow_length_d8(...)

Compute D8 flow length from a flow direction grid.

Flow Length (D-infinity)#

xrspatial.hydro.flow_length_dinf.flow_length_dinf(...)

Compute flow length from a D-infinity flow direction grid.

Flow Length (MFD)#

xrspatial.hydro.flow_length_mfd.flow_length_mfd(...)

Compute flow length from an MFD flow direction grid.

Flow Path (D8)#

xrspatial.hydro.flow_path_d8.flow_path_d8(...)

Trace downstream flow paths from start points through a D8 grid.

Flow Path (D-infinity)#

xrspatial.hydro.flow_path_dinf.flow_path_dinf(...)

Trace downstream flow paths using D-infinity dominant neighbor.

Flow Path (MFD)#

xrspatial.hydro.flow_path_mfd.flow_path_mfd(...)

Trace downstream flow paths using MFD dominant neighbor.

Fill#

xrspatial.hydro.fill_d8.fill_d8(dem[, ...])

Fill depressions in a DEM using Planchon-Darboux iterative flooding.

Sink#

xrspatial.hydro.sink_d8.sink_d8(flow_dir[, name])

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

Basin#

xrspatial.hydro.basin_d8.basin_d8(flow_dir)

Delineate drainage basins: every cell labeled with its outlet ID.

Watershed (D8)#

xrspatial.hydro.watershed_d8.watershed_d8(...)

Label each cell with the pour point it drains to.

xrspatial.hydro.watershed_d8.basins_d8(flow_dir)

Backward-compatible wrapper; use basin() instead.

Watershed (D-infinity)#

xrspatial.hydro.watershed_dinf.watershed_dinf(...)

Label each cell with the pour point it drains to (D-inf).

Watershed (MFD)#

xrspatial.hydro.watershed_mfd.watershed_mfd(...)

Label each cell with the pour point it drains to (MFD).

Snap Pour Point#

xrspatial.hydro.snap_pour_point_d8.snap_pour_point_d8(...)

Snap pour points to the highest-accumulation cell within a radius.

Stream Order (D8)#

xrspatial.hydro.stream_order_d8.stream_order_d8(...)

Compute stream order from D8 flow direction and accumulation grids.

Stream Order (D-infinity)#

xrspatial.hydro.stream_order_dinf.stream_order_dinf(...)

Compute stream order from D-infinity flow direction and accumulation.

Stream Order (MFD)#

xrspatial.hydro.stream_order_mfd.stream_order_mfd(...)

Compute stream order from MFD flow direction and accumulation grids.

Height Above Nearest Drainage (D8)#

xrspatial.hydro.hand_d8.hand_d8(flow_dir, ...)

Compute Height Above Nearest Drainage (HAND).

Height Above Nearest Drainage (D-infinity)#

xrspatial.hydro.hand_dinf.hand_dinf(...[, ...])

Compute HAND using D-infinity flow direction.

Height Above Nearest Drainage (MFD)#

xrspatial.hydro.hand_mfd.hand_mfd(...[, ...])

Compute HAND using MFD flow direction.

Topographic Wetness Index (TWI)#

xrspatial.hydro.twi_d8.twi_d8(flow_accum, ...)

Compute the Topographic Wetness Index.