AI-generated Key Takeaways
-
Returns the area of a given geometry, with the area of points and lines being 0.
-
The area of multi-geometries is calculated as the total area of their components, potentially counting overlapping areas multiple times.
-
The area can be returned in square meters or in the units of a specified projection's coordinate system.
-
An optional
maxError
parameter controls the tolerance for reprojection errors if a projection is used.
Usage | Returns |
---|---|
BBox.area(maxError, proj) | Float |
Argument | Type | Details |
---|---|---|
this: geometry | Geometry | The geometry input. |
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 the units of the coordinate system of this projection. Otherwise it will be in square meters. |
Examples
Code Editor (JavaScript)
// Define a BBox object. var bBox = ee.Geometry.BBox(-122.09, 37.42, -122.08, 37.43); // Apply the area method to the BBox object. var bBoxArea = bBox.area({'maxError': 1}); // Print the result to the console. print('bBox.area(...) =', bBoxArea); // Display relevant geometries on the map. Map.setCenter(-122.085, 37.422, 15); Map.addLayer(bBox, {'color': 'black'}, 'Geometry [black]: bBox');
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 area method to the BBox object. bbox_area = bbox.area(maxError=1) # Print the result. display('bbox.area(...) =', bbox_area) # 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