Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Kernel.plus
Stay organized with collections
Save and categorize content based on your preferences.
Generates a plus-shaped boolean kernel.
| Usage | Returns | ee.Kernel.plus(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 plus kernel', ee.Kernel.plus({radius: 3}));
/**
* Output weights matrix (1/1000 precision shown for brevity)
*
* [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
* [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
* [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
* [0.076, 0.076, 0.076, 0.076, 0.076, 0.076, 0.076]
* [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
* [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
* [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
*/
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
Colab (Python)
from pprint import pprint
print('A plus kernel:')
pprint(ee.Kernel.plus(**{'radius': 3}).getInfo())
# Output weights matrix (1/1000 precision shown for brevity)
# [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
# [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
# [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
# [0.076, 0.076, 0.076, 0.076, 0.076, 0.076, 0.076]
# [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
# [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
# [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
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."],[[["\u003cp\u003eGenerates a plus-shaped kernel (a matrix of weights) for image processing.\u003c/p\u003e\n"],["\u003cp\u003eThe kernel's radius, units of measurement, normalization, and magnitude can be customized.\u003c/p\u003e\n"],["\u003cp\u003eBy default, the kernel values are normalized to sum to 1 and have a magnitude of 1.\u003c/p\u003e\n"],["\u003cp\u003eThis kernel can be applied to images to perform operations like edge detection or feature extraction where a cross-shaped neighborhood is relevant.\u003c/p\u003e\n"]]],["A plus-shaped kernel is generated using `ee.Kernel.plus`, taking a `radius` to define its size. The `units` parameter, defaulting to 'pixels', can be set to 'meters' for zoom-responsive sizing. The kernel values can be normalized to sum to 1 with the `normalize` parameter (default true) or scaled by a `magnitude`. The kernel output is shown as a matrix with weighted values.\n"],null,["# ee.Kernel.plus\n\nGenerates a plus-shaped boolean kernel.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|---------------------------------------------------------------------|---------|\n| `ee.Kernel.plus(radius, `*units* `, `*normalize* `, `*magnitude*`)` | Kernel |\n\n| Argument | Type | Details |\n|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `radius` | Float | The radius of the kernel to generate. |\n| `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. |\n| `normalize` | Boolean, default: true | Normalize the kernel values to sum to 1. |\n| `magnitude` | Float, default: 1 | Scale each value by this amount. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\nprint('A plus kernel', ee.Kernel.plus({radius: 3}));\n\n/**\n * Output weights matrix (1/1000 precision shown for brevity)\n *\n * [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]\n * [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]\n * [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]\n * [0.076, 0.076, 0.076, 0.076, 0.076, 0.076, 0.076]\n * [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]\n * [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]\n * [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]\n */\n```\nPython setup\n\nSee the [Python Environment](/earth-engine/guides/python_install) page for information on the Python API and using\n`geemap` for interactive development. \n\n```python\nimport ee\nimport geemap.core as geemap\n```\n\n### Colab (Python)\n\n```python\nfrom pprint import pprint\n\nprint('A plus kernel:')\npprint(ee.Kernel.plus(**{'radius': 3}).getInfo())\n\n# Output weights matrix (1/1000 precision shown for brevity)\n\n# [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]\n# [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]\n# [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]\n# [0.076, 0.076, 0.076, 0.076, 0.076, 0.076, 0.076]\n# [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]\n# [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]\n# [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]\n```"]]