xrspatial.focal.annulus_kernel

xrspatial.focal.annulus_kernel(cellsize_x: int, cellsize_y: int, outer_radius: int, inner_radius: int)numpy.array[source]

Generates a annulus (ring-shaped) 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.

outer_radius: int

Outer ring radius of output kernel.

inner_radius: int

Inner circle radius of output kernel.

kernel: NumPy Array

2D array of 0s and 1s where values of 1 indicate the kernel.

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

Create Kernels >>> focal.annulus_kernel(1, 1, 3, 1) array([[0., 0., 0., 1., 0., 0., 0.],

[0., 1., 1., 1., 1., 1., 0.], [0., 1., 1., 0., 1., 1., 0.], [1., 1., 0., 0., 0., 1., 1.], [0., 1., 1., 0., 1., 1., 0.], [0., 1., 1., 1., 1., 1., 0.], [0., 0., 0., 1., 0., 0., 0.]])

>>> focal.annulus_kernel(1, 2, 5, 2)
array([[0., 0., 0., 0., 0., 1., 0., 0., 0., 0., 0.],
       [0., 1., 1., 1., 1., 0., 1., 1., 1., 1., 0.],
       [1., 1., 1., 0., 0., 0., 0., 0., 1., 1., 1.],
       [0., 1., 1., 1., 1., 0., 1., 1., 1., 1., 0.],
       [0., 0., 0., 0., 0., 1., 0., 0., 0., 0., 0.]])