Move over ST_ConvexHull

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

diff --git a/doc/reference.xml b/doc/reference.xml
index 3408e1cf76189a7530a7ddd5516567d6804a8342..90e2c40d170add914bf0b7780437bb8fce96ad49 100644 (file)
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -113,30 +113,6 @@
           </listitem>
         </varlistentry>
 
-        <varlistentry>
-          <term>ST_ConvexHull(geometry)</term>
-
-          <listitem>
-            <para>The convex hull of a geometry represents the minimum closed
-            geometry that encloses all geometries within the set.</para>
-
-            <para>It is usually used with MULTI and Geometry Collections.
-            Although it is not an aggregate - you can use it in conjunction
-            with ST_Collect to get the convex hull of a set of points.
-            ST_ConvexHull(ST_Collect(somepointfield)). It is often used to
-            determine an affected area based on a set of point
-            observations.</para>
-
-            <programlisting>SELECT d.disease_type, ST_ConvexHull(ST_Collect(d.the_geom)) As the_geom 
-       FROM disease_obs As d 
-       GROUP BY d.disease_type</programlisting>
-
-            <para>Performed by the GEOS module</para>
-
-            <para>OGC SPEC s2.1.1.3</para>
-          </listitem>
-        </varlistentry>
-
         <varlistentry>
           <term>ST_Shift_Longitude(geometry)</term>
 
@@ -1657,24 +1633,6 @@ WHERE n*100.00/length &lt; 1;
           <para>SQL-MM 3: 5.1.14</para>
         </listitem>
       </varlistentry>
-  
-      <varlistentry>
-        <term>ST_ConvexHull</term>
-
-        <listitem>
-          <para>The convex hull of a geometry represents the minimum geometry
-          that encloses all geometries within the set.</para>
-
-          <para>It is usually used with MULTI and Geometry Collections.
-          Although it is not an aggregate - you can use it in conjunction with
-          ST_Collect to get the convex hull of a set of points.
-          ST_ConvexHull(ST_Collect(somepointfield)). It is often used to
-          determine an affected area based on a set of point
-          observations.</para>
-
-          <para>SQL-MM 3: 5.1.16</para>
-        </listitem>
-      </varlistentry>
 
       <varlistentry>
         <term>ST_CoordDim</term>

diff --git a/doc/reference_new.xml b/doc/reference_new.xml
index 9c31c9f06a24ee249dc79b13083a72f5c54261fd..f44899ac1f3b374388b78aa67f22e146d58eb115 100644 (file)
--- a/doc/reference_new.xml
+++ b/doc/reference_new.xml
@@ -5040,6 +5040,83 @@ SELECT ST_AsEWKT(ST_Collect(ST_GeomFromEWKT('POINT(1 2 3)'),
                <para><xref linkend="ST_Dump" />, <xref linkend="ST_Union" /></para>
          </refsection>
        </refentry>
+   
+       <refentry id="ST_ConvexHull">
+         <refnamediv>
+               <refname>ST_ConvexHull</refname>
+               <refpurpose>The convex hull of a geometry represents the minimum closed
+               geometry that encloses all geometries within the set.</refpurpose>
+         </refnamediv>
+       
+         <refsynopsisdiv>
+               <funcsynopsis>
+                 <funcprototype>
+                       <funcdef>geometry<function>ST_ConvexHull</function></funcdef>
+                       <paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
+                 </funcprototype>
+               </funcsynopsis>
+         </refsynopsisdiv>
+       
+         <refsection>
+               <title>Description</title>
+               <para>The convex hull of a geometry represents the minimum closed
+               geometry that encloses all geometries within the set.</para>
+
+            <para>It is usually used with MULTI and Geometry Collections.
+               Although it is not an aggregate - you can use it in conjunction
+               with ST_Collect to get the convex hull of a set of points.
+               ST_ConvexHull(ST_Collect(somepointfield)).</para>
+               
+               <para>It is often used to
+               determine an affected area based on a set of point
+               observations.</para>
+               
+               <para>Performed by the GEOS module</para>
+
+               <para>
+                         <inlinegraphic fileref="images/check.png" />
+                         This method implements the
+                         <ulink url="http://www.opengeospatial.org/standards/sfs">OpenGIS Simple
+                         Features Implementation Specification for SQL</ulink>  OGC SPEC s2.1.1.3 
+               </para>
+               <!-- Optionally mention 3d support -->
+               <para><inlinemediaobject>
+        <imageobject>
+          <imagedata fileref="images/check.png" />
+        </imageobject>
+               </inlinemediaobject> This function supports 3d and will not drop the z-index, but sometimes does something goofy with
+                       the z-index (elevation) when polygons are involved.</para>
+                       
+               <!-- Optionally mention SQL/MM compliancy if appropriate -->
+               <para><inlinemediaobject>
+                               <imageobject>
+                                 <imagedata fileref="images/check.png" />
+                               </imageobject>
+                         </inlinemediaobject> This method implements the SQL/MM specification: SQL-MM 3: 5.1.16</para>
+                       
+         </refsection>
+       
+         <refsection>
+               <title>Examples</title>
+<programlisting>SELECT d.disease_type, 
+       ST_ConvexHull(ST_Collect(d.the_geom)) As the_geom 
+       FROM disease_obs As d 
+       GROUP BY d.disease_type;
+       
+       SELECT ST_AsEWKT(ST_ConvexHull(
+               ST_Collect(
+                       ST_GeomFromEWKT('LINESTRING(1 2 3,3 4 5)'), 
+                               ST_MakePoint(0, 2, 0))
+                               ));
+       ---st_asewkt--
+       POLYGON((0 2 0,3 4 5,1 2 3,0 2 0))
+                               </programlisting>
+         </refsection>
+         <refsection>
+               <title>See Also</title>
+               <para><xref linkend="ST_Collect" /></para>
+         </refsection>
+       </refentry>       
        
        <refentry id="ST_Dump">
          <refnamediv>