Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.FeatureCollection.aggregate_sum
Stay organized with collections
Save and categorize content based on your preferences.
Aggregates over a given property of the objects in a collection, calculating the sum of the values of the selected property.
| Usage | Returns | FeatureCollection.aggregate_sum(property) | Number |
| Argument | Type | Details | this: collection | FeatureCollection | The collection to aggregate over. |
property | String | The 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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-10-06 UTC.
[null,null,["Last updated 2023-10-06 UTC."],[[["\u003cp\u003e\u003ccode\u003eaggregate_sum()\u003c/code\u003e calculates the total sum of a specified property's values across all features within a FeatureCollection.\u003c/p\u003e\n"],["\u003cp\u003eIt takes a FeatureCollection and the property name as input.\u003c/p\u003e\n"],["\u003cp\u003eThe result is a single number representing the total sum.\u003c/p\u003e\n"],["\u003cp\u003eThis function is useful for calculations like finding the total capacity of power plants in a region, as demonstrated in the example.\u003c/p\u003e\n"]]],["The `aggregate_sum` function calculates the sum of a specified property across a FeatureCollection. It takes a FeatureCollection and a property name as input. For each element in the collection, it sums the values of the provided property. The function returns a single number representing the total sum. For instance, it can be used to sum the power capacity (in MW) of all power plants in Belgium from a FeatureCollection.\n"],null,["# ee.FeatureCollection.aggregate_sum\n\nAggregates over a given property of the objects in a collection, calculating the sum of the values of the selected property.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|---------------------------------------------|---------|\n| FeatureCollection.aggregate_sum`(property)` | Number |\n\n| Argument | Type | Details |\n|--------------------|-------------------|----------------------------------------------------------|\n| this: `collection` | FeatureCollection | The collection to aggregate over. |\n| `property` | String | The property to use from each element of the collection. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// FeatureCollection of power plants in Belgium.\nvar fc = ee.FeatureCollection('WRI/GPPD/power_plants')\n .filter('country_lg == \"Belgium\"');\n\nprint('Sum of power plant capacities (MW)',\n fc.aggregate_sum('capacitymw')); // 13288.600000000002\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# FeatureCollection of power plants in Belgium.\nfc = ee.FeatureCollection('WRI/GPPD/power_plants').filter(\n 'country_lg == \"Belgium\"')\n\nprint('Sum of power plant capacities (MW):',\n fc.aggregate_sum('capacitymw').getInfo()) # 13288.600000000002\n```"]]