self-hosted/postgis
self-hosted/postgis
1
0
Fork 0
mirror of https://git.osgeo.org/gitea/postgis/postgis synced 2024-10-25 09:32:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

The documentation for ST_BandIsNoData was changed by error. This commit fixes

Browse source 
it. Related ticket #593.


git-svn-id: http://svn.osgeo.org/postgis/trunk@6737 b70326c6-7e19-0410-871a-916f4a2858ee
This commit is contained in:
Jorge Arévalo 2011-01-26 16:28:37 +00:00
parent 7c5624530e
commit 18ca6258a4
1 changed files with 22 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
doc/reference_raster.xml
View file

@ -1584,6 +1584,17 @@ WHERE rid = 2;
<funcdef>boolean <function>ST_BandIsNoData</function></funcdef>
<paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
<paramdef><type>integer </type> <parameter>band</parameter></paramdef>
<paramdef><type>boolean </type> <parameter>forceChecking</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>boolean <function>ST_BandIsNoData</function></funcdef>
<paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
<paramdef><type>integer </type> <parameter>band</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>boolean <function>ST_BandIsNoData</function></funcdef>
<paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
<paramdef><type>boolean </type> <parameter>forceChecking</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>boolean <function>ST_BandIsNoData</function></funcdef>
@ -1595,14 +1606,20 @@ WHERE rid = 2;
<refsection>
<title>Description</title>
<para>Returns true if the band is filled with only nodata
values. Band 1 is assumed if not specified.</para>
values. Band 1 is assumed if not specified. If the last argument
is TRUE, the entire band is checked pixel by pixel. Otherwise,
the function simply returns the value of the isnodata flag for
the band. The default value for this parameter is FALSE, if not
specified.</para>
<note>
<para>The flag may be dirty, so, to be sure, you should call
ST_SetBandIsNodata function, or call ST_SetBandNodataValue
with TRUE as last argument, to force band checking. The
<para>If the flag is dirty (this is, the result is different
using TRUE as last parameter and not using it) you should
update the raster to set this flag to true, by using ST_SetBandIsNodata function,
or ST_SetBandNodataValue function with TRUE as last argument. The
loader (raster2pgsql.py) currently can not properly set the
flag while loading raster data.</para>
flag while loading raster data. See <xref
linkend="RT_ST_SetBandIsNoData" />.</para>
</note>
</refsection>