xrspatial.focal.focal_stats
How xarray-spatial runs Focal Statistics: xrspatial.focal.focal_stats.
| Engine | xarray-spatial |
|---|---|
| Tool name | xrspatial.focal.focal_stats |
| Interface | python |
| Implements | Focal Statistics |
| Documentation | Not stated |
| Effects | modifies input: no, network: no |
| Notes | Not stated |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
agg | any | yes | Not stated | Not stated | Not stated |
kernel | any | yes | Not stated | Not stated | Not stated |
stats_funcs | any | no | Not stated | Not stated | Not stated |
name | string | no | focal_stats | Not stated | Not stated |
boundary | string | no | nan | Not stated | Not stated |
How it maps to the operation
| Operation parameter | Parameter here | Note |
|---|---|---|
raster | agg | Not stated |
statistic | stats_funcs | A list of statistic names. |
size | Not stated | kernel: an array, e.g. from xrspatial.convolution.circle_kernel or a square of ones. |
Differences from the operation
None noted
Harvested by the python-packages harvester from engine version
0.10.20. Names can change when an engine is harvested again.