RasterArray.clip
How rioxarray runs Clip raster: rioxarray.raster_array.RasterArray.clip.
| Engine | rioxarray |
|---|---|
| Tool name | rioxarray.raster_array.RasterArray.clip |
| Interface | python |
| Implements | Clip raster |
| Documentation | Not stated |
| Effects | modifies input: no, network: no |
| Notes | Not stated |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
geometries | Iterable | yes | Not stated | Not stated | Not stated |
crs | Optional | no | Not stated | Not stated | Not stated |
all_touched | bool | no | no | Not stated | Not stated |
drop | bool | no | yes | Not stated | Not stated |
invert | bool | no | no | Not stated | Not stated |
from_disk | bool | no | no | Not stated | Not stated |
How it maps to the operation
| Operation parameter | Parameter here | Note |
|---|---|---|
mask | geometries | Not stated |
all_touched | all_touched | Not stated |
bbox | Not stated | Use clip_box(minx, miny, maxx, maxy, crs=...) for a box. |
Differences from the operation
- Called through the .rio accessor of a DataArray (da.rio.clip); crs gives the geometries' CRS when it differs from the raster's.
Harvested by the python-packages harvester from engine version
0.23.0. Names can change when an engine is harvested again.