]> granicus.if.org Git - postgis/commitdiff
#1748: change arg names in raster ST_Intersection docs to agree with arg names instal...
authorRegina Obe <lr@pcorp.us>
Sat, 3 Oct 2015 16:20:44 +0000 (16:20 +0000)
committerRegina Obe <lr@pcorp.us>
Sat, 3 Oct 2015 16:20:44 +0000 (16:20 +0000)
git-svn-id: http://svn.osgeo.org/postgis/trunk@14177 b70326c6-7e19-0410-871a-916f4a2858ee

doc/reference_raster.xml

index ddad72c5caec3974d0b64020011ac9e15ffa818f..0c5fd340c5a21dcbf15d425714194bd4e3061d0e 100644 (file)
@@ -8973,8 +8973,8 @@ FROM funky_shapes;
                                          <funcprototype>
                                                        <funcdef>setof geomval <function>ST_Intersection</function></funcdef>
                                                        <paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
-                                                       <paramdef><type>integer </type> <parameter>band_num</parameter></paramdef>
-                                                       <paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
+                                                       <paramdef><type>integer </type> <parameter>band</parameter></paramdef>
+                                                       <paramdef><type>geometry </type> <parameter>geomin</parameter></paramdef>
                                          </funcprototype>
 
                                          <funcprototype>
@@ -8988,27 +8988,27 @@ FROM funky_shapes;
                                                        <funcdef>raster <function>ST_Intersection</function></funcdef>
                                                        <paramdef><type>raster </type> <parameter>rast1</parameter></paramdef>
                                                        <paramdef><type>raster </type> <parameter>rast2</parameter></paramdef>
-                                                       <paramdef choice="opt"><type>text </type> <parameter>returnband='BOTH'</parameter></paramdef>
-                                                       <paramdef choice="opt"><type>double precision[] </type> <parameter>nodataval=NULL</parameter></paramdef>
+                                                       <paramdef choice="opt"><type>text </type> <parameter>returnband</parameter></paramdef>
+                                                       <paramdef choice="opt"><type>double precision[] </type> <parameter>nodataval</parameter></paramdef>
                                          </funcprototype>
 
                                          <funcprototype>
                                                        <funcdef>raster <function>ST_Intersection</function></funcdef>
                                                        <paramdef><type>raster </type> <parameter>rast1</parameter></paramdef>
-                                                       <paramdef><type>integer </type> <parameter>band_num1</parameter></paramdef>
+                                                       <paramdef><type>integer </type> <parameter>band1</parameter></paramdef>
                                                        <paramdef><type>raster </type> <parameter>rast2</parameter></paramdef>
-                                                       <paramdef><type>integer </type> <parameter>band_num2</parameter></paramdef>
+                                                       <paramdef><type>integer </type> <parameter>band2</parameter></paramdef>
                                                        <paramdef><type>double precision[] </type> <parameter>nodataval</parameter></paramdef>
                                          </funcprototype>
 
                                          <funcprototype>
                                                        <funcdef>raster <function>ST_Intersection</function></funcdef>
                                                        <paramdef><type>raster </type> <parameter>rast1</parameter></paramdef>
-                                                       <paramdef><type>integer </type> <parameter>band_num1</parameter></paramdef>
+                                                       <paramdef><type>integer </type> <parameter>band1</parameter></paramdef>
                                                        <paramdef><type>raster </type> <parameter>rast2</parameter></paramdef>
-                                                       <paramdef><type>integer </type> <parameter>band_num2</parameter></paramdef>
-                                                       <paramdef choice="opt"><type>text </type> <parameter>returnband='BOTH'</parameter></paramdef>
-                                                       <paramdef choice="opt"><type>double precision[] </type> <parameter>nodataval=NULL</parameter></paramdef>
+                                                       <paramdef><type>integer </type> <parameter>band2</parameter></paramdef>
+                                                       <paramdef choice="opt"><type>text </type> <parameter>returnband</parameter></paramdef>
+                                                       <paramdef choice="opt"><type>double precision[] </type> <parameter>nodataval</parameter></paramdef>
                                          </funcprototype>
 
                                        </funcsynopsis>
@@ -9041,7 +9041,7 @@ FROM funky_shapes;
                                        </para>
 
                                        <para>
-                                               In all variants, if no band number is specified band 1 is assumed.
+                                               In all variants, if no band number is specified band 1 is assumed.  If you need an intersection between a raster and geometry that returns a raster, refer to <xref linkend="RT_ST_Clip" />.
                                        </para>
 
                                        <note>
@@ -9104,12 +9104,6 @@ FROM (
                                        </programlisting>
                                </refsection>
 
-                               <refsection>
-                                       <title>Example: Raster, Geometry -- resulting is a raster</title>
-                                       <para>Examples coming soon</para>
-                                       <!-- TODO: EXAMPLES coming soon -->
-                               </refsection>
-
                                <refsection>
                                        <title>See Also</title>
                                        <para>