Announcement : All noncommercial projects registered to use Earth Engine before April 15, 2025 must verify noncommercial eligibility to maintain access. If you have not verified by September 26, 2025, your access may be on hold.

ee.Kernel.kirsch

AI-generated Key Takeaways

The ee.Kernel.kirsch function generates a 3x3 Kirsch's Compass edge-detection kernel.
Optional arguments magnitude and normalize can be used to scale or normalize the kernel values.
The output is a Kernel object, usable in JavaScript and Python examples.

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)

 display 
 ( 
 'A Kirsch compass kernel:' 
 , 
 ee 
 . 
 Kernel 
 . 
 kirsch 
 ()) 
 #  Output weights matrix 
 #  [5, -3, -3] 
 #  [5,  0, -3] 
 #  [5, -3, -3]

ee.Kernel.kirsch Stay organized with collections Save and categorize content based on your preferences.

AI-generated Key Takeaways

Examples

Code Editor (JavaScript)

Colab (Python)

ee.Kernel.kirsch