Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Kernel.sobel
Stay organized with collections
Save and categorize content based on your preferences.
Generates a 3x3 Sobel edge-detection kernel.
| Usage | Returns | ee.Kernel.sobel(magnitude, normalize) | Kernel |
| Argument | Type | Details | magnitude | Float, default: 1 | Scale each value by this amount. |
normalize | Boolean, default: false | Normalize the kernel values to sum to 1. |
Examples
Code Editor (JavaScript)
print('A Sobel kernel', ee.Kernel.sobel());
/**
* Output weights matrix
*
* [-1, 0, 1]
* [-2, 0, 2]
* [-1, 0, 1]
*/
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 Sobel kernel:')
pprint(ee.Kernel.sobel().getInfo())
# Output weights matrix
# [-1, 0, 1]
# [-2, 0, 2]
# [-1, 0, 1]
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 3x3 Sobel kernel for edge detection in images.\u003c/p\u003e\n"],["\u003cp\u003eThe kernel can be scaled using the \u003ccode\u003emagnitude\u003c/code\u003e argument.\u003c/p\u003e\n"],["\u003cp\u003eOptionally, the kernel values can be normalized to sum to 1 using the \u003ccode\u003enormalize\u003c/code\u003e argument.\u003c/p\u003e\n"],["\u003cp\u003eUsage examples are provided in JavaScript, Python, and Colab environments.\u003c/p\u003e\n"]]],["The `ee.Kernel.sobel()` function creates a 3x3 Sobel edge-detection kernel. It accepts two arguments: `magnitude`, which scales the kernel values (default is 1), and `normalize`, which normalizes the kernel to sum to 1 (default is false). The function returns a Kernel object with the weights matrix: `[-1, 0, 1]`, `[-2, 0, 2]`, `[-1, 0, 1]`. The kernel can be used in both Javascript and Python coding environments.\n"],null,["# ee.Kernel.sobel\n\nGenerates a 3x3 Sobel edge-detection kernel.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|--------------------------------------------------|---------|\n| `ee.Kernel.sobel(`*magnitude* `, `*normalize*`)` | Kernel |\n\n| Argument | Type | Details |\n|-------------|-------------------------|------------------------------------------|\n| `magnitude` | Float, default: 1 | Scale each value by this amount. |\n| `normalize` | Boolean, default: false | Normalize the kernel values to sum to 1. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\nprint('A Sobel kernel', ee.Kernel.sobel());\n\n/**\n * Output weights matrix\n *\n * [-1, 0, 1]\n * [-2, 0, 2]\n * [-1, 0, 1]\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 Sobel kernel:')\npprint(ee.Kernel.sobel().getInfo())\n\n# Output weights matrix\n\n# [-1, 0, 1]\n# [-2, 0, 2]\n# [-1, 0, 1]\n```"]]