Stay organized with collectionsSave and categorize content based on your preferences.
For each band, an output band of the same name is created with the value at the given position extracted from the input multidimensional pixel in that band.
Usage
Returns
Image.arrayGet(position)
Image
Argument
Type
Details
this:image
Image
Array to get an element from.
position
Image
The coordinates of the element to get. There must be as many scalar bands as there are dimensions in the input image.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-10-06 UTC."],[[["\u003cp\u003e\u003ccode\u003earrayGet\u003c/code\u003e extracts a single value from a specific position within a multidimensional array image, creating a new image band containing that value.\u003c/p\u003e\n"],["\u003cp\u003eThe position within the array is specified using an Image where each band represents the index along a different dimension of the array.\u003c/p\u003e\n"],["\u003cp\u003eThe output image has the same name as the input band and contains the extracted value at the specified position for each pixel.\u003c/p\u003e\n"],["\u003cp\u003eThis function is useful for accessing individual elements or slices of data within a larger array structure.\u003c/p\u003e\n"]]],[],null,["# ee.Image.arrayGet\n\nFor each band, an output band of the same name is created with the value at the given position extracted from the input multidimensional pixel in that band.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|----------------------------|---------|\n| Image.arrayGet`(position)` | Image |\n\n| Argument | Type | Details |\n|---------------|-------|-----------------------------------------------------------------------------------------------------------------------|\n| this: `image` | Image | Array to get an element from. |\n| `position` | Image | The coordinates of the element to get. There must be as many scalar bands as there are dimensions in the input image. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// A function to print the array for a selected pixel in the following examples.\nfunction sampArrImg(arrImg) {\n var point = ee.Geometry.Point([-121, 42]);\n return arrImg.sample(point, 500).first().get('array');\n}\n\n// Create a 1D array image.\nvar arrayImg1D = ee.Image([0, 1, 2, 3, 4, 5]).toArray();\nprint('1D array image (pixel)', sampArrImg(arrayImg1D));\n// [0, 1, 2, 3, 4, 5]\n\n// Get the array value at a given position. Here we target the 4th element.\nvar position1D = ee.Image([3]);\nvar selectedElement1D = arrayImg1D.arrayGet(position1D);\nprint('Element at position [3] (4th element)', sampArrImg(selectedElement1D));\n// [3]\n\n// Create a 2D 2x3 array image (reshape the 1D array image).\nvar arrayImg2D = arrayImg1D.arrayReshape(ee.Image([2, 3]).toArray(), 2);\nprint('2D 2x3 array image (pixel)', sampArrImg(arrayImg2D));\n// [[0, 1, 2],\n// [3, 4, 5]]\n\n// Get the array element value at axis-0, position 0 and axis-1, position 2.\nvar position2D = ee.Image([0, 2]);\nvar selectedElement2D = arrayImg2D.arrayGet(position2D);\nprint('Element at position [0, 2]', sampArrImg(selectedElement2D));\n// 2\n```\nPython setup\n\nSee the [Python Environment](/earth-engine/guides/python_install) page for information on the Python API and using\n`geemap` for interactive development. \n\n```python\nimport ee\nimport geemap.core as geemap\n```\n\n### Colab (Python)\n\n```python\n# A function to print the array for a selected pixel in the following examples.\ndef samp_arr_img(arr_img):\n point = ee.Geometry.Point([-121, 42])\n return arr_img.sample(point, 500).first().get('array')\n\n# Create a 1D array image.\narray_img_1d = ee.Image([0, 1, 2, 3, 4, 5]).toArray()\nprint('1D array image (pixel):', samp_arr_img(array_img_1d).getInfo())\n# [0, 1, 2, 3, 4, 5]\n\n# Get the array value at a given position. Here we target the 4th element.\nposition_1d = ee.Image([3])\nselected_element_1d = array_img_1d.arrayGet(position_1d)\nprint(\n 'Element at position [3] (4th element):',\n samp_arr_img(selected_element_1d).getInfo()\n)\n# [3]\n\n# Create a 2D 2x3 array image (reshape the 1D array image).\narray_img_2d = array_img_1d.arrayReshape(ee.Image([2, 3]).toArray(), 2)\nprint('2D 2x3 array image (pixel):', samp_arr_img(array_img_2d).getInfo())\n# [[0, 1, 2],\n# [3, 4, 5]]\n\n# Get the array element value at axis-0, position 0 and axis-1, position 2.\nposition_2d = ee.Image([0, 2])\nselected_element_2d = array_img_2d.arrayGet(position_2d)\nprint(\n 'Element at position [0, 2]:',\n samp_arr_img(selected_element_2d).getInfo()\n)\n# 2\n```"]]
