ee.Kernel.plus

  • The ee.Kernel.plus function generates a plus-shaped boolean kernel.

  • It requires a radius argument and optionally accepts units, normalize, and magnitude.

  • The function returns a Kernel object.

Generates a plus-shaped boolean kernel.

UsageReturns
ee.Kernel.plus(radius, units, normalize, magnitude)Kernel
ArgumentTypeDetails
radiusFloatThe radius of the kernel to generate.
unitsString, default: "pixels"The system of measurement for the kernel ('pixels' or 'meters'). If the kernel is specified in meters, it will resize when the zoom-level is changed.
normalizeBoolean, default: trueNormalize the kernel values to sum to 1.
magnitudeFloat, default: 1Scale each value by this amount.

Examples

Code Editor (JavaScript)

print('A plus kernel', ee.Kernel.plus({radius: 3}));

/**
 * Output weights matrix (1/1000 precision shown for brevity)
 *
 * [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
 * [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
 * [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
 * [0.076, 0.076, 0.076, 0.076, 0.076, 0.076, 0.076]
 * [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
 * [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
 * [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
 */

Python setup

See the Python Environment page for information on the Python API and using geemap for interactive development.

import ee
import geemap.core as geemap

Colab (Python)

display('A plus kernel:', ee.Kernel.plus(**{'radius': 3}))

#  Output weights matrix (1/1000 precision shown for brevity)

#  [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
#  [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
#  [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
#  [0.076, 0.076, 0.076, 0.076, 0.076, 0.076, 0.076]
#  [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
#  [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
#  [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]