From: Regina Obe <lr@pcorp.us>
Date: Tue, 6 Sep 2011 08:07:05 +0000 (+0000)
Subject: document st_resample - still need to put in examples
X-Git-Tag: 2.0.0alpha1~1043
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=db0c1629585e9b4840d1baef0a32ed4c2d5e23eb;p=postgis

document st_resample - still need to put in examples

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

diff --git a/doc/reference_raster.xml b/doc/reference_raster.xml
index 3ee3b58fb..9948c76e6 100644
--- a/doc/reference_raster.xml
+++ b/doc/reference_raster.xml
@@ -3474,6 +3474,60 @@ WHERE rid = 2;
 			</refsection>
 		</refentry>
 		
+			<refentry id="RT_ST_Resample">
+			<refnamediv>
+				<refname>ST_Resample</refname>
+				<refpurpose>Warps a raster in a known spatial reference system using a specified resampling algorithm and reference raster.  The new raster will have the same srid, skew and dimensions as the reference.
+				    Uses NearestNeighbor if no algorithm is specified Options: NearestNeighbor (english or american spelling), Bilinear, Cubic, CubicSpline, Lanczos.</refpurpose>
+			</refnamediv>
+		
+			<refsynopsisdiv>
+				<funcsynopsis>
+				  <funcprototype>
+					<funcdef>raster <function>ST_Resample</function></funcdef>
+					<paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
+					<paramdef><type>raster </type> <parameter>ref</parameter></paramdef>
+					<paramdef choice='opt'><type>text </type> <parameter>algorithm=NearestNeighbour</parameter></paramdef>
+					<paramdef choice='opt'><type>double precision </type> <parameter>maxerr=0.125</parameter></paramdef>
+				  </funcprototype>
+				  
+				  <funcprototype>
+					<funcdef>raster <function>ST_Resample</function></funcdef>
+					<paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
+					<paramdef choice='opt'><type>integer </type> <parameter>srid=NULL</parameter></paramdef>
+					<paramdef choice='opt'><type>double precision </type> <parameter>scalex=0</parameter></paramdef>
+					<paramdef choice='opt'><type>double precision </type> <parameter>scaley=0</parameter></paramdef>
+					<paramdef choice='opt'><type>double precision </type> <parameter>gridx=NULL</parameter></paramdef>
+					<paramdef choice='opt'><type>double precision </type> <parameter>gridy=NULL</parameter></paramdef>
+					<paramdef choice='opt'><type>text </type> <parameter>algorithm=NearestNeighbor</parameter></paramdef>
+					<paramdef choice='opt'><type>double precision </type> <parameter>skewx=0</parameter></paramdef>
+					<paramdef choice='opt'><type>double precision </type> <parameter>skewy=0</parameter></paramdef>
+					<paramdef choice='opt'><type>double precision </type> <parameter>maxerr=0.125</parameter></paramdef>
+				  </funcprototype>
+				</funcsynopsis>
+			</refsynopsisdiv>
+		
+			<refsection>
+				<title>Description</title>
+				
+				<para>Warps a raster using specified pixel warping algorithm. 
+				    Uses 'NearestNeighbor' if no algorithm is specified and maxerror percent of 0.125 if no maxerr is specified.</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. NearestNeighbor is the fastest but worst interpoloation</para>
+				<para>Availability: 2.0.0  Requires GDAL 1.6.1+</para>
+			</refsection>
+				
+			<refsection>
+					<title>Examples</title>
+				
+					<programlisting>-- TO DO --</programlisting>
+			</refsection>
+
+			<refsection>
+				<title>See Also</title>
+				<para><xref linkend="RT_ST_Transform" /></para>
+			</refsection>
+		</refentry>
+		
 		<refentry id="RT_ST_Transform">
 			<refnamediv>
 				<refname>ST_Transform</refname>