Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Kernel.cross
Stay organized with collections
Save and categorize content based on your preferences.
Generates a cross-shaped boolean kernel.
| Usage | Returns | ee.Kernel.cross(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 cross kernel', ee.Kernel.cross({radius: 3}));
/**
* Output weights matrix (up to 1/1000 precision for brevity)
*
* [0.076, 0.000, 0.000, 0.000, 0.000, 0.000, 0.076]
* [0.000, 0.076, 0.000, 0.000, 0.000, 0.076, 0.000]
* [0.000, 0.000, 0.076, 0.000, 0.076, 0.000, 0.000]
* [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
* [0.000, 0.000, 0.076, 0.000, 0.076, 0.000, 0.000]
* [0.000, 0.076, 0.000, 0.000, 0.000, 0.076, 0.000]
* [0.076, 0.000, 0.000, 0.000, 0.000, 0.000, 0.076]
*/
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 cross kernel:')
pprint(ee.Kernel.cross(**{'radius': 3}).getInfo())
# Output weights matrix (up to 1/1000 precision for brevity)
# [0.076, 0.000, 0.000, 0.000, 0.000, 0.000, 0.076]
# [0.000, 0.076, 0.000, 0.000, 0.000, 0.076, 0.000]
# [0.000, 0.000, 0.076, 0.000, 0.076, 0.000, 0.000]
# [0.000, 0.000, 0.000, 0.076, 0.000, 0.000, 0.000]
# [0.000, 0.000, 0.076, 0.000, 0.076, 0.000, 0.000]
# [0.000, 0.076, 0.000, 0.000, 0.000, 0.076, 0.000]
# [0.076, 0.000, 0.000, 0.000, 0.000, 0.000, 0.076]
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 kernel with values arranged in a cross shape, useful for image processing operations.\u003c/p\u003e\n"],["\u003cp\u003eThe kernel's size is determined by the \u003ccode\u003eradius\u003c/code\u003e parameter, and values can be normalized and scaled.\u003c/p\u003e\n"],["\u003cp\u003eBy default, the kernel values are normalized to sum to 1 and scaled by 1.\u003c/p\u003e\n"],["\u003cp\u003eThe kernel can be defined in either 'pixels' or 'meters', affecting its behavior when the zoom level changes.\u003c/p\u003e\n"]]],["The core functionality is generating a cross-shaped boolean kernel using `ee.Kernel.cross`. Users specify the `radius` to define the kernel's size. They can also choose the `units` ('pixels' or 'meters'), `normalize` (to sum values to 1), and the `magnitude` to scale values. This method returns a `Kernel` object. An example shows how a radius of 3 results in a 7x7 weight matrix where only cross-shaped positions are populated.\n"],null,["# ee.Kernel.cross\n\nGenerates a cross-shaped boolean kernel.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|----------------------------------------------------------------------|---------|\n| `ee.Kernel.cross(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 cross kernel', ee.Kernel.cross({radius: 3}));\n\n/**\n * Output weights matrix (up to 1/1000 precision for brevity)\n *\n * [0.076, 0.000, 0.000, 0.000, 0.000, 0.000, 0.076]\n * [0.000, 0.076, 0.000, 0.000, 0.000, 0.076, 0.000]\n * [0.000, 0.000, 0.076, 0.000, 0.076, 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.076, 0.000, 0.076, 0.000, 0.000]\n * [0.000, 0.076, 0.000, 0.000, 0.000, 0.076, 0.000]\n * [0.076, 0.000, 0.000, 0.000, 0.000, 0.000, 0.076]\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 cross kernel:')\npprint(ee.Kernel.cross(**{'radius': 3}).getInfo())\n\n# Output weights matrix (up to 1/1000 precision for brevity)\n\n# [0.076, 0.000, 0.000, 0.000, 0.000, 0.000, 0.076]\n# [0.000, 0.076, 0.000, 0.000, 0.000, 0.076, 0.000]\n# [0.000, 0.000, 0.076, 0.000, 0.076, 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.076, 0.000, 0.076, 0.000, 0.000]\n# [0.000, 0.076, 0.000, 0.000, 0.000, 0.076, 0.000]\n# [0.076, 0.000, 0.000, 0.000, 0.000, 0.000, 0.076]\n```"]]