Move ST_Retile documentation under "raster constructors"

Add note about difference from ST_Tile, link ST_Tile and ST_Resample

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

diff --git a/doc/reference_raster.xml b/doc/reference_raster.xml
index 050afd6b4165716e93cf49f4a9d290867106766d..d65aedea514e35050fe22b4985784e601d704454 100644 (file)
--- a/doc/reference_raster.xml
+++ b/doc/reference_raster.xml
@@ -1327,55 +1327,6 @@ WHERE short_name = 'GTiff') As g;
       </refsection>
                </refentry>
 
-               <refentry id="RT_Retile">
-                       <refnamediv>
-                               <refname>ST_Retile</refname>
-                               <refpurpose>
-                                       Return a set of configured tiles from an arbitrarily tiled raster coverage.
-                               </refpurpose>
-                       </refnamediv>
-
-                       <refsynopsisdiv>
-                               <funcsynopsis>
-
-                                       <funcprototype>
-                                               <funcdef>SETOF raster <function>ST_Retile</function></funcdef>
-                                               <paramdef><type>regclass </type> <parameter>tab</parameter></paramdef>
-                                               <paramdef><type>name </type> <parameter>col</parameter></paramdef>
-                                               <paramdef><type>geometry </type> <parameter>ext</parameter></paramdef>
-                                               <paramdef><type>float8 </type> <parameter>sfx</parameter></paramdef>
-                                               <paramdef><type>float8 </type> <parameter>sfy</parameter></paramdef>
-                                               <paramdef><type>int </type> <parameter>tw</parameter></paramdef>
-                                               <paramdef><type>int </type> <parameter>th</parameter></paramdef>
-                                         <paramdef choice="opt"><type>text </type> <parameter>algo='NearestNeighbor'</parameter></paramdef>
-                                       </funcprototype>
-
-                               </funcsynopsis>
-                       </refsynopsisdiv>
-
-                       <refsection>
-                               <title>Description</title> 
-
-                               <para>
-Return a set of tiles having the specified scale (<varname>sfx</varname>,
-<varname>sfy</varname>) and max size (<varname>tw</varname>,
-<varname>th</varname>) and covering the specified extent
-(<varname>ext</varname>) with data coming from the specified
-raster coverage (<varname>tab</varname>, <varname>col</varname>).
-                               </para>
-
-                               <para>Algorithm options are: 'NearestNeighbor', 'Bilinear', 'Cubic', 'CubicSpline', and 'Lanczos'.  Refer to: <ulink url="http://www.gdal.org/gdalwarp.html">GDAL Warp resampling methods</ulink> for more details.</para>
-
-                               <para>Availability: 2.2.0</para>
-                       </refsection> 
-      <refsection>
-        <title>See Also</title>
-        <para>
-          <xref linkend="RT_CreateOverview"/>
-        </para>
-      </refsection>
-               </refentry>
-
                <refentry id="RT_CreateOverview">
                        <refnamediv>
                                <refname>ST_CreateOverview</refname>
@@ -2214,12 +2165,69 @@ FROM baz;
                        <refsection>
                                <title>See Also</title>
                                <para>
-                                       <xref linkend="RT_ST_Union" />
+                                       <xref linkend="RT_ST_Union" />,
+                                       <xref linkend="RT_Retile" />
                                </para>
                        </refsection>
 
                </refentry>
 
+               <refentry id="RT_Retile">
+                       <refnamediv>
+                               <refname>ST_Retile</refname>
+                               <refpurpose>
+                                       Return a set of configured tiles from an arbitrarily tiled raster coverage.
+                               </refpurpose>
+                       </refnamediv>
+
+                       <refsynopsisdiv>
+                               <funcsynopsis>
+
+                                       <funcprototype>
+                                               <funcdef>SETOF raster <function>ST_Retile</function></funcdef>
+                                               <paramdef><type>regclass </type> <parameter>tab</parameter></paramdef>
+                                               <paramdef><type>name </type> <parameter>col</parameter></paramdef>
+                                               <paramdef><type>geometry </type> <parameter>ext</parameter></paramdef>
+                                               <paramdef><type>float8 </type> <parameter>sfx</parameter></paramdef>
+                                               <paramdef><type>float8 </type> <parameter>sfy</parameter></paramdef>
+                                               <paramdef><type>int </type> <parameter>tw</parameter></paramdef>
+                                               <paramdef><type>int </type> <parameter>th</parameter></paramdef>
+                                         <paramdef choice="opt"><type>text </type> <parameter>algo='NearestNeighbor'</parameter></paramdef>
+                                       </funcprototype>
+
+                               </funcsynopsis>
+                       </refsynopsisdiv>
+
+                       <refsection>
+                               <title>Description</title> 
+
+                               <para>
+Return a set of tiles having the specified scale (<varname>sfx</varname>,
+<varname>sfy</varname>) and max size (<varname>tw</varname>,
+<varname>th</varname>) and covering the specified extent
+(<varname>ext</varname>) with data coming from the specified
+raster coverage (<varname>tab</varname>, <varname>col</varname>).
+                               </para>
+
+                               <para>Algorithm options are: 'NearestNeighbor', 'Bilinear', 'Cubic', 'CubicSpline', and 'Lanczos'.  Refer to: <ulink url="http://www.gdal.org/gdalwarp.html">GDAL Warp resampling methods</ulink> for more details.</para>
+
+        <note><para>
+This function uses a full table as input whereas <xref linkend="RT_ST_Tile"/> uses a single value.
+        </para></note>
+
+                               <para>Availability: 2.2.0</para>
+                       </refsection> 
+      <refsection>
+        <title>See Also</title>
+        <para>
+          <xref linkend="RT_CreateOverview"/>,
+          <xref linkend="RT_ST_Resample"/>,
+          <xref linkend="RT_ST_Tile"/>
+        </para>
+      </refsection>
+               </refentry>
+
+
                <refentry id="RT_ST_FromGDALRaster">
 
                        <refnamediv>