Announcement: On November 13, 2024, all users will need to use a Cloud project in order to access Earth Engine. After this date, continued individual access without a Cloud project will require an exception.

ee.Kernel.octagon

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]