Announcement: All noncommercial projects registered to use Earth Engine beforeApril 15, 2025 mustverify noncommercial eligibility to maintain access. If you have not verified by September 26, 2025, your access may be on hold.

ee.Image.arrayArgmax

  • TheImage.arrayArgmax() function computes the positional indices of the maximum value in an image of array values.

  • If there are multiple occurrences of the maximum value, the indices of the first occurrence are returned.

  • The function returns anImage object.

  • The inputthis argument must be anImage.

 Computes the positional indices of the maximum value in image of array values. If there are multiple occurrences of the maximum, the indices reflect the first.

UsageReturns
Image.arrayArgmax()Image
ArgumentTypeDetails
this:imageImageThe input image.

Examples

Code Editor (JavaScript)

// A function to print the array for a selected pixel in the following examples.functionsampArrImg(arrImg){varpoint=ee.Geometry.Point([-121,42]);returnarrImg.sample(point,500).first().get('array');}// Create a 1D array image.vararrayImg1D=ee.Image([0,1,5,2,3,4]).toArray();print('1D array image (pixel)',sampArrImg(arrayImg1D));// [0, 1, 5, 2, 3, 4]// Get the position of the maximum value in a 1D array.varmaxValue1D=arrayImg1D.arrayArgmax();print('Position of the maximum 1D array value',sampArrImg(maxValue1D));// [2]// Create a 2D 2x3 array image (reshape the 1D array image).vararrayImg2D=arrayImg1D.arrayReshape(ee.Image([2,3]).toArray(),2);print('2D 2x3 array image (pixel)',sampArrImg(arrayImg2D));// [[0, 1, 5],//  [2, 3, 4]]// Get the position of the maximum value in a 2D array.varmaxValue2D=arrayImg2D.arrayArgmax();print('Position of the maximum 2D array value',sampArrImg(maxValue2D));// [0, 2]

Python setup

See the Python Environment page for information on the Python API and usinggeemap for interactive development.

importeeimportgeemap.coreasgeemap

Colab (Python)

# A function to print the array for a selected pixel in the following examples.defsamp_arr_img(arr_img):point=ee.Geometry.Point([-121,42])returnarr_img.sample(point,500).first().get('array')# Create a 1D array image.array_img_1d=ee.Image([0,1,5,2,3,4]).toArray()display('1D array image (pixel):',samp_arr_img(array_img_1d))# [0, 1, 5, 2, 3, 4]# Get the position of the maximum value in a 1D array.max_value_1d=array_img_1d.arrayArgmax()display('Position of the maximum 1D array value:',samp_arr_img(max_value_1d))# [2]# Create a 2D 2x3 array image (reshape the 1D array image).array_img_2d=array_img_1d.arrayReshape(ee.Image([2,3]).toArray(),2)display('2D 2x3 array image (pixel):',samp_arr_img(array_img_2d))# [[0, 1, 5],#  [2, 3, 4]]# Get the position of the maximum value in a 2D array.max_value_2d=array_img_2d.arrayArgmax()display('Position of the maximum 2D array value:',samp_arr_img(max_value_2d))# [0, 2]

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2023-10-06 UTC.