ee.Kernel.square

Generates a square-shaped boolean kernel.

UsageReturns
ee.Kernel.square(radius, units, normalize, magnitude)Kernel
ArgumentTypeDetails
radiusFloat

The 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: true

Normalize the kernel values to sum to 1.

magnitudeFloat, default: 1

Scale each value by this amount.

Examples

Code Editor (JavaScript)

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

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