Skip to content

Commit 0a05e7e

Browse files
committed
Add missing functions to README feature matrix
Adds three sections and six functions that were exported from xrspatial but not listed in the README: - Reproject / Merge: reproject, merge (new section) - Flood: vegetation_roughness, vegetation_curve_number, flood_depth_vegetation (3 functions added to existing section) - Dasymetric: disaggregate, pycnophylactic (new section)
1 parent 097d73e commit 0a05e7e

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,15 @@ In the GIS world, rasters are used for representing continuous phenomena (e.g. e
255255

256256
--------
257257

258+
### **Reproject / Merge**
259+
260+
| Name | Description | Source | NumPy xr.DataArray | Dask xr.DataArray | CuPy GPU xr.DataArray | Dask GPU xr.DataArray |
261+
|:----------:|:------------|:------:|:----------------------:|:--------------------:|:-------------------:|:------:|
262+
| [Reproject](xrspatial/reproject/__init__.py) | Reprojects a raster to a new CRS using an approximate transform and numba JIT resampling | Standard (inverse mapping) | ✅️ | ✅️ | ✅️ | ✅️ |
263+
| [Merge](xrspatial/reproject/__init__.py) | Merges multiple rasters into a single mosaic with configurable overlap strategy | Standard (mosaic) | ✅️ | ✅️ | 🔄 | 🔄 |
264+
265+
-------
266+
258267
### **Raster / Vector Conversion**
259268

260269
| Name | Description | Source | NumPy xr.DataArray | Dask xr.DataArray | CuPy GPU xr.DataArray | Dask GPU xr.DataArray |
@@ -324,6 +333,9 @@ In the GIS world, rasters are used for representing continuous phenomena (e.g. e
324333
| [Inundation](xrspatial/flood.py) | Produces a binary flood/no-flood mask from a HAND raster and water level | Standard (HAND-based) | ✅️ | ✅️ | ✅️ | ✅️ |
325334
| [Curve Number Runoff](xrspatial/flood.py) | Estimates runoff depth from rainfall using the SCS/NRCS curve number method | SCS/NRCS | ✅️ | ✅️ | ✅️ | ✅️ |
326335
| [Travel Time](xrspatial/flood.py) | Estimates overland flow travel time via simplified Manning's equation | Manning 1891 | ✅️ | ✅️ | ✅️ | ✅️ |
336+
| [Vegetation Roughness](xrspatial/flood.py) | Derives Manning's roughness coefficients from NLCD land cover or NDVI | SCS/NRCS | ✅️ | ✅️ | ✅️ | ✅️ |
337+
| [Vegetation Curve Number](xrspatial/flood.py) | Derives SCS curve numbers from land cover and hydrologic soil group | SCS/NRCS | ✅️ | ✅️ | ✅️ | ✅️ |
338+
| [Flood Depth (Vegetation)](xrspatial/flood.py) | Manning-based steady-state flow depth incorporating vegetation roughness | Manning 1891 | ✅️ | ✅️ | ✅️ | ✅️ |
327339

328340
-----------
329341

@@ -337,6 +349,15 @@ In the GIS world, rasters are used for representing continuous phenomena (e.g. e
337349

338350
-----------
339351

352+
### **Dasymetric**
353+
354+
| Name | Description | Source | NumPy xr.DataArray | Dask xr.DataArray | CuPy GPU xr.DataArray | Dask GPU xr.DataArray |
355+
|:----------:|:------------|:------:|:----------------------:|:--------------------:|:-------------------:|:------:|
356+
| [Disaggregate](xrspatial/dasymetric.py) | Redistributes zonal totals to pixels using an ancillary weight surface | Mennis 2003 | ✅️ | ✅️ | ✅️ | ✅️ |
357+
| [Pycnophylactic](xrspatial/dasymetric.py) | Tobler's pycnophylactic interpolation preserving zone totals via Laplacian smoothing | Tobler 1979 | ✅️ | | | |
358+
359+
-----------
360+
340361
### **Zonal**
341362

342363
| Name | Description | Source | NumPy xr.DataArray | Dask xr.DataArray | CuPy GPU xr.DataArray | Dask GPU xr.DataArray |

0 commit comments

Comments
 (0)