ee.Dictionary.get

  • The Dictionary.get() method extracts the value associated with a specified key from a dictionary.

  • If the key is not found in the dictionary, the method returns a user-defined default value.

  • A null default value can be specified, resulting in a null return if the key is absent.

  • This function is applicable across different Earth Engine environments, including JavaScript, Python, and Colab.

 Extracts a named value from a dictionary. If the dictionary does not contain the given key, then defaultValue is returned, unless it is null.

UsageReturns
Dictionary.get(key, defaultValue)Object
ArgumentTypeDetails
this: dictionaryDictionary
keyString
defaultValueObject, default: null

Examples

Code Editor (JavaScript)

// A dictionary (e.g. results of ee.Image.reduceRegion of an S2 image).
var dict = ee.Dictionary({
  B1: 182,
  B2: 219,
  B3: 443
});

print('Value for "B1" key', dict.get('B1'));

// Set a default value for the case where the key does not exist.
print('Value for nonexistent "Band_1" key',
      dict.get({key: 'Band_1', defaultValue: -9999}));

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)

# A dictionary (e.g. results of ee.Image.reduceRegion of an S2 image).
dic = ee.Dictionary({
    'B1': 182,
    'B2': 219,
    'B3': 443
})

print('Value for "B1" key:', dic.get('B1').getInfo())

# Set a default value for the case where the key does not exist.
print('Value for nonexistent "Band_1" key:',
      dic.get(**{'key': 'Band_1', 'defaultValue': -9999}).getInfo())