st_clip
How PostGIS Raster runs Clip raster: st_clip.
| Engine | PostGIS Raster |
|---|---|
| Tool name | st_clip |
| Interface | sql |
| Implements | Clip raster |
| Documentation | Not stated |
| Effects | modifies input: no, network: no |
| Notes | Not stated |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
rast | raster | no | Not stated | Not stated | Not stated |
geom | geometry | no | Not stated | Not stated | Not stated |
crop | boolean | no | true | Not stated | Not stated |
touched | boolean | no | false | Not stated | Not stated |
nodataval | double precision | double precision[] | no | NULL::double precision[] | Not stated | Not stated |
nband | integer | integer[] | no | Not stated | Not stated | Not stated |
SQL overloads
-
st_clip(rast raster, geom geometry, crop boolean, touched boolean DEFAULT false) → raster -
st_clip(rast raster, geom geometry, nodataval double precision, crop boolean DEFAULT true, touched boolean DEFAULT false) → raster -
st_clip(rast raster, geom geometry, nodataval double precision[] DEFAULT NULL::double precision[], crop boolean DEFAULT true, touched boolean DEFAULT false) → raster -
st_clip(rast raster, nband integer, geom geometry, crop boolean DEFAULT true, touched boolean DEFAULT false) → raster -
st_clip(rast raster, nband integer, geom geometry, nodataval double precision, crop boolean DEFAULT true, touched boolean DEFAULT false) → raster -
st_clip(rast raster, nband integer[], geom geometry, nodataval double precision[], crop boolean DEFAULT true, touched boolean DEFAULT false) → raster
How it maps to the operation
| Operation parameter | Parameter here | Note |
|---|---|---|
raster | rast | Not stated |
mask | geom | Not stated |
all_touched | touched | Not stated |
bbox | Not stated | Pass the box as a geometry (ST_MakeEnvelope). |
Differences from the operation
None noted
Harvested by the postgis harvester from engine version
3.7.0. Names can change when an engine is harvested again.