From db9854a9d4e461099125961110e6e46ab062e970 Mon Sep 17 00:00:00 2001 From: Bborie Park Date: Fri, 12 Oct 2012 16:06:35 +0000 Subject: [PATCH] More documentation changes regarding deprecation status of ST_MapAlgebraFct() variants. Added news item regarding deprecation status of ST_MapAlgebraFct and ST_MapAlgebraFctNgb variants git-svn-id: http://svn.osgeo.org/postgis/trunk@10420 b70326c6-7e19-0410-871a-916f4a2858ee --- NEWS | 2 + doc/reference_raster.xml | 373 +++++++++++++++++++++++++++++---------- 2 files changed, 285 insertions(+), 90 deletions(-) diff --git a/NEWS b/NEWS index b1abe3318..c9ef5375e 100644 --- a/NEWS +++ b/NEWS @@ -10,6 +10,8 @@ PostGIS 2.1.0 * Deprecated signatures - ST_Estimated_Extent renamed to ST_EstimatedExtent + - ST_MapAlgebraFctNgb and 1 and 2 raster variants of ST_MapAlgebraFct. + Use ST_MapAlgebra instead * New Features * diff --git a/doc/reference_raster.xml b/doc/reference_raster.xml index 089aad6cf..499f2cb87 100644 --- a/doc/reference_raster.xml +++ b/doc/reference_raster.xml @@ -7253,6 +7253,7 @@ FROM dummy_rast; Returns the hypothetical illumination of an elevation raster band using the azimuth, altitude, brightness, and elevation scale inputs. Utilizes map algebra and applies the hill shade equation to neighboring pixels. The hill shade equation is: max_bright * ( (cos(zenith)*cos(slope)) + (sin(zenith)*sin(slope)*cos(azimuth - aspect)) ). Availability: 2.0.0 + Enhanced: 2.1.0 Uses and runs before running the hillshade operation @@ -7264,7 +7265,7 @@ FROM dummy_rast; See Also - + @@ -7318,6 +7319,7 @@ FROM dummy_rast; The equation for the pixel aspect of cell E is: atan2((((G + 2H + I) - (A + 2B + C)) / 8), -(((C + 2F + I) - (A + 2D + G)) / 8)) Availability: 2.0.0 + Enhanced: 2.1.0 Uses and runs before running the hillshade operation @@ -7329,7 +7331,7 @@ FROM dummy_rast; See Also - + @@ -7383,6 +7385,7 @@ FROM dummy_rast; The equation for the pixel slope of cell E is: atan(sqrt(((c + 2f + i) - (a + 2d + g) / 8)^2 + (((g + 2h + i) - (a + 2b + c)) / 8) ^ 2)) Availability: 2.0.0 + Enhanced: 2.1.0 Uses and runs before running the hillshade operation @@ -7394,7 +7397,7 @@ FROM dummy_rast; See Also - + @@ -7667,13 +7670,11 @@ CREATE OR REPLACE FUNCTION sample_callbackfunc(value double precision[][][], pos Variant 4 operate upon two rasters with one band per raster. See example Variant 4. -, and are deprecated as of PostGIS 2.1.0 and use of these functions are strongly discouraged. These functions may be removed in a future version of PostGIS. ---> Availability: 2.1.0 @@ -8348,6 +8349,12 @@ FROM prunion; The text[] argument to the userfunction is required, regardless of whether you choose to pass any arguments to your user function for processing or not. + + + is deprecated as of 2.1.0. Use instead. + + + Availability: 2.0.0 @@ -8542,6 +8549,12 @@ WHERE rid=167; The text[] argument to the tworastuserfunc is required, regardless of whether you choose to pass any arguments to your user function for processing or not. + + + is deprecated as of 2.1.0. Use instead. + + + Availability: 2.0.0 @@ -8758,6 +8771,13 @@ SELECT ST_MapAlgebraFct(m1.rast, 1, m1.rast, 3, Arguments to pass into the user function. + + + + is deprecated as of 2.1.0. Use instead. + + + Availability: 2.0.0 @@ -9129,40 +9149,71 @@ WHERE ST_Intersects(rast, ST_GeomFromText('LINESTRING(230486 887771, 230500 887 - Raster Processing Builtin Functions - + Raster Processing Builtin Functions + ST_Min4ma - Raster processing function that calculates the minimum pixel value in a neighborhood. + + Raster processing function that calculates the minimum pixel value in a neighborhood. + - - float8 ST_Min4ma - float8[][] matrix - text nodatamode - text[] VARIADIC args - + + float8 ST_Min4ma + float8[][] matrix + text nodatamode + text[] VARIADIC args + + + + double precision ST_Min4ma + double precision[][][] value + integer[][] pos + text[] VARIADIC userargs + - + Description - Calculate the minimum pixel value in a neighborhood of pixels. - - - This function is a specialized callback function for use as a callback parameter to . - + + Calculate the minimum pixel value in a neighborhood of pixels. + - Availability: 2.0.0 - - - - Examples - - SELECT + + For Variant 2, a substitution value for NODATA pixels can be specified by passing that value to userargs. + + + + + Variant 1 is a specialized callback function for use as a callback parameter to . + + + + + + Variant 2 is a specialized callback function for use as a callback parameter to . + + + + + + Use of Variant 1 is discouraged since has been deprecated as of 2.1.0. + + + + Availability: 2.0.0 + Enhanced: 2.1.0 Addition of Variant 2 + + + + Examples + + +SELECT rid, st_value( st_mapalgebrafctngb(rast, 1, NULL, 1, 1, 'st_min4ma(float[][],text,text[])'::regprocedure, 'ignore', NULL), 2, 2 @@ -9174,20 +9225,20 @@ WHERE rid = 2; 2 | 250 (1 row) - See Also - , - , - , - , - , - - - + , + , + , + , + , + , + , + + @@ -9205,6 +9256,13 @@ WHERE rid = 2; text nodatamode text[] VARIADIC args + + + double precision ST_Max4ma + double precision[][][] value + integer[][] pos + text[] VARIADIC userargs + @@ -9213,11 +9271,28 @@ WHERE rid = 2; Calculate the maximum pixel value in a neighborhood of pixels. + + For Variant 2, a substitution value for NODATA pixels can be specified by passing that value to userargs. + + - This function is a specialized callback function for use as a callback parameter to . + Variant 1 is a specialized callback function for use as a callback parameter to . + + + Variant 2 is a specialized callback function for use as a callback parameter to . + + + + + + Use of Variant 1 is discouraged since has been deprecated as of 2.1.0. + + + Availability: 2.0.0 + Enhanced: 2.1.0 Addition of Variant 2 @@ -9241,14 +9316,15 @@ WHERE rid = 2; See Also - , - , - , - , - , - - - + , + , + , + , + , + , + , + + @@ -9266,6 +9342,13 @@ WHERE rid = 2; text nodatamode text[] VARIADIC args + + + double precision ST_Sum4ma + double precision[][][] value + integer[][] pos + text[] VARIADIC userargs + @@ -9274,11 +9357,28 @@ WHERE rid = 2; Calculate the sum of all pixel values in a neighborhood of pixels. + + For Variant 2, a substitution value for NODATA pixels can be specified by passing that value to userargs. + + - This function is a specialized callback function for use as a callback parameter to . + Variant 1 is a specialized callback function for use as a callback parameter to . + + + Variant 2 is a specialized callback function for use as a callback parameter to . + + + + + + Use of Variant 1 is discouraged since has been deprecated as of 2.1.0. + + + Availability: 2.0.0 + Enhanced: 2.1.0 Addition of Variant 2 @@ -9302,14 +9402,15 @@ WHERE rid = 2; See Also - , - , - , - , - , - - - + , + , + , + , + , + , + , + + @@ -9327,6 +9428,13 @@ WHERE rid = 2; text nodatamode text[] VARIADIC args + + + double precision ST_Mean4ma + double precision[][][] value + integer[][] pos + text[] VARIADIC userargs + @@ -9335,11 +9443,28 @@ WHERE rid = 2; Calculate the mean pixel value in a neighborhood of pixels. + + For Variant 2, a substitution value for NODATA pixels can be specified by passing that value to userargs. + + - This function is a specialized callback function for use as a callback parameter to . + Variant 1 is a specialized callback function for use as a callback parameter to . + + + Variant 2 is a specialized callback function for use as a callback parameter to . + + + + + + Use of Variant 1 is discouraged since has been deprecated as of 2.1.0. + + + Availability: 2.0.0 + Enhanced: 2.1.0 Addition of Variant 2 @@ -9363,13 +9488,14 @@ WHERE rid = 2; See Also - , - , - , - , - , - - + , + , + , + , + , + , + + @@ -9387,6 +9513,13 @@ WHERE rid = 2; text nodatamode text[] VARIADIC args + + + double precision ST_Range4ma + double precision[][][] value + integer[][] pos + text[] VARIADIC userargs + @@ -9395,11 +9528,28 @@ WHERE rid = 2; Calculate the range of pixel values in a neighborhood of pixels. + + For Variant 2, a substitution value for NODATA pixels can be specified by passing that value to userargs. + + - This function is a specialized callback function for use as a callback parameter to . + Variant 1 is a specialized callback function for use as a callback parameter to . + + + Variant 2 is a specialized callback function for use as a callback parameter to . + + + + + + Use of Variant 1 is discouraged since has been deprecated as of 2.1.0. + + + Availability: 2.0.0 + Enhanced: 2.1.0 Addition of Variant 2 @@ -9423,14 +9573,15 @@ WHERE rid = 2; See Also - , - , - , - , - , - - - + , + , + , + , + , + , + , + + @@ -9448,6 +9599,13 @@ WHERE rid = 2; text nodatamode text[] VARIADIC args + + + double precision ST_Distinct4ma + double precision[][][] value + integer[][] pos + text[] VARIADIC userargs + @@ -9457,10 +9615,23 @@ WHERE rid = 2; Calculate the number of unique pixel values in a neighborhood of pixels. - This function is a specialized callback function for use as a callback parameter to . + Variant 1 is a specialized callback function for use as a callback parameter to . + + + Variant 2 is a specialized callback function for use as a callback parameter to . + + + + + + Use of Variant 1 is discouraged since has been deprecated as of 2.1.0. + + + Availability: 2.0.0 + Enhanced: 2.1.0 Addition of Variant 2 @@ -9484,13 +9655,14 @@ WHERE rid = 2; See Also - , - , - , - , - , - - + , + , + , + , + , + , + , + @@ -9509,6 +9681,13 @@ WHERE rid = 2; text nodatamode text[] VARIADIC args + + + double precision ST_StdDev4ma + double precision[][][] value + integer[][] pos + text[] VARIADIC userargs + @@ -9518,10 +9697,23 @@ WHERE rid = 2; Calculate the standard deviation of pixel values in a neighborhood of pixels. - This function is a specialized callback function for use as a callback parameter to . + Variant 1 is a specialized callback function for use as a callback parameter to . + + + Variant 2 is a specialized callback function for use as a callback parameter to . + + + + + + Use of Variant 1 is discouraged since has been deprecated as of 2.1.0. + + + Availability: 2.0.0 + Enhanced: 2.1.0 Addition of Variant 2 @@ -9545,14 +9737,15 @@ WHERE rid = 2; See Also - , - , - , - , - , - - - + , + , + , + , + , + , + , + + @@ -9616,7 +9809,7 @@ WHERE rid = 2; See Also - , + , -- 2.40.0