Skip to content

Commit 03f2f73

Browse files
committed
Add corridor docs, user guide notebook, and README entry (#965)
Adds API reference entry under Proximity, a user guide notebook (20_Corridor_Analysis) covering all major features, and a row in the README feature matrix.
1 parent 4a860bc commit 03f2f73

File tree

3 files changed

+460
-0
lines changed

3 files changed

+460
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,7 @@ In the GIS world, rasters are used for representing continuous phenomena (e.g. e
228228
| [Allocation](xrspatial/proximity.py) | Assigns each cell to the identity of the nearest source feature | ✅️ || ✅️ | ✅️ |
229229
| [Balanced Allocation](xrspatial/balanced_allocation.py) | Partitions a cost surface into territories of roughly equal cost-weighted area | ✅️ || ✅️ | ✅️ |
230230
| [Cost Distance](xrspatial/cost_distance.py) | Computes minimum accumulated cost to the nearest source through a friction surface | ✅️ || ✅️ | ✅️ |
231+
| [Least-Cost Corridor](xrspatial/corridor.py) | Identifies zones of low cumulative cost between two source locations | ✅️ || ✅️ | ✅️ |
231232
| [Direction](xrspatial/proximity.py) | Computes the direction from each cell to the nearest source feature | ✅️ || ✅️ | ✅️ |
232233
| [Proximity](xrspatial/proximity.py) | Computes the distance from each cell to the nearest source feature | ✅️ || ✅️ | ✅️ |
233234
| [Surface Distance](xrspatial/surface_distance.py) | Computes distance along the 3D terrain surface to the nearest source | ✅️ || ✅️ | ✅️ |

docs/source/reference/proximity.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,13 @@ Cost Distance
3535

3636
xrspatial.cost_distance.cost_distance
3737

38+
Least-Cost Corridor
39+
====================
40+
.. autosummary::
41+
:toctree: _autosummary
42+
43+
xrspatial.corridor.least_cost_corridor
44+
3845
Balanced Allocation
3946
====================
4047
.. autosummary::

0 commit comments

Comments
 (0)