terra::crop
How terra runs Clip raster: terra::crop.
| Engine | terra |
|---|---|
| Tool name | terra::crop |
| Interface | r |
| Implements | Clip raster |
| Preset | {"mask":true} |
| Documentation | Not stated |
| Effects | modifies input: no, network: no |
| Notes | S4 generic: parameters gathered from all its methods; each method takes a subset. |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
x | any | yes | Not stated | Not stated | Not stated |
y | any | yes | Not stated | Not stated | Not stated |
... | dots | no | Not stated | Not stated | further arguments passed on |
snap | any | no | "near" | Not stated | Not stated |
mask | any | no | FALSE | Not stated | Not stated |
touches | any | no | TRUE | Not stated | Not stated |
extend | any | no | FALSE | Not stated | Not stated |
filename | any | no | "" | Not stated | Not stated |
ext | any | no | FALSE | Not stated | Not stated |
How it maps to the operation
| Operation parameter | Parameter here | Note |
|---|---|---|
raster | x | Not stated |
mask | y | Not stated |
bbox | Not stated | Pass the box as a SpatExtent (ext(xmin, xmax, ymin, ymax)) in y. |
all_touched | touches | Not stated |
Differences from the operation
- touches defaults to TRUE (cells touched by the mask are kept); Columbus and GDAL default to cell centres.
- Without mask = TRUE, crop only cuts to the mask's extent.
Harvested by the r-packages harvester from engine version
1.9.50. Names can change when an engine is harvested again.