AI-generated Key Takeaways
-
The
contains
method determines if one geometry fully encloses another, returning true if it does and false otherwise. -
It's used with the syntax
Polygon.contains(right, maxError, proj)
, where 'right' is the geometry being checked for containment. -
Optional parameters include
maxError
for reprojection tolerance andproj
to define the projection for the operation, defaulting to spherical coordinates if unspecified. -
The method is applicable to
Polygon
geometries in Earth Engine.
Usage | Returns |
---|---|
Polygon.contains(right, maxError, proj) | Boolean |
Argument | Type | Details |
---|---|---|
this: left | Geometry | The geometry used as the left operand of the operation. |
right | Geometry | The geometry used as the right operand of the operation. |
maxError | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |
proj | Projection, default: null | The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere. |
Examples
Code Editor (JavaScript)
// Define a Polygon object. var polygon = ee.Geometry.Polygon( [[[-122.092, 37.424], [-122.086, 37.418], [-122.079, 37.425], [-122.085, 37.423]]]); // Define other inputs. var inputGeom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425); // Apply the contains method to the Polygon object. var polygonContains = polygon.contains({'right': inputGeom, 'maxError': 1}); // Print the result to the console. print('polygon.contains(...) =', polygonContains); // Display relevant geometries on the map. Map.setCenter(-122.085, 37.422, 15); Map.addLayer(polygon, {'color': 'black'}, 'Geometry [black]: polygon'); Map.addLayer(inputGeom, {'color': 'blue'}, 'Parameter [blue]: inputGeom');
import ee import geemap.core as geemap
Colab (Python)
# Define a Polygon object. polygon = ee.Geometry.Polygon([[ [-122.092, 37.424], [-122.086, 37.418], [-122.079, 37.425], [-122.085, 37.423], ]]) # Define other inputs. input_geom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425) # Apply the contains method to the Polygon object. polygon_contains = polygon.contains(right=input_geom, maxError=1) # Print the result. display('polygon.contains(...) =', polygon_contains) # Display relevant geometries on the map. m = geemap.Map() m.set_center(-122.085, 37.422, 15) m.add_layer(polygon, {'color': 'black'}, 'Geometry [black]: polygon') m.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom') m