xrspatial.hillshade
How xarray-spatial runs Hillshade: xrspatial.hillshade.
| Engine | xarray-spatial |
|---|---|
| Tool name | xrspatial.hillshade |
| Interface | python |
| Implements | Hillshade |
| Documentation | Not stated |
| Effects | modifies input: no, network: no |
| Notes | Not stated |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
agg | DataArray | yes | Not stated | Not stated | Not stated |
azimuth | int | no | 225 | Not stated | Not stated |
angle_altitude | int | no | 25 | Not stated | Not stated |
name | Optional | no | hillshade | Not stated | Not stated |
shadows | bool | no | no | 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 |
azimuth | azimuth | Not stated |
altitude | angle_altitude | Not stated |
z_unit | Not stated | always crs-units. No vertical factor; elevations must be in the same units as the cell size. |
Differences from the operation
- Output is the illumination from 0 to 1 (GDAL and QGIS give 0 to 255).
- azimuth defaults to 225 and angle_altitude to 25 (Columbus and GDAL 315 and 45).
- Takes an xarray DataArray with x and y coordinates; edge cells are NaN by default.
Harvested by the python-packages harvester from engine version
0.10.20. Names can change when an engine is harvested again.