From: Bborie Park <bkpark at ucdavis.edu>
Date: Mon, 23 Jul 2012 22:57:24 +0000 (+0000)
Subject: Added to docs for ST_CoveredBy
X-Git-Tag: 2.1.0beta2~755
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d32e87cec74914bd897ce835ae5e530f7b72c11c;p=postgis

Added to docs for ST_CoveredBy

git-svn-id: http://svn.osgeo.org/postgis/trunk@10109 b70326c6-7e19-0410-871a-916f4a2858ee
---

diff --git a/NEWS b/NEWS
index 0828590e3..262f30630 100644
--- a/NEWS
+++ b/NEWS
@@ -15,7 +15,7 @@ PostGIS 2.1.0
   - ST_Raster2WorldCoord, ST_World2RasterCoord (Bborie Park / UC Davis)
   - Additional raster/raster spatial relationship functions
     (ST_Overlaps, ST_Touches, ST_Contains, ST_ContainsProperly, ST_Covers,
-    ST_Within)
+    ST_CoveredBy, 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 22ca17cf2..2efcefa52 100644
--- a/doc/reference_raster.xml
+++ b/doc/reference_raster.xml
@@ -9272,7 +9272,91 @@ a_rid | b_rid | overleft
 		<refsection>
 			<title>See Also</title>
 			<para>
-				<xref linkend="RT_ST_Intersects" />
+				<xref linkend="RT_ST_Intersects" />, 
+				<xref linkend="RT_ST_CoveredBy" />
+			</para>
+		</refsection>
+	</refentry>
+
+	<refentry id="RT_ST_CoveredBy">
+		<refnamediv>
+			<refname>ST_CoveredBy</refname>
+			<refpurpose>
+				Return true if no points of raster rastA lie outside raster rastB.
+			</refpurpose>
+		</refnamediv>
+
+		<refsynopsisdiv>
+			<funcsynopsis>
+				<funcprototype>
+					<funcdef>boolean <function>ST_CoveredBy</function></funcdef>
+					<paramdef>
+						<type>raster </type>
+						<parameter>rastA</parameter>
+					</paramdef>
+					<paramdef>
+						<type>integer </type>
+						<parameter>nbandA</parameter>
+					</paramdef>
+					<paramdef>
+						<type>raster </type>
+						<parameter>rastB</parameter>
+					</paramdef>
+					<paramdef>
+						<type>integer </type>
+						<parameter>nbandB</parameter>
+					</paramdef>
+				</funcprototype>
+
+				<funcprototype>
+					<funcdef>boolean <function>ST_CoveredBy</function></funcdef>
+					<paramdef>
+						<type>raster </type>
+						<parameter>rastA</parameter>
+					</paramdef>
+					<paramdef>
+						<type>raster </type>
+						<parameter>rastB</parameter>
+					</paramdef>
+				</funcprototype>
+
+			</funcsynopsis>
+		</refsynopsisdiv>
+
+		<refsection>
+			<title>Description</title>
+
+			<para>
+				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.
+			</para>
+
+			<note>
+				<para>
+					This operand will make use of any indexes that may be available on the rasters.
+				</para>
+			</note>
+
+			<note>
+				<para>
+					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)).
+				</para>
+			</note>
+
+			<para>Availability: 2.1.0</para>
+		</refsection>
+
+		<refsection>
+			<title>Examples</title>
+
+			<programlisting>
+-- needs an example
+			</programlisting>
+		</refsection>
+		<refsection>
+			<title>See Also</title>
+			<para>
+				<xref linkend="RT_ST_Intersects" />, 
+				<xref linkend="RT_ST_Covers" />
 			</para>
 		</refsection>
 	</refentry>