Changes between Version 90 and Version 91 of WKTRaster/SpecificationWorking03

Timestamp:

05/26/11 12:49:38 (14 years ago)

Author:

dustymugs

Comment:

ST_ValuePercent

WKTRaster/SpecificationWorking03

@@ -1049 +1049 @@
 1. ST_ValueCount(rastertable text, rastercolumn text, nband integer, hasnodata boolean, searchvalue double precision, roundto double precision) -> bigint
 
-    returns the number of times that searchvalue is present in the raster
-
     searchvalue: the value to count in the raster
 
@@ -1086 +1084 @@
 
 5. ST_ValueCount(rastertable text, rastercolumn text, searchvalue double precision) -> bigint
+
+    nband is assumed to be 1. roundto is assumed to be 0, so no rounding takes place. hasnodata is assumed to be TRUE.
+
+----
+
+'''ST_ValuePercent(raster, value) -> double precision'''[[BR]]
+
+ST_ValuePercent is the sibling of ST_ValueCount and returns the percentage of a raster's band that is of a specified value. To handle floating point values, a rounding argument is provided. 
+
+A set of functions for one or more search values:
+
+''If NULL is passed for "searchvalues" to any of the ST_ValuePercent variations with "searchvalues", the function returns the percents for all unique values''
+
+1. ST_ValuePercent(rast raster, nband integer, hasnodata boolean, searchvalues double precision[], roundto double precision) -> setof record (searchvalue, percent)
+
+    returns the percentage of a raster's band that each value in searchvalues is found
+
+    hasnodata: if FALSE, nodata values in band are considered in the percents. if TRUE, nodata values are not considered
+
+    searchvalues: the set of values to get percents for in the raster
+
+    roundto: the decimal position to round a pixel value to. Originally intended for use with 32BF and 64BF pixel types, it can also be used with integers when round to the tens, hundreds or higher place.
+
+        examples are...
+
+{{{
+        roundto < 0: no rounding
+
+        0: no rounding
+
+        0.1: round to the tenths place
+
+        0.01: round to the hundredths place
+
+        0.001: round to the thousandths place
+
+        1: round to the ones place
+
+        10: round to the tens place
+
+        100: round to the hundreds place
+}}}
+
+{{{
+ST_ValuePercent(rast, 1, TRUE, ARRAY[23], 0)
+
+ST_ValuePercent(rast, 5, FALSE, ARRAY[3.14], 0.01)
+
+ST_ValuePercent(rast, 2, TRUE, ARRAY[100], 100)
+
+ST_ValuePercent(rast, 1, FALSE, ARRAY[-9999, 0], 1)
+
+ST_ValuePercent(rast, 1, FALSE, NULL::double precision[], 1)
+}}}
+
+2. ST_ValuePercent(rast raster, nband integer, searchvalues double precision[], roundto double precision) -> setof record (searchvalue, percent)
+
+    hasnodata is assumed to be TRUE
+
+{{{
+ST_ValuePercent(rast, 5, ARRAY[3.14], 0.01)
+
+ST_ValuePercent(rast, 2, NULL::double precision[], 100)
+}}}
+
+3. ST_ValuePercent(rast raster, nband integer, searchvalues double precision[]) -> setof record (searchvalue, percent)
+
+    roundto is assumed to be 0, so no rounding takes place. hasnodata is assumed to be TRUE
+
+{{{
+ST_ValuePercent(rast, 1, ARRAY[-9999])
+
+ST_ValuePercent(rast, 1, NULL::double precision[])
+}}}
+
+4. ST_ValuePercent(rast raster, searchvalues double precision[], roundto double precision) -> setof record (searchvalue, percent)
+
+    nband is assumed to be 1. hasnodata is assumed to be TRUE.
+
+5. ST_ValuePercent(rast raster, searchvalues double precision[]) -> setof record (searchvalue, percent)
+
+    nband is assumed to be 1. roundto is assumed to be 0, so no rounding takes place. hasnodata is assumed to be TRUE.
+
+A set of functions for a single search value:
+
+1. ST_ValuePercent(rast raster, nband integer, hasnodata boolean, searchvalue double precision, roundto double precision) -> integer
+
+    searchvalue: the value to get a percent for in the raster
+
+{{{
+ST_ValuePercent(rast, 1, TRUE, 23, 0)
+
+ST_ValuePercent(rast, 5, FALSE, 3.14, 0.01)
+
+ST_ValuePercent(rast, 2, TRUE, 100, 100)
+
+ST_ValuePercent(rast, 1, FALSE, -9999, 1)
+}}}
+
+2. ST_ValuePercent(rast raster, nband integer, searchvalue double precision, roundto double precision) -> integer
+
+    hasnodata is assumed to be TRUE
+
+{{{
+ST_ValuePercent(rast, 5, 3.14, 0.01)
+
+ST_ValuePercent(rast, 2, 100, 100)
+}}}
+
+3. ST_ValuePercent(rast raster, nband integer, searchvalue double precision) -> integer
+
+    roundto is assumed to be 0, so no rounding takes place. hasnodata is assumed to be TRUE
+
+{{{
+ST_ValuePercent(rast, 1, -9999)
+}}}
+
+4. ST_ValuePercent(rast raster, searchvalue double precision, roundto double precision) -> integer
+
+    nband is assumed to be 1. hasnodata is assumed to be TRUE.
+
+5. ST_ValuePercent(rast raster, searchvalue double precision) -> integer
+
+    nband is assumed to be 1. roundto is assumed to be 0, so no rounding takes place. hasnodata is assumed to be TRUE.
+
+The set of functions for processing coverages return "bigint" instead of "integer".
+
+A set of functions for one or more search values:
+
+1. ST_ValuePercent(rastertable text, rastercolumn text, nband integer, hasnodata boolean, searchvalues double precision[], roundto double precision) -> setof record (searchvalue, percent)
+
+    rastertable: name of the table with a raster column
+
+    rastercolumn: name of the raster column
+
+{{{
+ST_ValuePercent('test', 'rast', 1, TRUE, ARRAY[23], 0)
+
+ST_ValuePercent('test', 'rast', 5, FALSE, ARRAY[3.14], 0.01)
+
+ST_ValuePercent('test', 'rast', 2, TRUE, ARRAY[100], 100)
+
+ST_ValuePercent('test', 'rast', 1, FALSE, ARRAY[-9999, 0], 1)
+
+ST_ValuePercent('test', 'rast', 1, FALSE, NULL::double precision[], 1)
+}}}
+
+2. ST_ValuePercent(rastertable text, rastercolumn text, nband integer, searchvalues double precision[], roundto double precision) -> setof record (searchvalue, percent)
+
+    hasnodata is assumed to be TRUE
+
+{{{
+ST_ValuePercent('test', 'rast', 5, ARRAY[3.14], 0.01)
+
+ST_ValuePercent('test', 'rast', 2, NULL::double precision[], 100)
+}}}
+
+3. ST_ValuePercent(rastertable text, rastercolumn text, nband integer, searchvalues double precision[]) -> setof record (searchvalue, percent)
+
+    roundto is assumed to be 0, so no rounding takes place. hasnodata is assumed to be TRUE
+
+{{{
+ST_ValuePercent('test', 'rast', 1, ARRAY[-9999])
+
+ST_ValuePercent('test', 'rast', 1, NULL::double precision[])
+}}}
+
+4. ST_ValuePercent(rastertable text, rastercolumn text, searchvalues double precision[], roundto double precision) -> setof record (searchvalue, percent)
+
+    nband is assumed to be 1. hasnodata is assumed to be TRUE.
+
+5. ST_ValuePercent(rastertable text, rastercolumn text, searchvalues double precision[]) -> setof record (searchvalue, percent)
+
+    nband is assumed to be 1. roundto is assumed to be 0, so no rounding takes place. hasnodata is assumed to be TRUE.
+
+A set of functions for a single search value:
+
+1. ST_ValuePercent(rastertable text, rastercolumn text, nband integer, hasnodata boolean, searchvalue double precision, roundto double precision) -> bigint
+
+    searchvalue: the value to get a percent for in the raster
+
+{{{
+ST_ValuePercent('test', 'rast', 1, TRUE, 23, 0)
+
+ST_ValuePercent('test', 'rast', 5, FALSE, 3.14, 0.01)
+
+ST_ValuePercent('test', 'rast', 2, TRUE, 100, 100)
+
+ST_ValuePercent('test', 'rast', 1, FALSE, -9999, 1)
+}}}
+
+2. ST_ValuePercent(rastertable text, rastercolumn text, nband integer, searchvalue double precision, roundto double precision) -> bigint
+
+    hasnodata is assumed to be TRUE
+
+{{{
+ST_ValuePercent('test', 'rast', 5, 3.14, 0.01)
+
+ST_ValuePercent('test', 'rast', 2, 100, 100)
+}}}
+
+3. ST_ValuePercent(rastertable text, rastercolumn text, nband integer, searchvalue double precision) -> bigint
+
+    roundto is assumed to be 0, so no rounding takes place. hasnodata is assumed to be TRUE
+
+{{{
+ST_ValuePercent('test', 'rast', 1, -9999)
+}}}
+
+4. ST_ValuePercent(rastertable text, rastercolumn text, searchvalue double precision, roundto double precision) -> bigint
+
+    nband is assumed to be 1. hasnodata is assumed to be TRUE.
+
+5. ST_ValuePercent(rastertable text, rastercolumn text, searchvalue double precision) -> bigint
 
     nband is assumed to be 1. roundto is assumed to be 0, so no rounding takes place. hasnodata is assumed to be TRUE.