Changes between Version 104 and Version 105 of WKTRaster/SpecificationWorking03

Timestamp:

06/13/11 14:07:49 (14 years ago)

Author:

pracine

Comment:

—

WKTRaster/SpecificationWorking03

@@ -202 +202 @@
 '''ST_Area(raster|geometry) -> double'''[[BR]]
 
-----
-
-'''ST_ValueCount(raster, value) -> integer'''[[BR]]
-
-ST_ValueCount provides the ability to count the number of times that a user-provided value is present in a raster. 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_ValueCount variations with "searchvalues", the function returns the counts for all unique values''
-
-1. ST_ValueCount(rast raster, nband integer, exclude_nodata_value boolean, searchvalues double precision[], roundto double precision) -> setof record (searchvalue, count)
-
-    returns the number of times that each value in searchvalues is present in the raster
-
-    exclude_nodata_value: if FALSE, nodata values in band are considered in the count. if TRUE, nodata values are not considered
-
-    searchvalues: the set of values to count 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_ValueCount(rast, 1, TRUE, ARRAY[23], 0)
-
-ST_ValueCount(rast, 5, FALSE, ARRAY[3.14], 0.01)
-
-ST_ValueCount(rast, 2, TRUE, ARRAY[100], 100)
-
-ST_ValueCount(rast, 1, FALSE, ARRAY[-9999, 0], 1)
-
-ST_ValueCount(rast, 1, FALSE, NULL::double precision[], 1)
-}}}
-
-2. ST_ValueCount(rast raster, nband integer, searchvalues double precision[], roundto double precision) -> setof record (searchvalue, count)
-
-    exclude_nodata_value is assumed to be TRUE
-
-{{{
-ST_ValueCount(rast, 5, ARRAY[3.14], 0.01)
-
-ST_ValueCount(rast, 2, NULL::double precision[], 100)
-}}}
-
-3. ST_ValueCount(rast raster, nband integer, searchvalues double precision[]) -> setof record (searchvalue, count)
-
-    roundto is assumed to be 0, so no rounding takes place. exclude_nodata_value is assumed to be TRUE
-
-{{{
-ST_ValueCount(rast, 1, ARRAY[-9999])
-
-ST_ValueCount(rast, 1, NULL::double precision[])
-}}}
-
-4. ST_ValueCount(rast raster, searchvalues double precision[], roundto double precision) -> setof record (searchvalue, count)
-
-    nband is assumed to be 1. exclude_nodata_value is assumed to be TRUE.
-
-5. ST_ValueCount(rast raster, searchvalues double precision[]) -> setof record (searchvalue, count)
-
-    nband is assumed to be 1. roundto is assumed to be 0, so no rounding takes place. exclude_nodata_value is assumed to be TRUE.
-
-A set of functions for a single search value:
-
-1. ST_ValueCount(rast raster, nband integer, exclude_nodata_value boolean, searchvalue double precision, roundto double precision) -> integer
-
-    returns the number of times that searchvalue is present in the raster
-
-    searchvalue: the value to count in the raster
-
-{{{
-ST_ValueCount(rast, 1, TRUE, 23, 0)
-
-ST_ValueCount(rast, 5, FALSE, 3.14, 0.01)
-
-ST_ValueCount(rast, 2, TRUE, 100, 100)
-
-ST_ValueCount(rast, 1, FALSE, -9999, 1)
-}}}
-
-2. ST_ValueCount(rast raster, nband integer, searchvalue double precision, roundto double precision) -> integer
-
-    exclude_nodata_value is assumed to be TRUE
-
-{{{
-ST_ValueCount(rast, 5, 3.14, 0.01)
-
-ST_ValueCount(rast, 2, 100, 100)
-}}}
-
-3. ST_ValueCount(rast raster, nband integer, searchvalue double precision) -> integer
-
-    roundto is assumed to be 0, so no rounding takes place. exclude_nodata_value is assumed to be TRUE
-
-{{{
-ST_ValueCount(rast, 1, -9999)
-}}}
-
-4. ST_ValueCount(rast raster, searchvalue double precision, roundto double precision) -> integer
-
-    nband is assumed to be 1. exclude_nodata_value is assumed to be TRUE.
-
-5. ST_ValueCount(rast raster, searchvalue double precision) -> integer
-
-    nband is assumed to be 1. roundto is assumed to be 0, so no rounding takes place. exclude_nodata_value 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_ValueCount(rastertable text, rastercolumn text, nband integer, exclude_nodata_value boolean, searchvalues double precision[], roundto double precision) -> setof record (searchvalue, count)
-
-    rastertable: name of the table with a raster column
-
-    rastercolumn: name of the raster column
-
-{{{
-ST_ValueCount('test', 'rast', 1, TRUE, ARRAY[23], 0)
-
-ST_ValueCount('test', 'rast', 5, FALSE, ARRAY[3.14], 0.01)
-
-ST_ValueCount('test', 'rast', 2, TRUE, ARRAY[100], 100)
-
-ST_ValueCount('test', 'rast', 1, FALSE, ARRAY[-9999, 0], 1)
-
-ST_ValueCount('test', 'rast', 1, FALSE, NULL::double precision[], 1)
-}}}
-
-2. ST_ValueCount(rastertable text, rastercolumn text, nband integer, searchvalues double precision[], roundto double precision) -> setof record (searchvalue, count)
-
-    exclude_nodata_value is assumed to be TRUE
-
-{{{
-ST_ValueCount('test', 'rast', 5, ARRAY[3.14], 0.01)
-
-ST_ValueCount('test', 'rast', 2, NULL::double precision[], 100)
-}}}
-
-3. ST_ValueCount(rastertable text, rastercolumn text, nband integer, searchvalues double precision[]) -> setof record (searchvalue, count)
-
-    roundto is assumed to be 0, so no rounding takes place. exclude_nodata_value is assumed to be TRUE
-
-{{{
-ST_ValueCount('test', 'rast', 1, ARRAY[-9999])
-
-ST_ValueCount('test', 'rast', 1, NULL::double precision[])
-}}}
-
-4. ST_ValueCount(rastertable text, rastercolumn text, searchvalues double precision[], roundto double precision) -> setof record (searchvalue, count)
-
-    nband is assumed to be 1. exclude_nodata_value is assumed to be TRUE.
-
-5. ST_ValueCount(rastertable text, rastercolumn text, searchvalues double precision[]) -> setof record (searchvalue, count)
-
-    nband is assumed to be 1. roundto is assumed to be 0, so no rounding takes place. exclude_nodata_value is assumed to be TRUE.
-
-A set of functions for a single search value:
-
-1. ST_ValueCount(rastertable text, rastercolumn text, nband integer, exclude_nodata_value boolean, searchvalue double precision, roundto double precision) -> bigint
-
-    searchvalue: the value to count in the raster
-
-{{{
-ST_ValueCount('test', 'rast', 1, TRUE, 23, 0)
-
-ST_ValueCount('test', 'rast', 5, FALSE, 3.14, 0.01)
-
-ST_ValueCount('test', 'rast', 2, TRUE, 100, 100)
-
-ST_ValueCount('test', 'rast', 1, FALSE, -9999, 1)
-}}}
-
-2. ST_ValueCount(rastertable text, rastercolumn text, nband integer, searchvalue double precision, roundto double precision) -> bigint
-
-    exclude_nodata_value is assumed to be TRUE
-
-{{{
-ST_ValueCount('test', 'rast', 5, 3.14, 0.01)
-
-ST_ValueCount('test', 'rast', 2, 100, 100)
-}}}
-
-3. ST_ValueCount(rastertable text, rastercolumn text, nband integer, searchvalue double precision) -> bigint
-
-    roundto is assumed to be 0, so no rounding takes place. exclude_nodata_value is assumed to be TRUE
-
-{{{
-ST_ValueCount('test', 'rast', 1, -9999)
-}}}
-
-4. ST_ValueCount(rastertable text, rastercolumn text, searchvalue double precision, roundto double precision) -> bigint
-
-    nband is assumed to be 1. exclude_nodata_value is assumed to be TRUE.
-
-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. exclude_nodata_value 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, exclude_nodata_value 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
-
-    exclude_nodata_value: 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)
-
-    exclude_nodata_value 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. exclude_nodata_value 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. exclude_nodata_value 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. exclude_nodata_value is assumed to be TRUE.
-
-A set of functions for a single search value:
-
-1. ST_ValuePercent(rast raster, nband integer, exclude_nodata_value 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
-
-    exclude_nodata_value 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. exclude_nodata_value 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. exclude_nodata_value 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. exclude_nodata_value 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, exclude_nodata_value 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)
-
-    exclude_nodata_value 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. exclude_nodata_value 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. exclude_nodata_value 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. exclude_nodata_value is assumed to be TRUE.
-
-A set of functions for a single search value:
-
-1. ST_ValuePercent(rastertable text, rastercolumn text, nband integer, exclude_nodata_value 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
-
-    exclude_nodata_value 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. exclude_nodata_value 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. exclude_nodata_value 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. exclude_nodata_value is assumed to be TRUE.
 
 ----