ee.Geometry.BBox.centroid

  • centroid() returns a point at the center of the highest-dimension components of a geometry, ignoring lower dimensions.

  • It is applicable to various geometry types, such as polygons, lines, and points, but prioritizes the highest dimension.

  • The function accepts optional maxError and proj parameters for controlling reprojection and output projection.

  • The returned geometry represents the central point of the input geometry's primary components.

 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.

UsageReturns
BBox.centroid(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometryCalculates the centroid of this geometry.
maxErrorErrorMargin, default: nullThe maximum amount of error tolerated when performing any necessary reprojection.
projProjection, default: nullIf 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