From: Regina Obe Date: Fri, 30 Apr 2010 18:25:04 +0000 (+0000) Subject: document more functions -- start breaking out raster band functions from raster functions X-Git-Tag: 2.0.0alpha1~3016 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ff5cf64e90ecf34d30d8d062bab3e071f483fb1a;p=postgis document more functions -- start breaking out raster band functions from raster functions git-svn-id: http://svn.osgeo.org/postgis/trunk@5592 b70326c6-7e19-0410-871a-916f4a2858ee --- diff --git a/doc/reference_wktraster.xml b/doc/reference_wktraster.xml index 7dd3bb66d..c87b53461 100644 --- a/doc/reference_wktraster.xml +++ b/doc/reference_wktraster.xml @@ -466,95 +466,6 @@ WHERE rid = 2; - - - ST_BandPixelType - Returns the type of pixel for given band. - - - - - - text ST_BandPixelType - raster rast - integer bandnum - - - - - - Description - - Returns the value that represents no data for the band - Pixel Types supported are as follows: - - - 1BB - 1-bit boolean - - - - 2BUI - 2-bit unsigned integer - - - - 4BUI - 4-bit unsigned integer - - - - 8BSI - 8-bit signed integer - - - 8BUI - 8-bit unsigned integer - - - 16BSI - 16-bit signed integer - - - 16BUI - 16-bit unsigned integer - - - 16BUI - 16-bit unsigned integer - - - 32BSI - 32-bit signed integer - - - 32BUI - 32-bit unsigned integer - - - 16BF - 16-bit float - - - 32BF - 32-bit float - - - 64BF - 64-bit float - - - - - - - Examples - - SELECT ST_BandPixelType(rast,1) As btype1, - ST_BandPixelType(rast,2) As btype2, ST_BandPixelType(rast,3) As btype3 -FROM dummy_rast -WHERE rid = 2; - - btype1 | btype2 | btype3 ---------+--------+-------- - 8BUI | 8BUI | 8BUI - - - - - - See Also - - - - ST_Box2D @@ -1324,6 +1235,177 @@ rastwidth + + Raster Band Accessors + + + ST_BandHasNoDataValue + Returns whether or not a band has a value that should be considered no data. + + + + + + boolean ST_BandHasNoDataValue + raster rast + integer bandnum + + + + + + Description + + Returns true or false whether or not a band has a value that should be considered no data. + + + + Examples + + -- change just first band no data value +SELECT ST_BandHasNoDataValue(rast,1) As hasnodataval +FROM dummy_rast +WHERE rid = 2; + +hasnodataval +------------ +f + + + + + + See Also + ,, , + + + + + + ST_BandPath + Returns system file path to a band stored in file system. + + + + + + text ST_BandPath + raster rast + integer bandnum + + + + + + Description + + Returns system file path to a band. Throws an error if called with an in db band. + + + + Examples + + + + + + + + See Also + + + + + + + ST_BandPixelType + Returns the type of pixel for given band. + + + + + + text ST_BandPixelType + raster rast + integer bandnum + + + + + + Description + + Returns the value that represents no data for the band + Pixel Types supported are as follows: + + + 1BB - 1-bit boolean + + + + 2BUI - 2-bit unsigned integer + + + + 4BUI - 4-bit unsigned integer + + + + 8BSI - 8-bit signed integer + + + 8BUI - 8-bit unsigned integer + + + 16BSI - 16-bit signed integer + + + 16BUI - 16-bit unsigned integer + + + 16BUI - 16-bit unsigned integer + + + 32BSI - 32-bit signed integer + + + 32BUI - 32-bit unsigned integer + + + 16BF - 16-bit float + + + 32BF - 32-bit float + + + 64BF - 64-bit float + + + + + + + Examples + + SELECT ST_BandPixelType(rast,1) As btype1, + ST_BandPixelType(rast,2) As btype2, ST_BandPixelType(rast,3) As btype3 +FROM dummy_rast +WHERE rid = 2; + + btype1 | btype2 | btype3 +--------+--------+-------- + 8BUI | 8BUI | 8BUI + + + + + + See Also + + + + + Raster Editors @@ -1335,7 +1417,7 @@ rastwidth - integer ST_SetBandHasNoDataValue + raster ST_SetBandHasNoDataValue raster rast integer bandnum boolean has_nodatavalue @@ -1386,7 +1468,7 @@ WHERE rid = 2; Description - Returns the value that represents no data for the band. This will effect ST_Polygon and ST_ConvexHull results. + Sets the value that represents no data for the band. This will effect ST_Polygon and ST_ConvexHull results. @@ -1866,7 +1948,7 @@ FROM (SELECT ST_SetRotation(rast,0.1,0.1) As rast Examples - SELECT val, ST_AsText(geom) As geomwkt + SELECT val, ST_AsText(geom) As geomwkt FROM ( SELECT (ST_DumpAsPolygons(rast)).* FROM dummy_rast @@ -1885,7 +1967,7 @@ ORDER BY val; 3427927.85 5793243.8, 3427927.8 5793243.8)) 251 | POLYGON((3427927.75 5793243.85,3427927.75 5793243.8,3427927.8 5793243.8, 3427927.8 5793243.85,3427927.75 5793243.85)) - + See Also