ee.Kernel.square

  • The ee.Kernel.square function generates a square-shaped boolean kernel.

  • The function takes arguments for radius , units , normalize , and magnitude to customize the kernel.

  • The radius argument determines the size of the square kernel.

  • The units argument specifies whether the radius is in pixels or meters.

  • The normalize and magnitude arguments control the normalization and scaling of the kernel values.

Generates a square-shaped boolean kernel.
Usage Returns
ee.Kernel.square(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 
 ( 
 'A square kernel' 
 , 
  
 ee 
 . 
 Kernel 
 . 
 square 
 ({ 
 radius 
 : 
  
 3 
 })); 
 /** 
 * Output weights matrix (up to 1/100 precision for brevity) 
 * 
 * [0.02, 0.02, 0.02, 0.02, 0.02, 0.02, 0.02] 
 * [0.02, 0.02, 0.02, 0.02, 0.02, 0.02, 0.02] 
 * [0.02, 0.02, 0.02, 0.02, 0.02, 0.02, 0.02] 
 * [0.02, 0.02, 0.02, 0.02, 0.02, 0.02, 0.02] 
 * [0.02, 0.02, 0.02, 0.02, 0.02, 0.02, 0.02] 
 * [0.02, 0.02, 0.02, 0.02, 0.02, 0.02, 0.02] 
 * [0.02, 0.02, 0.02, 0.02, 0.02, 0.02, 0.02] 
 */ 

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 square kernel:' 
 , 
 ee 
 . 
 Kernel 
 . 
 square 
 ( 
 ** 
 { 
 'radius' 
 : 
 3 
 })) 
 #  Output weights matrix (up to 1/100 precision for brevity) 
 #  [0.02, 0.02, 0.02, 0.02, 0.02, 0.02, 0.02] 
 #  [0.02, 0.02, 0.02, 0.02, 0.02, 0.02, 0.02] 
 #  [0.02, 0.02, 0.02, 0.02, 0.02, 0.02, 0.02] 
 #  [0.02, 0.02, 0.02, 0.02, 0.02, 0.02, 0.02] 
 #  [0.02, 0.02, 0.02, 0.02, 0.02, 0.02, 0.02] 
 #  [0.02, 0.02, 0.02, 0.02, 0.02, 0.02, 0.02] 
 #  [0.02, 0.02, 0.02, 0.02, 0.02, 0.02, 0.02] 
Create a Mobile Website
View Site in Mobile | Classic
Share by: