xrspatial.tpi
How xarray-spatial runs Topographic Position Index: xrspatial.tpi.
| Engine | xarray-spatial |
|---|---|
| Tool name | xrspatial.tpi |
| Interface | python |
| Implements | Topographic Position Index |
| Documentation | Not stated |
| Effects | modifies input: no, network: no |
| Notes | Not stated |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
agg | xr.DataArray | yes | Not stated | Not stated | Not stated |
name | Optional[str] | no | tpi | Not stated | Not stated |
boundary | str | no | nan | Not stated | Not stated |
How it maps to the operation
| Operation parameter | Parameter here | Note |
|---|---|---|
raster | agg | Not stated |
Differences from the operation
- Takes an xarray DataArray; edge cells are NaN by default (boundary = 'nan').
Harvested by the python-packages harvester from engine version
0.10.20. Names can change when an engine is harvested again.