ee.Kernel.rectangle

  • Creates a rectangular-shaped kernel for image processing.

  • Defines the kernel's dimensions using horizontal (xRadius) and vertical (yRadius) radii.

  • Allows for specifying the kernel's units as either "pixels" or "meters", with "pixels" being the default.

  • Optionally normalizes the kernel's weights to sum to 1 and scales the values using magnitude.

  • Can be utilized in both JavaScript and Python environments for Earth Engine applications.

 Generates a rectangular-shaped kernel.

UsageReturns
ee.Kernel.rectangle(xRadius, yRadius, units, normalize, magnitude)Kernel
ArgumentTypeDetails
xRadiusFloatThe horizontal radius of the kernel to generate.
yRadiusFloatThe vertical 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 rectangle kernel', ee.Kernel.rectangle({xRadius: 2, yRadius: 1}));

/**
 * Output weights matrix (up to 1/1000 precision for brevity)
 *
 * [0.066, 0.066, 0.066, 0.066, 0.066]
 * [0.066, 0.066, 0.066, 0.066, 0.066]
 * [0.066, 0.066, 0.066, 0.066, 0.066]
 */

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)

from pprint import pprint

print('A rectangle kernel:')
pprint(ee.Kernel.rectangle(**{'xRadius': 2, 'yRadius': 1}).getInfo());

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

#  [0.066, 0.066, 0.066, 0.066, 0.066]
#  [0.066, 0.066, 0.066, 0.066, 0.066]
#  [0.066, 0.066, 0.066, 0.066, 0.066]