Announcement: All noncommercial projects registered to use Earth Engine beforeApril 15, 2025 mustverify noncommercial eligibility to maintain access. If you have not verified by September 26, 2025, your access may be on hold.

ee.Kernel.rectangle

  • Theee.Kernel.rectangle function generates a rectangular-shaped kernel.

  • The function takesxRadius,yRadius, and optionalunits,normalize, andmagnitude arguments.

  • The generated kernel is represented as a matrix of weights.

 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 usinggeemap for interactive development.

importeeimportgeemap.coreasgeemap

Colab (Python)

display('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]

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2023-10-06 UTC.