document st_setgeoreference

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

diff --git a/doc/reference_wktraster.xml b/doc/reference_wktraster.xml
index 45f6a026a4207af4228743527757a6a4ac1c156c..fa13877d8471546d34d30e35133367eba4a91ae3 100644 (file)
--- a/doc/reference_wktraster.xml
+++ b/doc/reference_wktraster.xml
@@ -377,7 +377,7 @@ upperlefty + pixelsizey*0.5</programlisting></para>
 
                        <refsection>
                                <title>See Also</title>
-                               <para><xref linkend="RT_ST_PixelSizeX" />, <xref linkend="RT_ST_PixelSizeY" /></para>
+                               <para><xref linkend="RT_ST_SetGeoReference" />, <xref linkend="RT_ST_PixelSizeX" />, <xref linkend="RT_ST_PixelSizeY" /></para>
                        </refsection>
                </refentry>
                
@@ -835,6 +835,57 @@ UPDATE dummy_rast
                        </refsection>
                </refentry>
                
+               <refentry id="RT_ST_SetGeoReference">
+                       <refnamediv>
+                               <refname>ST_SetGeoReference</refname>
+                               <refpurpose>Set Georefence 6 georeference parameters  in a single call. Numbers should be separated by white space.  Accepts inputs in GDAL or ESRI format.  Default is GDAL.</refpurpose>
+                       </refnamediv>
+               
+                       <refsynopsisdiv>
+                               <funcsynopsis>
+                                 <funcprototype>
+                                       <funcdef>raster <function>ST_SetGeoReference</function></funcdef>
+                                       <paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
+                                       <paramdef><type>text </type> <parameter>georefcoords</parameter></paramdef>
+                                 </funcprototype>
+                                 <funcprototype>
+                                       <funcdef>raster <function>ST_SetGeoReference</function></funcdef>
+                                       <paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
+                                       <paramdef><type>text </type> <parameter>georefcoords</parameter></paramdef>
+                                       <paramdef><type>text </type> <parameter>format</parameter></paramdef>
+                                 </funcprototype>
+                               </funcsynopsis>
+                       </refsynopsisdiv>
+               
+                       <refsection>
+                               <title>Description</title>
+                               
+                               <para>Set Georefence 6 georeference parameters in a single call.  Accepts inputs in 'GDAL' or 'ESRI' format.  Default is GDAL. If 6 coordinates are not provided will return null.</para>
+                               <para>Difference between format representations is as follows:</para>
+                               <para><varname>GDAL</varname>: 
+<programlisting>pixelsizex skewy skewx pixelsizey upperleftx upperlefty</programlisting></para>
+                               <para><varname>ESRI</varname>: 
+<programlisting>pixelsizex skewy skewx pixelsizey upperleftx + pixelsizex*0.5 upperlefty + pixelsizey*0.5</programlisting></para>
+                       </refsection>
+                               
+                       <refsection>
+                               <title>Examples</title>
+                       
+                               <programlisting>UPDATE dummy_rast SET rast = ST_SetGeoReference(rast, '2 0 0 3 0.5 0.5','GDAL') 
+       WHERE rid=1;
+       
+-- same coordinates set in 'ESRI' format
+UPDATE dummy_rast SET rast = ST_SetGeoReference(rast, '2 0 0 3 1.5 2','ESRI') 
+       WHERE rid=1;
+                               </programlisting>       
+                       </refsection>
+
+                       <refsection>
+                               <title>See Also</title>
+                               <para><xref linkend="RT_ST_GeoReference" />, <xref linkend="RT_ST_PixelSizeX" />, <xref linkend="RT_ST_PixelSizeY" />, <xref linkend="RT_ST_UpperLeftX" />, <xref linkend="RT_ST_UpperLeftY" /></para>
+                       </refsection>
+               </refentry>
+               
                <refentry id="RT_ST_SetPixelSize">
                        <refnamediv>
                                <refname>ST_SetPixelSize</refname>