Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Kernel.octagon
Stay organized with collections
Save and categorize content based on your preferences.
Generates an octagon-shaped boolean kernel.
| Usage | Returns | ee.Kernel.octagon(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('An octagon kernel', ee.Kernel.octagon({radius: 3}));
/**
* Output weights matrix (up to 1/1000 precision for brevity)
*
* [0.000, 0.000, 0.027, 0.027, 0.027, 0.000, 0.000]
* [0.000, 0.027, 0.027, 0.027, 0.027, 0.027, 0.000]
* [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]
* [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]
* [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]
* [0.000, 0.027, 0.027, 0.027, 0.027, 0.027, 0.000]
* [0.000, 0.000, 0.027, 0.027, 0.027, 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('An octagon kernel:')
pprint(ee.Kernel.octagon(**{'radius': 3}).getInfo())
# Output weights matrix (up to 1/1000 precision for brevity)
# [0.000, 0.000, 0.027, 0.027, 0.027, 0.000, 0.000]
# [0.000, 0.027, 0.027, 0.027, 0.027, 0.027, 0.000]
# [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]
# [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]
# [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]
# [0.000, 0.027, 0.027, 0.027, 0.027, 0.027, 0.000]
# [0.000, 0.000, 0.027, 0.027, 0.027, 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\u003eCreates a kernel with an octagon shape for use in image processing.\u003c/p\u003e\n"],["\u003cp\u003eThe kernel's radius can be specified in pixels or meters, with meter-based kernels resizing with zoom level changes.\u003c/p\u003e\n"],["\u003cp\u003eKernel values are normalized by default to sum to 1 and can be scaled using the \u003ccode\u003emagnitude\u003c/code\u003e parameter.\u003c/p\u003e\n"],["\u003cp\u003eThis kernel can be used for various image operations, such as smoothing, blurring or edge detection by applying it to an image using a convolution.\u003c/p\u003e\n"]]],[],null,["# ee.Kernel.octagon\n\nGenerates an octagon-shaped boolean kernel.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|------------------------------------------------------------------------|---------|\n| `ee.Kernel.octagon(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('An octagon kernel', ee.Kernel.octagon({radius: 3}));\n\n/**\n * Output weights matrix (up to 1/1000 precision for brevity)\n *\n * [0.000, 0.000, 0.027, 0.027, 0.027, 0.000, 0.000]\n * [0.000, 0.027, 0.027, 0.027, 0.027, 0.027, 0.000]\n * [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]\n * [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]\n * [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]\n * [0.000, 0.027, 0.027, 0.027, 0.027, 0.027, 0.000]\n * [0.000, 0.000, 0.027, 0.027, 0.027, 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('An octagon kernel:')\npprint(ee.Kernel.octagon(**{'radius': 3}).getInfo())\n\n# Output weights matrix (up to 1/1000 precision for brevity)\n\n# [0.000, 0.000, 0.027, 0.027, 0.027, 0.000, 0.000]\n# [0.000, 0.027, 0.027, 0.027, 0.027, 0.027, 0.000]\n# [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]\n# [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]\n# [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]\n# [0.000, 0.027, 0.027, 0.027, 0.027, 0.027, 0.000]\n# [0.000, 0.000, 0.027, 0.027, 0.027, 0.000, 0.000]\n```"]]