ee.Geometry.MultiPoint.centroid

  • The centroid of a geometry is the point at the center of its highest-dimension components.

  • Lower-dimensional components are ignored when calculating the centroid.

  • The centroid method can take optional maxError and proj arguments.

  • The result of the centroid method is a Geometry object.

 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
MultiPoint.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 MultiPoint object.
var multiPoint = ee.Geometry.MultiPoint([[-122.082, 37.420], [-122.081, 37.426]]);

// Apply the centroid method to the MultiPoint object.
var multiPointCentroid = multiPoint.centroid({'maxError': 1});

// Print the result to the console.
print('multiPoint.centroid(...) =', multiPointCentroid);

// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(multiPoint,
             {'color': 'black'},
             'Geometry [black]: multiPoint');
Map.addLayer(multiPointCentroid,
             {'color': 'red'},
             'Result [red]: multiPoint.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 MultiPoint object.
multipoint = ee.Geometry.MultiPoint([[-122.082, 37.420], [-122.081, 37.426]])

# Apply the centroid method to the MultiPoint object.
multipoint_centroid = multipoint.centroid(maxError=1)

# Print the result.
display('multipoint.centroid(...) =', multipoint_centroid)

# Display relevant geometries on the map.
m = geemap.Map()
m.set_center(-122.085, 37.422, 15)
m.add_layer(multipoint, {'color': 'black'}, 'Geometry [black]: multipoint')
m.add_layer(
    multipoint_centroid, {'color': 'red'}, 'Result [red]: multipoint.centroid'
)
m