Stay organized with collectionsSave and categorize content based on your preferences.
Aggregates over a given property of the objects in a collection, calculating the sum, min, max, mean, sample standard deviation, sample variance, total standard deviation and total variance of the selected property.
Usage
Returns
FeatureCollection.aggregate_stats(property)
Dictionary
Argument
Type
Details
this:collection
FeatureCollection
The collection to aggregate over.
property
String
The property to use from each element of the collection.
[[["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\u003eCalculates descriptive statistics (sum, min, max, mean, standard deviation, and variance) for a specified property within a FeatureCollection.\u003c/p\u003e\n"],["\u003cp\u003eAccepts a FeatureCollection and the property name as input.\u003c/p\u003e\n"],["\u003cp\u003eReturns a dictionary containing the calculated statistics.\u003c/p\u003e\n"],["\u003cp\u003eUseful for understanding the distribution and central tendency of a property across features.\u003c/p\u003e\n"],["\u003cp\u003eExamples demonstrate using the function with power plant data to calculate capacity statistics.\u003c/p\u003e\n"]]],[],null,["# ee.FeatureCollection.aggregate_stats\n\nAggregates over a given property of the objects in a collection, calculating the sum, min, max, mean, sample standard deviation, sample variance, total standard deviation and total variance of the selected property.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|-----------------------------------------------|------------|\n| FeatureCollection.aggregate_stats`(property)` | Dictionary |\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('Power plant capacities (MW) summary stats',\n fc.aggregate_stats('capacitymw'));\n\n/**\n * Expected ee.Dictionary output\n *\n * {\n * \"max\": 2910,\n * \"mean\": 201.34242424242427,\n * \"min\": 1.8,\n * \"sample_sd\": 466.4808892319684,\n * \"sample_var\": 217604.42001864797,\n * \"sum\": 13288.600000000002,\n * \"sum_sq\": 16819846.24,\n * \"total_count\": 66,\n * \"total_sd\": 462.9334545609107,\n * \"total_var\": 214307.38335169878,\n * \"valid_count\": 66,\n * \"weight_sum\": 66,\n * \"weighted_sum\": 13288.600000000002\n * }\n */\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\nfrom pprint import pprint\n\n# FeatureCollection of power plants in Belgium.\nfc = ee.FeatureCollection('WRI/GPPD/power_plants').filter(\n 'country_lg == \"Belgium\"')\n\nprint('Power plant capacities (MW) summary stats:')\npprint(fc.aggregate_stats('capacitymw').getInfo())\n\n# Expected ee.Dictionary output\n\n# {\n# \"max\": 2910,\n# \"mean\": 201.34242424242427,\n# \"min\": 1.8,\n# \"sample_sd\": 466.4808892319684,\n# \"sample_var\": 217604.42001864797,\n# \"sum\": 13288.600000000002,\n# \"sum_sq\": 16819846.24,\n# \"total_count\": 66,\n# \"total_sd\": 462.9334545609107,\n# \"total_var\": 214307.38335169878,\n# \"valid_count\": 66,\n# \"weight_sum\": 66,\n# \"weighted_sum\": 13288.600000000002\n# }\n```"]]
