From: Regina Obe Date: Mon, 30 May 2011 03:43:09 +0000 (+0000) Subject: put in missing protos for st_quantile. Revise comment generator scripts to properly... X-Git-Tag: 2.0.0alpha1~1526 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=8d652cf481ed0e33d6cd92d31694410839f3670f;p=postgis put in missing protos for st_quantile. Revise comment generator scripts to properly handle OUT parameters git-svn-id: http://svn.osgeo.org/postgis/trunk@7288 b70326c6-7e19-0410-871a-916f4a2858ee --- diff --git a/doc/reference_raster.xml b/doc/reference_raster.xml index 6c470bb8e..34aaee5fa 100644 --- a/doc/reference_raster.xml +++ b/doc/reference_raster.xml @@ -3129,8 +3129,71 @@ select st_bandisnodata(rast, 1) from dummy_rast where rid = 1; -- Expected true Raster Band Statistics and Analytics - - + + + ST_Count + Returns the number of pixels in a given band of a raster or raster coverage. If no band is specified defaults to band 1. If exclude_nodata_value is set to true, will only count pixels that are not equal to the nodata value. + + + + + + bigint ST_Count + raster rast + integer nband=1 + boolean exclude_nodata_value=true + + + bigint ST_Count + raster rast + boolean exclude_nodata_value + + + bigint ST_Count + text rastertable + text rastercolumn + integer nband=1 + boolean exclude_nodata_value=true + + + bigint ST_Count + text rastertable + text rastercolumn + boolean exclude_nodata_value + + + + + + Description + + Returns the number of pixels in a given band of a raster or raster coverage. If no band is specified nband defaults to 1. + If exclude_nodata_value is set to true, will only count pixels with value not equal to the nodata value of the raster. Set exclude_nodata_value to false to get count all pixels + Availability: 2.0.0 + + + + Examples + + +--example will count all pixels not 249 and one will count all pixels. -- +SELECT rid, ST_Count(ST_SetBandNoDataValue(rast,249)) As exclude_nodata, + ST_Count(ST_SetBandNoDataValue(rast,249),false) As include_nodata + FROM dummy_rast WHERE rid=2; + +rid | exclude_nodata | include_nodata +-----+----------------+---------------- + 2 | 23 | 25 + + + + + See Also + + + + + ST_Quantile Compute quantiles in the context of the sample or population. Thus, a value could be examined to be at the raster's 25%, 50%, 75% percentile. @@ -3145,6 +3208,17 @@ select st_bandisnodata(rast, 1) from dummy_rast where rid = 1; -- Expected true boolean exclude_nodata_value=true double precision[] quantiles=NULL + + SETOF quantile ST_Quantile + raster rast + double precision[] quantiles + + + SETOF quantile ST_Quantile + raster rast + integer nband + double precision[] quantiles + double precision ST_Quantile raster rast @@ -3162,6 +3236,13 @@ select st_bandisnodata(rast, 1) from dummy_rast where rid = 1; -- Expected true integer nband double precision quantile + + double precision ST_Quantile + raster rast + integer nband + boolean exclude_nodata_value + double precision quantile + double precision ST_Quantile raster rast @@ -3244,69 +3325,6 @@ ORDER BY value, quantile,rid , - - - ST_Count - Returns the number of pixels in a given band of a raster or raster coverage. If no band is specified defaults to band 1. If exclude_nodata_value is set to true, will only count pixels that are not equal to the nodata value. - - - - - - bigint ST_Count - raster rast - integer nband=1 - boolean exclude_nodata_value=true - - - bigint ST_Count - raster rast - boolean exclude_nodata_value - - - bigint ST_Count - text rastertable - text rastercolumn - integer nband=1 - boolean exclude_nodata_value=true - - - bigint ST_Count - text rastertable - text rastercolumn - boolean exclude_nodata_value - - - - - - Description - - Returns the number of pixels in a given band of a raster or raster coverage. If no band is specified nband defaults to 1. - If exclude_nodata_value is set to true, will only count pixels with value not equal to the nodata value of the raster. Set exclude_nodata_value to false to get count all pixels - Availability: 2.0.0 - - - - Examples - - ---example will count all pixels not 249 and one will count all pixels. -- -SELECT rid, ST_Count(ST_SetBandNoDataValue(rast,249)) As exclude_nodata, - ST_Count(ST_SetBandNoDataValue(rast,249),false) As include_nodata - FROM dummy_rast WHERE rid=2; - -rid | exclude_nodata | include_nodata ------+----------------+---------------- - 2 | 23 | 25 - - - - - See Also - - - diff --git a/doc/xsl/postgis_comments.sql.xsl b/doc/xsl/postgis_comments.sql.xsl index 5ffbe79b5..60630c08b 100644 --- a/doc/xsl/postgis_comments.sql.xsl +++ b/doc/xsl/postgis_comments.sql.xsl @@ -37,10 +37,11 @@ + If its input is a geometry set - we know it is an aggregate function rather than a regular function + Do not output OUT params since they define output rather than act as input and do not put a comma after argument just before an OUT parameter --> COMMENT ON AGGREGATEFUNCTION ( -geometry, +geometry, ) IS ' '; diff --git a/doc/xsl/raster_comments.sql.xsl b/doc/xsl/raster_comments.sql.xsl index 8a2478b13..fe155c19a 100644 --- a/doc/xsl/raster_comments.sql.xsl +++ b/doc/xsl/raster_comments.sql.xsl @@ -33,10 +33,10 @@ + Do not output OUT params since they define output rather than act as input and do not put a comma after argument just before an OUT parameter --> COMMENT ON AGGREGATEFUNCTION ( -geometry, +geometry, ) IS ' '; diff --git a/doc/xsl/topology_comments.sql.xsl b/doc/xsl/topology_comments.sql.xsl index a8f2c43bc..56c763bc8 100644 --- a/doc/xsl/topology_comments.sql.xsl +++ b/doc/xsl/topology_comments.sql.xsl @@ -41,10 +41,11 @@ set search_path=topology,public,pg_catalog; + If its input is a geometry set - we know it is an aggregate function rather than a regular function + Do not output OUT params since they define output rather than act as input and do not put a comma after argument just before an OUT parameter --> COMMENT ON AGGREGATEFUNCTION ( -topoelement, +topoelement, ) IS ' ';