Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Kernel.kirsch
Stay organized with collections
Save and categorize content based on your preferences.
Generates a 3x3 Kirsch's Compass edge-detection kernel.
| Usage | Returns | ee.Kernel.kirsch(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 Kirsch compass kernel', ee.Kernel.kirsch());
/**
* Output weights matrix
*
* [5, -3, -3]
* [5, 0, -3]
* [5, -3, -3]
*/
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 Kirsch compass kernel:')
pprint(ee.Kernel.kirsch().getInfo())
# Output weights matrix
# [5, -3, -3]
# [5, 0, -3]
# [5, -3, -3]
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 3x3 Kirsch compass kernel for edge detection in images.\u003c/p\u003e\n"],["\u003cp\u003eThe kernel's values can be scaled using the \u003ccode\u003emagnitude\u003c/code\u003e parameter and normalized to sum to 1 with the \u003ccode\u003enormalize\u003c/code\u003e parameter.\u003c/p\u003e\n"],["\u003cp\u003eDefault kernel weights are [[5, -3, -3], [5, 0, -3], [5, -3, -3]], representing one of the eight Kirsch compass directions.\u003c/p\u003e\n"]]],["The `ee.Kernel.kirsch()` function creates a 3x3 Kirsch's Compass edge-detection kernel. This kernel's values can be scaled using the `magnitude` parameter (defaulting to 1) and normalized to sum to 1 with the `normalize` parameter (defaulting to false). The function, when invoked, returns a kernel represented by a weight matrix: `[5, -3, -3], [5, 0, -3], [5, -3, -3]`. This is demonstrated in both JavaScript and Python examples.\n"],null,["# ee.Kernel.kirsch\n\nGenerates a 3x3 Kirsch's Compass edge-detection kernel.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|---------------------------------------------------|---------|\n| `ee.Kernel.kirsch(`*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 Kirsch compass kernel', ee.Kernel.kirsch());\n\n/**\n * Output weights matrix\n *\n * [5, -3, -3]\n * [5, 0, -3]\n * [5, -3, -3]\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 Kirsch compass kernel:')\npprint(ee.Kernel.kirsch().getInfo())\n\n# Output weights matrix\n\n# [5, -3, -3]\n# [5, 0, -3]\n# [5, -3, -3]\n```"]]