ST_Neighborhood
Prev  11.6. Zugriffsfunktionen und Änderungsmethoden für Rasterpixel  Next

Name

ST_Neighborhood — Gibt ein 2-D Feld in "Double Precision" aus, das sich aus nicht NODATA Werten um ein bestimmtes Pixel herum zusammensetzt. Das Pixel Kann über "columnx" und "rowy" oder über eine Punktgeometrie - im gleichen Koordinatenreferenzsystem wie der Raster - ausgewählt werden.

Synopsis

double precision[][] ST_Neighborhood(raster rast, integer bandnum, integer columnX, integer rowY, integer distanceX, integer distanceY, boolean exclude_nodata_value=true);

double precision[][] ST_Neighborhood(raster rast, integer columnX, integer rowY, integer distanceX, integer distanceY, boolean exclude_nodata_value=true);

double precision[][] ST_Neighborhood(raster rast, integer bandnum, geometry pt, integer distanceX, integer distanceY, boolean exclude_nodata_value=true);

double precision[][] ST_Neighborhood(raster rast, geometry pt, integer distanceX, integer distanceY, boolean exclude_nodata_value=true);

Beschreibung

Gibt für ein Pixel eines Bandes die ringsherum liegenden nicht-NODATA Werte in einem 2D-Feld mit Double Precision zurück. Das Pixel kann entweder über columnX und rowY, oder über einen geometrischen Punkt der im selben Koordinatenreferenzsystem wie der Raster vorliegt übergeben werden. Die Parameter distanceX und distanceY bestimmen die Anzahl der Pixel auf der X- und Y-Achse, um das festgelegte Pixel herum; z.B.: Sie möchten alle Werte innerhalb einer Entfernung von 3 Pixel entlang der X-Achse und einer Entfernung von 2 Pixel entlang der Y-Achse, um das Pixel von Interesse herum. Der Wert im Zentrum des 2-D Feldes ist der Wert jenes Pixels, das über columnX und rowY oder über einen geometrischen Punkt übergeben wurde.

Die Bandnummern beginnen mit 1 und wenn keine Bandnummer angegeben ist, dann wird für bandnum 1 angenommen. Wenn exclude_nodata_value auf FALSE gesetzt ist, werden auch die Pixel mit einem nodata Wert einbezogen. Wenn exclude_nodata_value nicht übergeben wird, dann wird er über die Metadaten des Rasters ausgelesen. 

[Note]

Die Anzahl der Elemente entlang jeder Achse des zurückgegebenen 2D-Feldes ergibt sich aus 2 * (distanceX|distanceY) + 1. So ergibt sich bei einer distanceX und einer distanceY von je 1, ein Feld von 3x3.

[Note]

Das 2-D Feld kann einer beliebigen, integrierten Funktion zur Weiterverarbeitung übergeben werden, wie z.B. an ST_Min4ma, ST_Sum4ma, ST_Mean4ma.

Verfügbarkeit: 2.1.0

Beispiele

-- 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}}