Skip to main content
Returns a raster that is clipped by the given geometry. If crop is not specified then it will default to true, meaning it will make the resulting raster shrink to the geometry’s extent and if noDataValue is not specified then the resulting raster will have the minimum possible value for the band pixel data type. The allTouched parameter (Since v1.7.1) determines how pixels are selected:
  • When true, any pixel touched by the geometry will be included.
  • When false (default), only pixels whose centroid intersects with the geometry will be included.
  • Since v1.5.1, if the coordinate reference system (CRS) of the input geom geometry differs from that of the raster, then geom will be transformed to match the CRS of the raster. If the raster or geom doesn’t have a CRS then it will default to 4326/WGS84.
  • Since v1.7.0, RS_Clip function will return null if the raster and geometry geometry do not intersect. If you want to throw an exception in this case, you can set the lenient parameter to false.
RS_Clip

​
Signatures

RS_Clip(raster: Raster, band: Integer, geom: Geometry, allTouched: Boolean, noDataValue: Double, crop: Boolean, lenient: Boolean)

RS_Clip(raster: Raster, band: Integer, geom: Geometry, allTouched: Boolean, noDataValue: Double, crop: Boolean)

RS_Clip(raster: Raster, band: Integer, geom: Geometry, allTouched: Boolean, noDataValue: Double)

RS_Clip(raster: Raster, band: Integer, geom: Geometry, allTouched: Boolean)

RS_Clip(raster: Raster, band: Integer, geom: Geometry)

​
Parameters

​
raster
Raster
required
The input raster.
​
band
Integer
required
The band index.
​
geom
Geometry
required
The input geometry.
​
allTouched
Boolean
The all touched value.
​
noDataValue
Double
The NoData value to use for pixels outside the raster extent.
​
crop
Boolean
The crop value.
​
lenient
Boolean
The lenient value.

​
Return type

The resulting raster.

​
Examples

SELECT RS_Clip(
        RS_FromGeoTiff(content), 1,
        ST_GeomFromWKT('POLYGON ((236722 4204770, 243900 4204770, 243900 4197590, 221170 4197590, 236722 4204770))'),
        false, 200, true
    )

SELECT RS_Clip(
        RS_FromGeoTiff(content), 1,
        ST_GeomFromWKT('POLYGON ((236722 4204770, 243900 4204770, 243900 4197590, 221170 4197590, 236722 4204770))'),
        false, 200, false
    )