ee.Kernel.octagon

AI-generated Key Takeaways

• The ee.Kernel.octagon function generates an octagon-shaped boolean kernel.

• The function requires a radius argument and accepts optional units, normalize, and magnitude arguments.

• The generated kernel is a boolean kernel, meaning its values are either 0 or 1 by default unless normalization or magnitude scaling is applied.

Generates an octagon-shaped boolean kernel.

Usage	Returns
ee.Kernel.octagon(radius, units, normalize, magnitude)	Kernel

Argument	Type	Details
radius	Float	The radius of the kernel to generate.
units	String, default: "pixels"	The system of measurement for the kernel ('pixels' or 'meters'). If the kernel is specified in meters, it will resize when the zoom-level is changed.
normalize	Boolean, default: true	Normalize the kernel values to sum to 1.
magnitude	Float, default: 1	Scale each value by this amount.

Examples

Code Editor (JavaScript)

print('An octagon kernel', ee.Kernel.octagon({radius: 3}));

/**
 * Output weights matrix (up to 1/1000 precision for brevity)
 *
 * [0.000, 0.000, 0.027, 0.027, 0.027, 0.000, 0.000]
 * [0.000, 0.027, 0.027, 0.027, 0.027, 0.027, 0.000]
 * [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]
 * [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]
 * [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]
 * [0.000, 0.027, 0.027, 0.027, 0.027, 0.027, 0.000]
 * [0.000, 0.000, 0.027, 0.027, 0.027, 0.000, 0.000]
 */

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('An octagon kernel:')
pprint(ee.Kernel.octagon(**{'radius': 3}).getInfo())

#  Output weights matrix (up to 1/1000 precision for brevity)

#  [0.000, 0.000, 0.027, 0.027, 0.027, 0.000, 0.000]
#  [0.000, 0.027, 0.027, 0.027, 0.027, 0.027, 0.000]
#  [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]
#  [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]
#  [0.027, 0.027, 0.027, 0.027, 0.027, 0.027, 0.027]
#  [0.000, 0.027, 0.027, 0.027, 0.027, 0.027, 0.000]
#  [0.000, 0.000, 0.027, 0.027, 0.027, 0.000, 0.000]