PostGIS

ST_CoveredBy
Prev	12.17. Raster and Raster Band Spatial Relationships	Next

ST_CoveredBy

12.17. Raster and Raster Band Spatial Relationships

Name

ST_CoveredBy — Return true if no points of raster rastA lie outside raster rastB.

Synopsis

boolean +`*`+ST_CoveredBy*( raster rastA , integer nbandA , raster rastB , integer nbandB );

boolean +`*`+ST_CoveredBy*( raster rastA , raster rastB );

Description

Raster rastA is covered by rastB if and only if no points of rastA lie in the exterior of rastB. If the band number is not provided (or set to NULL), only the convex hull of the raster is considered in the test. If the band number is provided, only those pixels with value (not NODATA) are considered in the test.

This function will make use of any indexes that may be available on the rasters.

To test the spatial relationship of a raster and a geometry, use ST_Polygon on the raster, e.g. ST_CoveredBy(ST_Polygon(raster), geometry) or ST_CoveredBy(geometry, ST_Polygon(raster)).

Availability: 2.1.0

Examples

SELECT r1.rid, r2.rid, ST_CoveredBy(r1.rast, 1, r2.rast, 1) FROM dummy_rast r1 CROSS JOIN dummy_rast r2 WHERE r1.rid = 2;

 rid | rid | st_coveredby
-----+-----+--------------
   2 |   1 | f
   2 |   2 | t

PostGIS

Name

Synopsis

Description

Examples

See Also