ee.Dictionary.remove

  • The remove function for a Dictionary returns a dictionary with the specified keys removed.

  • The selectors argument takes a list of key names or regular expressions of key names to remove.

  • The ignoreMissing argument is a boolean that, when set to true, ignores selectors that don't match any keys, preventing errors.

 Returns a dictionary with the specified keys removed.

UsageReturns
Dictionary.remove(selectors, ignoreMissing)Dictionary
ArgumentTypeDetails
this: dictionaryDictionary
selectorsListA list of keys names or regular expressions of key names to remove.
ignoreMissingBoolean, default: falseIgnore selectors that don't match at least 1 key.

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('Dictionary with selected keys removed', dict.remove(['B2', 'B3']));

print('Set ignoreMissing as true to avoid an unmatched key error',
      dict.remove({selectors: ['B2', 'B3', 'Region'], ignoreMissing: true}));

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('Dictionary with selected keys removed:',
      dic.remove(['B2', 'B3']).getInfo())

dic_subset = dic.remove(**{'selectors': ['B2', 'B3', 'Region'],
                          'ignoreMissing': True})
print('Set ignoreMissing as true to avoid an unmatched key error:',
      dic_subset.getInfo())