Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Kernel.rectangle
Stay organized with collections
Save and categorize content based on your preferences.
Generates a rectangular-shaped kernel.
| Usage | Returns | ee.Kernel.rectangle(xRadius, yRadius, units, normalize, magnitude) | Kernel |
| Argument | Type | Details | xRadius | Float | The horizontal radius of the kernel to generate. |
yRadius | Float | The vertical 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 rectangle kernel', ee.Kernel.rectangle({xRadius: 2, yRadius: 1}));
/**
* Output weights matrix (up to 1/1000 precision for brevity)
*
* [0.066, 0.066, 0.066, 0.066, 0.066]
* [0.066, 0.066, 0.066, 0.066, 0.066]
* [0.066, 0.066, 0.066, 0.066, 0.066]
*/
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 rectangle kernel:')
pprint(ee.Kernel.rectangle(**{'xRadius': 2, 'yRadius': 1}).getInfo());
# Output weights matrix (up to 1/1000 precision for brevity)
# [0.066, 0.066, 0.066, 0.066, 0.066]
# [0.066, 0.066, 0.066, 0.066, 0.066]
# [0.066, 0.066, 0.066, 0.066, 0.066]
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\u003eCreates a rectangular-shaped kernel for image processing.\u003c/p\u003e\n"],["\u003cp\u003eDefines the kernel's dimensions using horizontal (\u003ccode\u003exRadius\u003c/code\u003e) and vertical (\u003ccode\u003eyRadius\u003c/code\u003e) radii.\u003c/p\u003e\n"],["\u003cp\u003eAllows for specifying the kernel's units as either "pixels" or "meters", with "pixels" being the default.\u003c/p\u003e\n"],["\u003cp\u003eOptionally normalizes the kernel's weights to sum to 1 and scales the values using \u003ccode\u003emagnitude\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eCan be utilized in both JavaScript and Python environments for Earth Engine applications.\u003c/p\u003e\n"]]],[],null,["# ee.Kernel.rectangle\n\nGenerates a rectangular-shaped kernel.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|------------------------------------------------------------------------------------|---------|\n| `ee.Kernel.rectangle(xRadius, yRadius, `*units* `, `*normalize* `, `*magnitude*`)` | Kernel |\n\n| Argument | Type | Details |\n|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `xRadius` | Float | The horizontal radius of the kernel to generate. |\n| `yRadius` | Float | The vertical 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 rectangle kernel', ee.Kernel.rectangle({xRadius: 2, yRadius: 1}));\n\n/**\n * Output weights matrix (up to 1/1000 precision for brevity)\n *\n * [0.066, 0.066, 0.066, 0.066, 0.066]\n * [0.066, 0.066, 0.066, 0.066, 0.066]\n * [0.066, 0.066, 0.066, 0.066, 0.066]\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 rectangle kernel:')\npprint(ee.Kernel.rectangle(**{'xRadius': 2, 'yRadius': 1}).getInfo());\n\n# Output weights matrix (up to 1/1000 precision for brevity)\n\n# [0.066, 0.066, 0.066, 0.066, 0.066]\n# [0.066, 0.066, 0.066, 0.066, 0.066]\n# [0.066, 0.066, 0.066, 0.066, 0.066]\n```"]]