From: Bborie Park Date: Mon, 23 Jul 2012 22:56:58 +0000 (+0000) Subject: Added docs for ST_Covers() X-Git-Tag: 2.1.0beta2~759 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=128bd41e794d823542c62c10980323470efed617;p=postgis Added docs for ST_Covers() git-svn-id: http://svn.osgeo.org/postgis/trunk@10105 b70326c6-7e19-0410-871a-916f4a2858ee --- diff --git a/NEWS b/NEWS index 21ea5aedc..0828590e3 100644 --- a/NEWS +++ b/NEWS @@ -14,7 +14,8 @@ PostGIS 2.1.0 - ST_PixelAsCentroid, ST_PixelAsCentroids (Bborie Park / UC Davis) - ST_Raster2WorldCoord, ST_World2RasterCoord (Bborie Park / UC Davis) - Additional raster/raster spatial relationship functions - (ST_Overlaps, ST_Touches, ST_Contains, ST_ContainsProperly, ST_Within) + (ST_Overlaps, ST_Touches, ST_Contains, ST_ContainsProperly, ST_Covers, + ST_Within) (Bborie Park / UC Davis) - #1643, Tiger Geocoder - Tiger 2011 loader (Regina Obe / Paragon Corporation) Funded by Hunter Systems Group diff --git a/doc/reference_raster.xml b/doc/reference_raster.xml index ab9b5fae8..4dac6da3d 100644 --- a/doc/reference_raster.xml +++ b/doc/reference_raster.xml @@ -8726,7 +8726,7 @@ a_rid | b_rid | overleft ST_Intersects - Return true if raster rastA spatially intersects raster 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. + Return true if raster rastA spatially intersects raster rastB. @@ -8859,7 +8859,7 @@ a_rid | b_rid | overleft ST_Overlaps - Return true if raster rastA spatially overlaps raster 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. + Return true if raster rastA and rastB intersect but one does not completely contain the other. @@ -8941,7 +8941,7 @@ a_rid | b_rid | overleft ST_Touches - Return true if raster rastA spatially touch raster 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. + Return true if raster rastA and rastB have at least one point in common but their interiors do not intersect. @@ -9023,7 +9023,7 @@ a_rid | b_rid | overleft ST_Contains - Return true if no points of raster rastB lie in the exterior of raster rastA and at least one point of the interior of rastB lies in the interior of rastA. 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. + Return true if no points of raster rastB lie in the exterior of raster rastA and at least one point of the interior of rastB lies in the interior of rastA. @@ -9112,7 +9112,7 @@ a_rid | b_rid | overleft ST_ContainsProperly - Return true if rastB intersects the interior of rastA but not the boundary or exterior of rastA. 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. + Return true if rastB intersects the interior of rastA but not the boundary or exterior of rastA. @@ -9195,18 +9195,18 @@ a_rid | b_rid | overleft - + - ST_Within + ST_Covers - Return true if no points of raster rastA lie in the exterior of raster rastB and at least one point of the interior of rastA lies in the interior 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. + Return true if no points of raster rastB lie outside raster rastA. - boolean ST_Within + boolean ST_Covers raster rastA @@ -9226,7 +9226,7 @@ a_rid | b_rid | overleft - boolean ST_Within + boolean ST_Covers raster rastA @@ -9244,7 +9244,7 @@ a_rid | b_rid | overleft Description - Raster rastA is within rastB if and only if no points of rastA lie in the exterior of rastB and at least one point of the interior of rastA lies in the interior 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. + Raster rastA covers rastB if and only if no points of rastB lie in the exterior of rastA. 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. @@ -9255,13 +9255,7 @@ a_rid | b_rid | overleft - To test the spatial relationship of a raster and a geometry, use ST_Polygon on the raster, e.g. ST_Within(ST_Polygon(raster), geometry) or ST_Within(geometry, ST_Polygon(raster)). - - - - - - ST_Within() is the inverse of ST_Contains(). So, ST_Within(rastA, rastB) implies ST_Contains(rastB, rastA). + To test the spatial relationship of a raster and a geometry, use ST_Polygon on the raster, e.g. ST_Covers(ST_Polygon(raster), geometry) or ST_Covers(geometry, ST_Polygon(raster)). @@ -9278,8 +9272,7 @@ a_rid | b_rid | overleft See Also - , - , + @@ -9414,5 +9407,95 @@ NOTICE: The two rasters provided have different SRIDs , + + + + ST_Within + + Return true if no points of raster rastA lie in the exterior of raster rastB and at least one point of the interior of rastA lies in the interior of rastB. + + + + + + + boolean ST_Within + + raster + rastA + + + integer + nbandA + + + raster + rastB + + + integer + nbandB + + + + + boolean ST_Within + + raster + rastA + + + raster + rastB + + + + + + + + Description + + + Raster rastA is within rastB if and only if no points of rastA lie in the exterior of rastB and at least one point of the interior of rastA lies in the interior 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 operand 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_Within(ST_Polygon(raster), geometry) or ST_Within(geometry, ST_Polygon(raster)). + + + + + + ST_Within() is the inverse of ST_Contains(). So, ST_Within(rastA, rastB) implies ST_Contains(rastB, rastA). + + + + Availability: 2.1.0 + + + + Examples + + +-- needs an example + + + + See Also + + , + , + + + +