Updated NEWS and docs for ST_Touches()

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

diff --git a/NEWS b/NEWS
index 8a13e1ea5756e88f46d6da25c77d56c81b0b1c01..5aaca14c23fd4d87b9609d9a33ff9632b5d11d13 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -9,7 +9,7 @@ PostGIS 2.1.0
   - ST_PixelAsCentroid, ST_PixelAsCentroids (Bborie Park / UC Davis)
   - ST_Raster2WorldCoord, ST_World2RasterCoord (Bborie Park / UC Davis)
   - Additional raster/raster and raster/geometry spatial relationship
-    functions (ST_Overlaps) (Bborie Park / UC Davis)
+    functions (ST_Overlaps, ST_Touches) (Bborie Park / UC Davis)
   - #1643, Tiger Geocoder - Tiger 2011 loader (Regina Obe / Paragon Corporation) 
     Funded by Hunter Systems Group
   - GEOMETRYCOLLECTION support for ST_MakeValid (Sandro Santilli / Vizzuality)

diff --git a/doc/reference_raster.xml b/doc/reference_raster.xml
index ddbbe8f23d5fdeabd041f819fa7b903255481c5e..e4bc0b455f74fb07ee8e1ca513ecdc16161e5b6a 100644 (file)
--- a/doc/reference_raster.xml
+++ b/doc/reference_raster.xml
@@ -8864,7 +8864,7 @@ WHERE A.rid =2 ;
                        <refsection>
                                <title>See Also</title>
                                <para>
-                                       <xref linkend="RT_ST_Overlaps" />
+                                       <xref linkend="RT_ST_Intersection" />
                                </para>
                        </refsection>
                </refentry>
@@ -8998,7 +8998,137 @@ WHERE A.rid =2 ;
                        </para>
                </refsection>
        </refentry>
-               
+
+       <refentry id="RT_ST_Touches">
+               <refnamediv>
+                       <refname>ST_Touches</refname>
+                       <refpurpose>
+                               Return true if the raster spatially touch a separate raster or geometry. 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.
+                       </refpurpose>
+               </refnamediv>
+
+               <refsynopsisdiv>
+                       <funcsynopsis>
+                               <funcprototype>
+                                       <funcdef>boolean <function>ST_Touches</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_Touches</function></funcdef>
+                                       <paramdef>
+                                               <type>raster </type>
+                                               <parameter>rasta</parameter>
+                                       </paramdef>
+                                       <paramdef>
+                                               <type>raster </type>
+                                               <parameter>rastb</parameter>
+                                       </paramdef>
+                               </funcprototype>
+
+                               <funcprototype>
+                                       <funcdef>boolean <function>ST_Touches</function></funcdef>
+                                       <paramdef>
+                                               <type>raster </type>
+                                               <parameter>rast</parameter>
+                                       </paramdef>
+                                       <paramdef>
+                                               <type>integer </type>
+                                               <parameter>nband</parameter>
+                                       </paramdef>
+                                       <paramdef>
+                                               <type>geometry </type>
+                                               <parameter>geommin</parameter>
+                                       </paramdef>
+                               </funcprototype>
+
+                               <funcprototype>
+                                       <funcdef>boolean <function>ST_Touches</function></funcdef>
+                                       <paramdef>
+                                               <type>raster </type>
+                                               <parameter>rast</parameter>
+                                       </paramdef>
+                                       <paramdef>
+                                               <type>geometry </type>
+                                               <parameter>geommin</parameter>
+                                       </paramdef>
+                                       <paramdef choice='opt'>
+                                               <type>integer </type>
+                                               <parameter>nband=NULL</parameter>
+                                       </paramdef>
+                               </funcprototype>
+
+                               <funcprototype>
+                                       <funcdef>boolean <function>ST_Touches</function></funcdef>
+                                       <paramdef>
+                                               <type>geometry </type>
+                                               <parameter>geommin</parameter>
+                                       </paramdef>
+                                       <paramdef>
+                                               <type>raster </type>
+                                               <parameter>rast</parameter>
+                                       </paramdef>
+                                       <paramdef choice='opt'>
+                                               <type>integer </type>
+                                               <parameter>nband=NULL</parameter>
+                                       </paramdef>
+                               </funcprototype>
+
+                       </funcsynopsis>
+               </refsynopsisdiv>
+
+               <refsection>
+                       <title>Description</title>
+
+                       <para>
+                               Return true if the raster spatially touches a separate raster or geometry. This means that the raster/raster or raster/geometry combinations have at least one point in common but their interiors do not intersect. 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>
+                                       Depending on the order that the raster and geometry is passed to ST_Touches(), the test will operate in either raster-space or geometry-space.  If ST_Touches(raster, ....), the test is in raster-space (the geometry is converted to a raster).  If ST_Touches(geometry, ...), the test is in geometry-space (the raster is converted to a set of pixel polygons).
+                               </para>
+                       </note>
+
+                       <note>
+                               <para>
+                                       This operand will make use of any indexes that may be available on the geometries / rasters.
+                               </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" />
+                       </para>
+               </refsection>
+       </refentry>
+
        <refentry id="RT_ST_SameAlignment">
                <refnamediv>
                        <refname>ST_SameAlignment</refname>