ee.Kernel.kirsch

  • 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.

UsageReturns
ee.Kernel.kirsch(magnitude, normalize)Kernel
ArgumentTypeDetails
magnitudeFloat, default: 1Scale each value by this amount.
normalizeBoolean, default: falseNormalize 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]