ee.FeatureCollection.aggregate_sum

  • aggregate_sum() calculates the total sum of a specified property's values across all features within a FeatureCollection.

  • It takes a FeatureCollection and the property name as input.

  • The result is a single number representing the total sum.

  • This function is useful for calculations like finding the total capacity of power plants in a region, as demonstrated in the example.

 Aggregates over a given property of the objects in a collection, calculating the sum of the values of the selected property.

UsageReturns
FeatureCollection.aggregate_sum(property)Number
ArgumentTypeDetails
this: collectionFeatureCollectionThe collection to aggregate over.
propertyStringThe property to use from each element of the collection.

Examples

Code Editor (JavaScript)

// FeatureCollection of power plants in Belgium.
var fc = ee.FeatureCollection('WRI/GPPD/power_plants')
             .filter('country_lg == "Belgium"');

print('Sum of power plant capacities (MW)',
      fc.aggregate_sum('capacitymw'));  // 13288.600000000002

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)

# FeatureCollection of power plants in Belgium.
fc = ee.FeatureCollection('WRI/GPPD/power_plants').filter(
    'country_lg == "Belgium"')

print('Sum of power plant capacities (MW):',
      fc.aggregate_sum('capacitymw').getInfo())  # 13288.600000000002