AI-generated Key Takeaways
-
The
ee.Kernel.circlefunction generates a circle-shaped boolean kernel. -
The function requires a
radiusargument and accepts optionalunits,normalize, andmagnitudearguments. -
The
unitsargument determines whether the kernel is measured in pixels or meters, with meters allowing for resizing based on zoom level. -
The
normalizeargument controls whether the kernel values are normalized to sum to 1. -
The
magnitudeargument scales each value in the kernel.
| Usage | Returns |
|---|---|
ee.Kernel.circle(radius, units
, normalize
, magnitude
)
|
Kernel |
| Argument | Type | Details |
|---|---|---|
radius
|
Float | The 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)
print ( 'A circle kernel' , ee . Kernel . circle ({ radius : 3 })); /** * Output weights matrix (up to 1/1000 precision for brevity) * * [0.000, 0.000, 0.000, 0.034, 0.000, 0.000, 0.000] * [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000] * [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000] * [0.034, 0.034, 0.034, 0.034, 0.034, 0.034, 0.034] * [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000] * [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000] * [0.000, 0.000, 0.000, 0.034, 0.000, 0.000, 0.000] */
import ee import geemap.core as geemap
Colab (Python)
display ( 'A circle kernel:' , ee . Kernel . circle ( ** { 'radius' : 3 })) # Output weights matrix (up to 1/1000 precision for brevity) # [0.000, 0.000, 0.000, 0.034, 0.000, 0.000, 0.000] # [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000] # [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000] # [0.034, 0.034, 0.034, 0.034, 0.034, 0.034, 0.034] # [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000] # [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000] # [0.000, 0.000, 0.000, 0.034, 0.000, 0.000, 0.000]
