ee.Kernel.gaussian
Generates a Gaussian kernel from a sampled continuous Gaussian.
Usage | Returns |
---|
ee.Kernel.gaussian(radius, sigma, units, normalize, magnitude) | Kernel |
Argument | Type | Details |
---|
radius | Float | The radius of the kernel to generate. |
sigma | Float, default: 1 | Standard deviation of the Gaussian function (same units as radius). |
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
print('A Gaussian kernel', ee.Kernel.gaussian({radius: 3}));
/**
* Output weights matrix (up to 1/1000 precision for brevity)
*
* [0.002, 0.013, 0.021, 0.013, 0.002]
* [0.013, 0.059, 0.098, 0.059, 0.013]
* [0.021, 0.098, 0.162, 0.098, 0.021]
* [0.013, 0.059, 0.098, 0.059, 0.013]
* [0.002, 0.013, 0.021, 0.013, 0.002]
*/
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 Gaussian kernel:')
pprint(ee.Kernel.gaussian(**{'radius': 3}).getInfo())
# Output weights matrix (up to 1/1000 precision for brevity)
# [0.002, 0.013, 0.021, 0.013, 0.002]
# [0.013, 0.059, 0.098, 0.059, 0.013]
# [0.021, 0.098, 0.162, 0.098, 0.021]
# [0.013, 0.059, 0.098, 0.059, 0.013]
# [0.002, 0.013, 0.021, 0.013, 0.002]
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-10-06 UTC.
[null,null,["Last updated 2023-10-06 UTC."],[[["The `ee.Kernel.gaussian` function generates a Gaussian kernel, which is essentially a matrix of weights used for image processing, derived from a continuous Gaussian distribution."],["Users can customize the kernel by defining its radius, standard deviation (`sigma`), units (pixels or meters), normalization, and magnitude (scaling factor)."],["By default, the kernel is normalized, meaning the sum of its values equals 1, and has a magnitude of 1, applying no scaling to the pixel values."],["The generated Gaussian kernel can be applied to imagery to perform various operations such as blurring or smoothing, as demonstrated in the example code snippets."]]],["The core function is to generate a Gaussian kernel using `ee.Kernel.gaussian()`. This function requires a `radius` and accepts optional parameters like `sigma` (standard deviation), `units` ('pixels' or 'meters'), `normalize` (kernel value normalization), and `magnitude` (scaling factor). The output is a kernel object. Example code demonstrates how to create and print a Gaussian kernel in JavaScript and Python, including the resulting weights matrix.\n"]]