ee.Kernel.square

Stay organized with collections Save and categorize content based on your preferences.
Generates a square-shaped boolean kernel.

UsageReturns
ee.Kernel.square(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 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]
 */