From: Bborie Park <bkpark at ucdavis.edu>
Date: Wed, 25 Jul 2012 03:36:10 +0000 (+0000)
Subject: Added docs for ST_DFullyWithin(raster, raster)
X-Git-Tag: 2.1.0beta2~748
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3dbe5cbd37318161c47acbde0374b407414e9921;p=postgis

Added docs for ST_DFullyWithin(raster, raster)

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

diff --git a/NEWS b/NEWS
index a61cf34e3..e045b4c87 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_Contains, ST_ContainsProperly, ST_Covers, ST_CoveredBy, ST_Disjoint,
-    ST_Overlaps, ST_Touches, ST_Within, ST_DWithin)
+    ST_Overlaps, ST_Touches, ST_Within, ST_DWithin, ST_DFullyWithin)
     (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 424566557..937ae7ac2 100644
--- a/doc/reference_raster.xml
+++ b/doc/reference_raster.xml
@@ -9658,7 +9658,9 @@ NOTICE:  The two rasters provided have different SRIDs
 			<title>See Also</title>
 			<para>
 				<xref linkend="RT_ST_Intersects" />, 
-				<xref linkend="RT_ST_Contains" />
+				<xref linkend="RT_ST_Contains" />, 
+				<xref linkend="RT_ST_DWithin" />, 
+				<xref linkend="RT_ST_DFullyWithin" />
 			</para>
 		</refsection>
 	</refentry>
@@ -9752,7 +9754,103 @@ NOTICE:  The two rasters provided have different SRIDs
 		<refsection>
 			<title>See Also</title>
 			<para>
-				<xref linkend="RT_ST_Within" />
+				<xref linkend="RT_ST_Within" />, 
+				<xref linkend="RT_ST_DFullyWithin" />
+			</para>
+		</refsection>
+	</refentry>
+
+	<refentry id="RT_ST_DFullyWithin">
+		<refnamediv>
+			<refname>ST_DFullyWithin</refname>
+			<refpurpose>
+				Return true if rasters rastA and rastB are fully within the specified distance of each other.
+			</refpurpose>
+		</refnamediv>
+
+		<refsynopsisdiv>
+			<funcsynopsis>
+				<funcprototype>
+					<funcdef>boolean <function>ST_DFullyWithin</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>
+					<paramdef>
+						<type>double precision </type>
+						<parameter>distance_of_srid</parameter>
+					</paramdef>
+				</funcprototype>
+
+				<funcprototype>
+					<funcdef>boolean <function>ST_DFullyWithin</function></funcdef>
+					<paramdef>
+						<type>raster </type>
+						<parameter>rastA</parameter>
+					</paramdef>
+					<paramdef>
+						<type>raster </type>
+						<parameter>rastB</parameter>
+					</paramdef>
+					<paramdef>
+						<type>double precision </type>
+						<parameter>distance_of_srid</parameter>
+					</paramdef>
+				</funcprototype>
+
+			</funcsynopsis>
+		</refsynopsisdiv>
+
+		<refsection>
+			<title>Description</title>
+
+			<para>
+				Return true if rasters rastA and rastB are fully within the specified distance of each other. 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>
+
+			<para>
+				The distance is specified in units defined by the spatial reference system of the rasters. For this function to make sense, the source rasters must both be of the same coordinate projection, having the same SRID.
+			</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_DFullyWithin(ST_Polygon(raster), geometry).
+				</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_Within" />, 
+				<xref linkend="RT_ST_DWithin" />
 			</para>
 		</refsection>
 	</refentry>