document ST_SetBandHasNoDataValue

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

diff --git a/doc/reference_wktraster.xml b/doc/reference_wktraster.xml
index 5e1d1e243a6e10b0e1689dd060580998bd9ee358..73637a14ceb4102a4f69bfd7cf2ada87184ad6cf 100644 (file)
--- a/doc/reference_wktraster.xml
+++ b/doc/reference_wktraster.xml
@@ -1293,6 +1293,46 @@ rastwidth
        
        <sect1 id="Raster_Editors">
                <title>Raster Editors</title>
+               <refentry id="RT_ST_SetBandHasNoDataValue">
+                       <refnamediv>
+                               <refname>ST_SetBandHasNoDataValue</refname>
+                               <refpurpose>Sets whether or not a band has a value that should be considered no data.</refpurpose>
+                       </refnamediv>
+               
+                       <refsynopsisdiv>
+                               <funcsynopsis>
+                                 <funcprototype>
+                                       <funcdef>integer <function>ST_SetBandHasNoDataValue</function></funcdef>
+                                       <paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
+                                       <paramdef><type>integer </type> <parameter>bandnum</parameter></paramdef>
+                                       <paramdef><type>boolean </type> <parameter>has_nodatavalue</parameter></paramdef>
+                                 </funcprototype>
+                               </funcsynopsis>
+                       </refsynopsisdiv>
+               
+                       <refsection>
+                               <title>Description</title>
+                               
+                               <para>Sets whether or not a band has a value that should be considered no data.</para>
+                               </refsection>
+                               
+                               <refsection>
+                                       <title>Examples</title>
+                               
+                                       <programlisting>-- change just first band no data value
+UPDATE dummy_rast 
+       SET rast = ST_SetBandHasNoDataValue(rast,1, false)  
+WHERE rid = 2;
+                                       </programlisting>
+                       
+                       </refsection>
+
+                       <refsection>
+                               <title>See Also</title>
+                               <para><xref linkend="RT_ST_BandNoDataValue" />,<xref linkend="RT_ST_SetBandNoDataValue" /></para>
+                       </refsection>
+               </refentry>
+               
                <refentry id="RT_ST_SetBandNoDataValue">
                        <refnamediv>
                                <refname>ST_SetBandNoDataValue</refname>