Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Geometry.BBox.centroid
Stay organized with collections
Save and categorize content based on your preferences.
Returns a point at the center of the highest-dimension components of the geometry. Lower-dimensional components are ignored, so the centroid of a geometry containing two polygons, three lines and a point is equivalent to the centroid of a geometry containing just the two polygons.
Usage | Returns | BBox.centroid(maxError, proj) | Geometry |
Argument | Type | Details | this: geometry | Geometry | Calculates the centroid of this geometry. |
maxError | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |
proj | Projection, default: null | If specified, the result will be in this projection. Otherwise it will be in EPSG:4326. |
Examples
Code Editor (JavaScript)
// Define a BBox object.
var bBox = ee.Geometry.BBox(-122.09, 37.42, -122.08, 37.43);
// Apply the centroid method to the BBox object.
var bBoxCentroid = bBox.centroid({'maxError': 1});
// Print the result to the console.
print('bBox.centroid(...) =', bBoxCentroid);
// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(bBox,
{'color': 'black'},
'Geometry [black]: bBox');
Map.addLayer(bBoxCentroid,
{'color': 'red'},
'Result [red]: bBox.centroid');
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)
# Define a BBox object.
bbox = ee.Geometry.BBox(-122.09, 37.42, -122.08, 37.43)
# Apply the centroid method to the BBox object.
bbox_centroid = bbox.centroid(maxError=1)
# Print the result.
display('bbox.centroid(...) =', bbox_centroid)
# Display relevant geometries on the map.
m = geemap.Map()
m.set_center(-122.085, 37.422, 15)
m.add_layer(bbox, {'color': 'black'}, 'Geometry [black]: bbox')
m.add_layer(bbox_centroid, {'color': 'red'}, 'Result [red]: bbox.centroid')
m
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 2024-06-05 UTC.
[null,null,["Last updated 2024-06-05 UTC."],[[["\u003cp\u003e\u003ccode\u003ecentroid()\u003c/code\u003e returns a point at the center of the highest-dimension components of a geometry, ignoring lower dimensions.\u003c/p\u003e\n"],["\u003cp\u003eIt is applicable to various geometry types, such as polygons, lines, and points, but prioritizes the highest dimension.\u003c/p\u003e\n"],["\u003cp\u003eThe function accepts optional \u003ccode\u003emaxError\u003c/code\u003e and \u003ccode\u003eproj\u003c/code\u003e parameters for controlling reprojection and output projection.\u003c/p\u003e\n"],["\u003cp\u003eThe returned geometry represents the central point of the input geometry's primary components.\u003c/p\u003e\n"]]],[],null,["# ee.Geometry.BBox.centroid\n\nReturns a point at the center of the highest-dimension components of the geometry. Lower-dimensional components are ignored, so the centroid of a geometry containing two polygons, three lines and a point is equivalent to the centroid of a geometry containing just the two polygons.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|------------------------------------------|----------|\n| BBox.centroid`(`*maxError* `, `*proj*`)` | Geometry |\n\n| Argument | Type | Details |\n|------------------|----------------------------|-----------------------------------------------------------------------------------------|\n| this: `geometry` | Geometry | Calculates the centroid of this geometry. |\n| `maxError` | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |\n| `proj` | Projection, default: null | If specified, the result will be in this projection. Otherwise it will be in EPSG:4326. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// Define a BBox object.\nvar bBox = ee.Geometry.BBox(-122.09, 37.42, -122.08, 37.43);\n\n// Apply the centroid method to the BBox object.\nvar bBoxCentroid = bBox.centroid({'maxError': 1});\n\n// Print the result to the console.\nprint('bBox.centroid(...) =', bBoxCentroid);\n\n// Display relevant geometries on the map.\nMap.setCenter(-122.085, 37.422, 15);\nMap.addLayer(bBox,\n {'color': 'black'},\n 'Geometry [black]: bBox');\nMap.addLayer(bBoxCentroid,\n {'color': 'red'},\n 'Result [red]: bBox.centroid');\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# Define a BBox object.\nbbox = ee.Geometry.BBox(-122.09, 37.42, -122.08, 37.43)\n\n# Apply the centroid method to the BBox object.\nbbox_centroid = bbox.centroid(maxError=1)\n\n# Print the result.\ndisplay('bbox.centroid(...) =', bbox_centroid)\n\n# Display relevant geometries on the map.\nm = geemap.Map()\nm.set_center(-122.085, 37.422, 15)\nm.add_layer(bbox, {'color': 'black'}, 'Geometry [black]: bbox')\nm.add_layer(bbox_centroid, {'color': 'red'}, 'Result [red]: bbox.centroid')\nm\n```"]]