]> granicus.if.org Git - postgis/commitdiff
Move over st_simplify and st_simplifypreservetopology. Still need to put in examples.
authorRegina Obe <lr@pcorp.us>
Tue, 14 Oct 2008 18:16:03 +0000 (18:16 +0000)
committerRegina Obe <lr@pcorp.us>
Tue, 14 Oct 2008 18:16:03 +0000 (18:16 +0000)
git-svn-id: http://svn.osgeo.org/postgis/trunk@3103 b70326c6-7e19-0410-871a-916f4a2858ee

doc/reference.xml
doc/reference_new.xml

index 0cd079125c235b8df6cf81cb254431686afc02ae..79a1e7d99ac143fa8d91d3661dee5d9215ffc855 100644 (file)
@@ -1095,30 +1095,6 @@ z' = z </programlisting> This method is a subcase of the 3D method
           </listitem>
         </varlistentry>
 
-        <varlistentry>
-          <term>ST_Simplify(geometry, tolerance)</term>
-
-          <listitem>
-            <para>Returns a "simplified" version of the given geometry using
-            the Douglas-Peuker algorithm. Will actually do something only with
-            (multi)lines and (multi)polygons but you can safely call it with
-            any kind of geometry. Since simplification occurs on a
-            object-by-object basis you can also feed a GeometryCollection to
-            this function. Note that returned geometry might loose its
-            simplicity (see <xref linkend="ST_IsSimple" />)</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
-          <term>ST_SimplifyPreserveTopology(geometry, tolerance)</term>
-
-          <listitem>
-            <para>Returns a "simplified" version of the given geometry using
-            the Douglas-Peuker algorithm. Will avoid creating derived
-            geometries (polygons in particular) that are invalid.</para>
-          </listitem>
-        </varlistentry>
-
         <varlistentry>
           <term>ST_SnapToGrid(geometry, originX, originY, sizeX, sizeY)</term>
 
index c1bc18b261d989056fbcffdcfa71a91cd547822e..f672fd6e62f62d2f60a63bccf09ace60528bff4e 100644 (file)
@@ -5654,7 +5654,103 @@ geomtextrep
                        <para><xref linkend="ST_Dump" /></para>
                </refsection>
        </refentry>     
+               
+       <refentry id="ST_Simplify">
+         <refnamediv>
+               <refname>ST_Simplify</refname>
+               <refpurpose>Returns a "simplified" version of the given geometry using
+                               the Douglas-Peuker algorithm.</refpurpose>
+         </refnamediv>
+       
+         <refsynopsisdiv>
+               <funcsynopsis>
+                 <funcprototype>
+                       <funcdef>geometry <function>ST_Simplify</function></funcdef>
+                       <paramdef><type>geometry</type> <parameter>geomA</parameter></paramdef>
+                       <paramdef><type>float</type> <parameter>tolerance</parameter></paramdef>
+                 </funcprototype>
+               </funcsynopsis>
+         </refsynopsisdiv>
+       
+         <refsection>
+               <title>Description</title>
+               <para>Returns a "simplified" version of the given geometry using
+                               the Douglas-Peuker algorithm. Will actually do something only with
+                               (multi)lines and (multi)polygons but you can safely call it with
+                               any kind of geometry. Since simplification occurs on a
+                               object-by-object basis you can also feed a GeometryCollection to
+                               this function.</para>
+                       
+               <note><para>Note that returned geometry might loose its
+                               simplicity (see <xref linkend="ST_IsSimple" />)</para></note>
+               <note><para>Note topology may not be preserved and may result in invalid geometries.  Use  (see <xref linkend="ST_SimplifyPreserveTopology" />) to preserve topology.</para></note>
+                       
+               <para>Performed by the GEOS module.</para>
+               <para>Availability: 1.2.2</para>
+         </refsection>
+               
+                 <refsection>
+                       <title>Examples</title>
+                       <para>Forthcoming</para>
+                               <programlisting>
+                               <!-- TODO: Need examples -->
+       
+                               </programlisting>
+                 </refsection>
+                 <refsection>
+                       <title>See Also</title>
+                       <para><xref linkend="ST_SimplifyPreserveTopology" /></para>
+                 </refsection>
+       </refentry>
+
+       <refentry id="ST_SimplifyPreserveTopology">
+         <refnamediv>
+               <refname>ST_SimplifyPreserveTopology</refname>
+               <refpurpose>Returns a "simplified" version of the given geometry using
+            the Douglas-Peuker algorithm. Will avoid creating derived
+            geometries (polygons in particular) that are invalid.</refpurpose>
+         </refnamediv>
+       
+         <refsynopsisdiv>
+               <funcsynopsis>
+                 <funcprototype>
+                       <funcdef>geometry <function>ST_SimplifyPreserveTopology</function></funcdef>
+                       <paramdef><type>geometry</type> <parameter>geomA</parameter></paramdef>
+                       <paramdef><type>float</type> <parameter>tolerance</parameter></paramdef>
+                 </funcprototype>
+               </funcsynopsis>
+         </refsynopsisdiv>
+       
+         <refsection>
+               <title>Description</title>
+               <para>Returns a "simplified" version of the given geometry using
+            the Douglas-Peuker algorithm. Will avoid creating derived
+            geometries (polygons in particular) that are invalid. Will actually do something only with
+                               (multi)lines and (multi)polygons but you can safely call it with
+                               any kind of geometry. Since simplification occurs on a
+                               object-by-object basis you can also feed a GeometryCollection to
+                               this function.</para>
+                                       
+               <para>Performed by the GEOS module.</para>
+               <note><para>Requires GEOS 3.0.0+</para></note>
+               <para>Availability: 1.3.3</para>
+         </refsection>
+               
+                 <refsection>
+                       <title>Examples</title>
+                       <para>Forthcoming</para>
+                               <programlisting>
+                               <!-- TODO: Need examples -->
        
+                               </programlisting>
+                 </refsection>
+                 <refsection>
+                       <title>See Also</title>
+                       <para><xref linkend="ST_Simplify" /></para>
+                 </refsection>
+       </refentry>
+               
+               
 <refentry id="ST_Union">
   <refnamediv>
        <refname>ST_Union</refname>