ee.Kernel.rectangle

Generates a rectangular-shaped kernel.

Usage	Returns
ee.Kernel.rectangle(xRadius, yRadius, units, normalize, magnitude)	Kernel

Argument	Type	Details
xRadius	Float	The horizontal radius of the kernel to generate.
yRadius	Float	The vertical radius of the kernel to generate.
units	String, 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.
normalize	Boolean, default: true	Normalize the kernel values to sum to 1.
magnitude	Float, default: 1	Scale each value by this amount.

Examples

Code Editor (JavaScript)Colab (Python)

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

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]