ee.Kernel.compass

  • ee.Kernel.compass() generates a 3x3 Prewitt's Compass edge-detection kernel.

  • The kernel's magnitude can be scaled using the magnitude argument.

  • The kernel values can be normalized to sum to 1 using the normalize argument.

 Generates a 3x3 Prewitt's Compass edge-detection kernel.

UsageReturns
ee.Kernel.compass(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 Prewitt compass kernel', ee.Kernel.compass());

/**
 * Output weights matrix
 *
 * [1,  1, -1]
 * [1, -2, -1]
 * [1,  1, -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)

display('A Prewitt compass kernel:', ee.Kernel.compass())

# Output weights matrix

#  [1,  1, -1]
#  [1, -2, -1]
#  [1,  1, -1]