ee.Geometry.Rectangle.centroid

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

  • The function prioritizes polygons over lines or points when calculating the center.

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

  • The returned point can be accessed as 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
Rectangle.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 Rectangle object.
var rectangle = ee.Geometry.Rectangle(-122.09, 37.42, -122.08, 37.43);

// Apply the centroid method to the Rectangle object.
var rectangleCentroid = rectangle.centroid({'maxError': 1});

// Print the result to the console.
print('rectangle.centroid(...) =', rectangleCentroid);

// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(rectangle,
             {'color': 'black'},
             'Geometry [black]: rectangle');
Map.addLayer(rectangleCentroid,
             {'color': 'red'},
             'Result [red]: rectangle.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 Rectangle object.
rectangle = ee.Geometry.Rectangle(-122.09, 37.42, -122.08, 37.43)

# Apply the centroid method to the Rectangle object.
rectangle_centroid = rectangle.centroid(maxError=1)

# Print the result.
display('rectangle.centroid(...) =', rectangle_centroid)

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