xrspatial.focal.circle_kernel

xrspatial.focal.circle_kernel(cellsize_x: int, cellsize_y: int, radius: int)numpy.array[source]

Generates a circular kernel of a given cellsize and radius.

cellsize_x: int

Cell size of output kernel in x direction.

cellsize_y: int

Cell size of output kernel in y direction.

radius: int

Radius of output kernel.

kernel: NumPy Array

2D array where values of 1 indicate the kernel.

Imports

>>> import numpy as np
>>> import xarray as xr
>>> from xrspatial import focal

Create Kernels

>>> focal.circle_kernel(1, 1, 3)
array([[0., 0., 0., 1., 0., 0., 0.],
       [0., 1., 1., 1., 1., 1., 0.],
       [0., 1., 1., 1., 1., 1., 0.],
       [1., 1., 1., 1., 1., 1., 1.],
       [0., 1., 1., 1., 1., 1., 0.],
       [0., 1., 1., 1., 1., 1., 0.],
       [0., 0., 0., 1., 0., 0., 0.]])
>>> focal.circle_kernel(1, 2, 3)
array([[0., 0., 0., 1., 0., 0., 0.],
       [1., 1., 1., 1., 1., 1., 1.],
       [0., 0., 0., 1., 0., 0., 0.]])