#2603: add weighted and mask args

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

diff --git a/doc/reference_raster.xml b/doc/reference_raster.xml
index 0c5fd340c5a21dcbf15d425714194bd4e3061d0e..d102126e81738f4714ade9f7d4d402394e053a22 100644 (file)
--- a/doc/reference_raster.xml
+++ b/doc/reference_raster.xml
@@ -9125,8 +9125,7 @@ FROM (
                                </refnamediv>
 
                                <refsynopsisdiv>
-                                       <funcsynopsis>
-
+                                       <funcsynopsis>                                                  
                                                <funcprototype>
                                                        <funcdef>raster <function>ST_MapAlgebra</function></funcdef>
                                                        <paramdef><type>rastbandarg[] </type> <parameter>rastbandargset</parameter></paramdef>
@@ -9179,6 +9178,18 @@ FROM (
                                                        <paramdef choice="opt"><type>integer </type> <parameter>distancey=0</parameter></paramdef>
                                                        <paramdef choice="opt"><type>text[] </type> <parameter>VARIADIC userargs=NULL</parameter></paramdef>
                                                </funcprototype>
+                                               
+                                               <funcprototype>
+                                                       <funcdef>raster <function>ST_MapAlgebra</function></funcdef>
+                                                       <paramdef><type>nband</type> <parameter>integer</parameter></paramdef>
+                                                       <paramdef><type>regprocedure </type> <parameter>callbackfunc</parameter></paramdef>
+                                                       <paramdef><type>float8[] </type> <parameter>mask</parameter></paramdef>
+                                                       <paramdef><type>boolean </type> <parameter>weighted</parameter></paramdef>
+                                                       <paramdef choice="opt"><type>text </type> <parameter>pixeltype=NULL</parameter></paramdef>
+                                                       <paramdef choice="opt"><type>text </type> <parameter>extenttype=INTERSECTION</parameter></paramdef>
+                                                       <paramdef choice="opt"><type>raster </type> <parameter>customextent=NULL</parameter></paramdef>
+                                                       <paramdef choice="opt"><type>text[] </type> <parameter>VARIADIC userargs=NULL</parameter></paramdef>
+                                               </funcprototype>
 
                                        </funcsynopsis>
                                </refsynopsisdiv>
@@ -9237,6 +9248,24 @@ CREATE OR REPLACE FUNCTION sample_callbackfunc(value double precision[][][], pos
 
                                                        </listitem>
                                                </varlistentry>
+                                               
+                                               <varlistentry>
+                                                       <term>mask</term>
+                                                       <listitem>
+                                                               <para>
+                                                                       An n-dimenional array (matrix) of numbers used to set pixels in raster to nodata.
+                                                               </para>
+                                                       </listitem>
+                                               </varlistentry>
+                                               
+                                               <varlistentry>
+                                                       <term>weighted</term>
+                                                       <listitem>
+                                                               <para>
+                                                                       boolean (true/false) to denote if a mask should be weighted or not (only applies to proto that takes a mask).
+                                                               </para>
+                                                       </listitem>
+                                               </varlistentry>
 
                                                <varlistentry>
                                                        <term>pixeltype</term>
@@ -9320,6 +9349,7 @@ CREATE OR REPLACE FUNCTION sample_callbackfunc(value double precision[][][], pos
                                                Variant 4 operate upon two rasters with one band per raster. See example Variant 4.
                                        </para>
 
+                                       <para>Availability: 2.2.0: Ability to add a mask</para>
                                        <para>Availability: 2.1.0</para>
 
                                </refsection>
@@ -9503,6 +9533,7 @@ WHERE t1.rid = 1
 
                                </refsection>
 
+
                                <refsection>
                                        <title>See Also</title>