From: Bborie Park Date: Thu, 30 May 2013 17:10:10 +0000 (+0000) Subject: Alphabetize built-in map algebra callback functions X-Git-Tag: 2.1.0beta3~28 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ca08d5daafc0e23670a7376858582a70fa794c52;p=postgis Alphabetize built-in map algebra callback functions git-svn-id: http://svn.osgeo.org/postgis/trunk@11504 b70326c6-7e19-0410-871a-916f4a2858ee --- diff --git a/doc/reference_raster.xml b/doc/reference_raster.xml index b45d50321..f862189ff 100644 --- a/doc/reference_raster.xml +++ b/doc/reference_raster.xml @@ -10457,48 +10457,38 @@ WHERE ST_Intersects(rast, ST_GeomFromText('LINESTRING(230486 887771, 230500 887 Built-in Map Algebra Callback Functions - + - ST_Min4ma - - Raster processing function that calculates the minimum pixel value in a neighborhood. - + ST_Distinct4ma + Raster processing function that calculates the number of unique pixel values in a neighborhood. - - float8 ST_Min4ma - float8[][] matrix - text nodatamode - text[] VARIADIC args - + + float8 ST_Distinct4ma + float8[][] matrix + text nodatamode + text[] VARIADIC args + - double precision ST_Min4ma + double precision ST_Distinct4ma double precision[][][] value integer[][] pos text[] VARIADIC userargs - + Description - - Calculate the minimum 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. - - - - - Variant 1 is a specialized callback function for use as a callback parameter to . - - + Calculate the number of unique pixel values in a neighborhood of pixels. + + + Variant 1 is a specialized callback function for use as a callback parameter to . + @@ -10512,26 +10502,26 @@ WHERE ST_Intersects(rast, ST_GeomFromText('LINESTRING(230486 887771, 230500 887 - Availability: 2.0.0 + Availability: 2.0.0 Enhanced: 2.1.0 Addition of Variant 2 - - - - Examples - - -SELECT + + + + Examples + + SELECT rid, st_value( - st_mapalgebrafctngb(rast, 1, NULL, 1, 1, 'st_min4ma(float[][],text,text[])'::regprocedure, 'ignore', NULL), 2, 2 + st_mapalgebrafctngb(rast, 1, NULL, 1, 1, 'st_distinct4ma(float[][],text,text[])'::regprocedure, 'ignore', NULL), 2, 2 ) FROM dummy_rast WHERE rid = 2; rid | st_value -----+---------- - 2 | 250 + 2 | 3 (1 row) + @@ -10539,12 +10529,78 @@ WHERE rid = 2; , , + , , - , + , , - , , + + + + + + + ST_InvDistWeight4ma + Raster processing function that interpolates a pixel's value from the pixel's neighborhood. + + + + + + double precision ST_InvDistWeight4ma + double precision[][][] value + integer[][] pos + text[] VARIADIC userargs + + + + + + Description + + Calculate an interpolated value for a pixel using the Inverse Distance Weighted method. + + + There are two optional parameters that can be passed through userargs. The first parameter is the power factor (variable k in the equation below) between 0 and 1 used in the Inverse Distance Weighted equation. If not specified, default value is 1. The second parameter is the weight percentage applied only when the value of the pixel of interest is included with the interpolated value from the neighborhood. If not specified and the pixel of interest has a value, that value is returned. + + + + The basic inverse distance weight equation is: + + + + + + + + + k = power factor, a real number between 0 and 1 + + + + + + + + This function is a specialized callback function for use as a callback parameter to . + + + Availability: 2.1.0 + + + + Examples + +-- NEEDS EXAMPLE + + + + + See Also + + , + @@ -10635,23 +10691,23 @@ WHERE rid = 2; - + - ST_Sum4ma - Raster processing function that calculates the sum of all pixel values in a neighborhood. + ST_Mean4ma + Raster processing function that calculates the mean pixel value in a neighborhood. - float8 ST_Sum4ma + float8 ST_Mean4ma float8[][] matrix text nodatamode text[] VARIADIC args - double precision ST_Sum4ma + double precision ST_Mean4ma double precision[][][] value integer[][] pos text[] VARIADIC userargs @@ -10662,7 +10718,7 @@ WHERE rid = 2; Description - Calculate the sum of all pixel values in a neighborhood of pixels. + 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. @@ -10694,13 +10750,13 @@ WHERE rid = 2; SELECT rid, st_value( - st_mapalgebrafctngb(rast, 1, '32BF', 1, 1, 'st_sum4ma(float[][],text,text[])'::regprocedure, 'ignore', NULL), 2, 2 + st_mapalgebrafctngb(rast, 1, '32BF', 1, 1, 'st_mean4ma(float[][],text,text[])'::regprocedure, 'ignore', NULL), 2, 2 ) FROM dummy_rast WHERE rid = 2; - rid | st_value ------+---------- - 2 | 2279 + rid | st_value +-----+------------------ + 2 | 253.222229003906 (1 row) @@ -10713,50 +10769,55 @@ WHERE rid = 2; , , , - , + , , - , - + - ST_Mean4ma - Raster processing function that calculates the mean pixel value in a neighborhood. + ST_Min4ma + + Raster processing function that calculates the minimum pixel value in a neighborhood. + - - float8 ST_Mean4ma - float8[][] matrix - text nodatamode - text[] VARIADIC args - + + float8 ST_Min4ma + float8[][] matrix + text nodatamode + text[] VARIADIC args + - double precision ST_Mean4ma + double precision ST_Min4ma double precision[][][] value integer[][] pos text[] VARIADIC userargs - + Description - Calculate the mean pixel value in a neighborhood of pixels. - + + Calculate the minimum 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. - - Variant 1 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 . + + @@ -10770,26 +10831,26 @@ WHERE rid = 2; - Availability: 2.0.0 + Availability: 2.0.0 Enhanced: 2.1.0 Addition of Variant 2 - - - - Examples - - SELECT + + + + Examples + + +SELECT rid, st_value( - st_mapalgebrafctngb(rast, 1, '32BF', 1, 1, 'st_mean4ma(float[][],text,text[])'::regprocedure, 'ignore', NULL), 2, 2 + st_mapalgebrafctngb(rast, 1, NULL, 1, 1, 'st_min4ma(float[][],text,text[])'::regprocedure, 'ignore', NULL), 2, 2 ) FROM dummy_rast WHERE rid = 2; - rid | st_value ------+------------------ - 2 | 253.222229003906 + rid | st_value +-----+---------- + 2 | 250 (1 row) - @@ -10797,15 +10858,67 @@ WHERE rid = 2; , , - , , - , + , + , , + , + + + ST_MinDist4ma + Raster processing function that returns the minimum distance (in number of pixels) between the pixel of interest and a neighboring pixel with value. + + + + + + double precision ST_MinDist4ma + double precision[][][] value + integer[][] pos + text[] VARIADIC userargs + + + + + + Description + + Return the shortest distance (in number of pixels) between the pixel of interest and the closest pixel with value in the neighborhood. + + + + The intent of this function is to provide an informative data point that helps infer the usefulness of the pixel of interest's interpolated value from . This function is particularly useful when the neighborhood is sparsely populated. + + + + + This function is a specialized callback function for use as a callback parameter to . + + + Availability: 2.1.0 + + + + Examples + +-- NEEDS EXAMPLE + + + + + See Also + + , + + + + + ST_Range4ma @@ -10892,23 +11005,23 @@ WHERE rid = 2; - + - ST_Distinct4ma - Raster processing function that calculates the number of unique pixel values in a neighborhood. + ST_StdDev4ma + Raster processing function that calculates the standard deviation of pixel values in a neighborhood. - float8 ST_Distinct4ma + float8 ST_StdDev4ma float8[][] matrix - text nodatamode + text nodatamode text[] VARIADIC args - double precision ST_Distinct4ma + double precision ST_StdDev4ma double precision[][][] value integer[][] pos text[] VARIADIC userargs @@ -10919,7 +11032,7 @@ WHERE rid = 2; Description - Calculate the number of unique pixel values in a neighborhood of pixels. + Calculate the standard deviation of pixel values in a neighborhood of pixels. Variant 1 is a specialized callback function for use as a callback parameter to . @@ -10947,13 +11060,13 @@ WHERE rid = 2; SELECT rid, st_value( - st_mapalgebrafctngb(rast, 1, NULL, 1, 1, 'st_distinct4ma(float[][],text,text[])'::regprocedure, 'ignore', NULL), 2, 2 + st_mapalgebrafctngb(rast, 1, '32BF', 1, 1, 'st_stddev4ma(float[][],text,text[])'::regprocedure, 'ignore', NULL), 2, 2 ) FROM dummy_rast WHERE rid = 2; - rid | st_value ------+---------- - 2 | 3 + rid | st_value +-----+------------------ + 2 | 1.30170822143555 (1 row) @@ -10970,27 +11083,27 @@ WHERE rid = 2; , , - + - + - ST_StdDev4ma - Raster processing function that calculates the standard deviation of pixel values in a neighborhood. + ST_Sum4ma + Raster processing function that calculates the sum of all pixel values in a neighborhood. - float8 ST_StdDev4ma + float8 ST_Sum4ma float8[][] matrix - text nodatamode + text nodatamode text[] VARIADIC args - double precision ST_StdDev4ma + double precision ST_Sum4ma double precision[][][] value integer[][] pos text[] VARIADIC userargs @@ -11001,8 +11114,12 @@ WHERE rid = 2; Description - Calculate the standard deviation of pixel values in a neighborhood of pixels. + 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. + + Variant 1 is a specialized callback function for use as a callback parameter to . @@ -11029,13 +11146,13 @@ WHERE rid = 2; SELECT rid, st_value( - st_mapalgebrafctngb(rast, 1, '32BF', 1, 1, 'st_stddev4ma(float[][],text,text[])'::regprocedure, 'ignore', NULL), 2, 2 + st_mapalgebrafctngb(rast, 1, '32BF', 1, 1, 'st_sum4ma(float[][],text,text[])'::regprocedure, 'ignore', NULL), 2, 2 ) FROM dummy_rast WHERE rid = 2; - rid | st_value ------+------------------ - 2 | 1.30170822143555 + rid | st_value +-----+---------- + 2 | 2279 (1 row) @@ -11048,131 +11165,14 @@ WHERE rid = 2; , , , - , , + , , - - - ST_InvDistWeight4ma - Raster processing function that interpolates a pixel's value from the pixel's neighborhood. - - - - - - double precision ST_InvDistWeight4ma - double precision[][][] value - integer[][] pos - text[] VARIADIC userargs - - - - - - Description - - Calculate an interpolated value for a pixel using the Inverse Distance Weighted method. - - - There are two optional parameters that can be passed through userargs. The first parameter is the power factor (variable k in the equation below) between 0 and 1 used in the Inverse Distance Weighted equation. If not specified, default value is 1. The second parameter is the weight percentage applied only when the value of the pixel of interest is included with the interpolated value from the neighborhood. If not specified and the pixel of interest has a value, that value is returned. - - - - The basic inverse distance weight equation is: - - - - - - - - - k = power factor, a real number between 0 and 1 - - - - - - - - This function is a specialized callback function for use as a callback parameter to . - - - Availability: 2.1.0 - - - - Examples - --- NEEDS EXAMPLE - - - - - See Also - - , - - - - - - - - ST_MinDist4ma - Raster processing function that returns the minimum distance (in number of pixels) between the pixel of interest and a neighboring pixel with value. - - - - - - double precision ST_MinDist4ma - double precision[][][] value - integer[][] pos - text[] VARIADIC userargs - - - - - - Description - - Return the shortest distance (in number of pixels) between the pixel of interest and the closest pixel with value in the neighborhood. - - - - The intent of this function is to provide an informative data point that helps infer the usefulness of the pixel of interest's interpolated value from . This function is particularly useful when the neighborhood is sparsely populated. - - - - - This function is a specialized callback function for use as a callback parameter to . - - - Availability: 2.1.0 - - - - Examples - --- NEEDS EXAMPLE - - - - - See Also - - , - - - - -