说明

返回由给定波段像素周围的非 NODATA 值组成的 2D 双精度数组，该像素由 columnX 和 rowY 或以与光栅相同的空间参考坐标系表示的几何点指定。 distanceX 和 distanceY 参数定义指定像素周围 X 和 Y 轴上的像素数，例如，我想获取目标像素周围 X 轴上 3 个像素距离和 Y 轴上 2 个像素距离内的所有值。2D 数组的中心值将是 columnX 和 rowY 或几何点指定的像素的值。

波段号从 1 开始，如果未指定，则 bandnum 假定为 1。如果将 exclude_nodata_value 设置为 false，则所有像素都包括 nodata 像素，并且认为它们相交并返回值。如果未传入 exclude_nodata_value，则从光栅的元数据中读取它。

	返回的 2D 数组的每个轴上的元素数为 2 * (distanceX|distanceY) + 1。因此，对于 distanceX 和 distanceY 为 1，返回的数组将为 3x3。

	2D 数组输出可以传递给任何光栅处理内置函数，例如 ST_Min4ma、ST_Sum4ma、ST_Mean4ma。

可用性：2.1.0

示例

-- pixel 2x2 has value
SELECT
    ST_Neighborhood(rast, 2, 2, 1, 1)
FROM (
    SELECT
        ST_SetValues(
            ST_AddBand(
                ST_MakeEmptyRaster(5, 5, -2, 2, 1, -1, 0, 0, 0),
                '8BUI'::text, 1, 0
            ),
            1, 1, 1, ARRAY[
                [0, 1, 1, 1, 1],
                [1, 1, 1, 0, 1],
                [1, 0, 1, 1, 1],
                [1, 1, 1, 1, 0],
                [1, 1, 0, 1, 1]
            ]::double precision[],
            1
        ) AS rast
) AS foo

         st_neighborhood
---------------------------------
{{NULL,1,1},{1,1,1},{1,NULL,1}}
                

-- pixel 2x3 is NODATA
SELECT
    ST_Neighborhood(rast, 2, 3, 1, 1)
FROM (
    SELECT
        ST_SetValues(
            ST_AddBand(
                ST_MakeEmptyRaster(5, 5, -2, 2, 1, -1, 0, 0, 0),
                '8BUI'::text, 1, 0
            ),
            1, 1, 1, ARRAY[
                [0, 1, 1, 1, 1],
                [1, 1, 1, 0, 1],
                [1, 0, 1, 1, 1],
                [1, 1, 1, 1, 0],
                [1, 1, 0, 1, 1]
            ]::double precision[],
            1
        ) AS rast
) AS foo

       st_neighborhood
------------------------------
 {{1,1,1},{1,NULL,1},{1,1,1}}
                

-- pixel 3x3 has value
-- exclude_nodata_value = FALSE
SELECT
    ST_Neighborhood(rast, 3, 3, 1, 1, false)
FROM ST_SetValues(
            ST_AddBand(
                ST_MakeEmptyRaster(5, 5, -2, 2, 1, -1, 0, 0, 0),
                '8BUI'::text, 1, 0
            ),
            1, 1, 1, ARRAY[
                [0, 1, 1, 1, 1],
                [1, 1, 1, 0, 1],
                [1, 0, 1, 1, 1],
                [1, 1, 1, 1, 0],
                [1, 1, 0, 1, 1]
            ]::double precision[],
            1
        ) AS rast

      st_neighborhood
---------------------------
{{1,1,0},{0,1,1},{1,1,1}}
                

另请参见

ST_NearestValue、ST_Min4ma、ST_Max4ma、ST_Sum4ma、ST_Mean4ma、ST_Range4ma、ST_Distinct4ma、ST_StdDev4ma