ee.Kernel.kirsch

  • Creates a 3x3 Kirsch compass kernel for edge detection in images.

  • The kernel's values can be scaled using the magnitude parameter and normalized to sum to 1 with the normalize parameter.

  • Default kernel weights are [[5, -3, -3], [5, 0, -3], [5, -3, -3]], representing one of the eight Kirsch compass directions.

 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)

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]