Stay organized with collectionsSave and categorize content based on your preferences.
Returns true if and only if one geometry contains the other.
Usage
Returns
Geometry.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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-12-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003econtains\u003c/code\u003e method determines if one geometry completely encloses another, returning true if it does and false otherwise.\u003c/p\u003e\n"],["\u003cp\u003eIt takes a 'right' geometry as input, along with optional 'maxError' for reprojection tolerance and 'proj' for specifying the projection.\u003c/p\u003e\n"],["\u003cp\u003eThe operation is performed in spherical coordinates with distances in meters on the sphere if no projection is specified.\u003c/p\u003e\n"],["\u003cp\u003eExamples are provided in JavaScript, Python, and Colab to illustrate the usage and visualization of the \u003ccode\u003econtains\u003c/code\u003e method.\u003c/p\u003e\n"]]],["The `Geometry.contains()` method checks if one geometry fully contains another. It takes a `right` geometry as input, along with optional `maxError` and `proj` parameters for reprojection tolerance and projection specification. It returns `true` if the `left` geometry contains the `right` geometry, otherwise `false`. The provided code demonstrates how to apply this method in both JavaScript and Python, using example geometries and displaying the results on a map.\n"],null,["# ee.Geometry.contains\n\nReturns true if and only if one geometry contains the other.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|-----------------------------------------------------|---------|\n| Geometry.contains`(right, `*maxError* `, `*proj*`)` | Boolean |\n\n| Argument | Type | Details |\n|--------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| this: `left` | Geometry | The geometry used as the left operand of the operation. |\n| `right` | Geometry | The geometry used as the right operand of the operation. |\n| `maxError` | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |\n| `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. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// Define a Geometry object.\nvar geometry = ee.Geometry({\n 'type': 'Polygon',\n 'coordinates':\n [[[-122.081, 37.417],\n [-122.086, 37.421],\n [-122.084, 37.418],\n [-122.089, 37.416]]]\n});\n\n// Define other inputs.\nvar inputGeom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425);\n\n// Apply the contains method to the Geometry object.\nvar geometryContains = geometry.contains({'right': inputGeom, 'maxError': 1});\n\n// Print the result to the console.\nprint('geometry.contains(...) =', geometryContains);\n\n// Display relevant geometries on the map.\nMap.setCenter(-122.085, 37.422, 15);\nMap.addLayer(geometry,\n {'color': 'black'},\n 'Geometry [black]: geometry');\nMap.addLayer(inputGeom,\n {'color': 'blue'},\n 'Parameter [blue]: inputGeom');\n```\nPython setup\n\nSee the [Python Environment](/earth-engine/guides/python_install) page for information on the Python API and using\n`geemap` for interactive development. \n\n```python\nimport ee\nimport geemap.core as geemap\n```\n\n### Colab (Python)\n\n```python\n# Define a Geometry object.\ngeometry = ee.Geometry({\n 'type': 'Polygon',\n 'coordinates': [[\n [-122.081, 37.417],\n [-122.086, 37.421],\n [-122.084, 37.418],\n [-122.089, 37.416],\n ]],\n})\n\n# Define other inputs.\ninput_geom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425)\n\n# Apply the contains method to the Geometry object.\ngeometry_contains = geometry.contains(right=input_geom, maxError=1)\n\n# Print the result.\ndisplay('geometry.contains(...) =', geometry_contains)\n\n# Display relevant geometries on the map.\nm = geemap.Map()\nm.set_center(-122.085, 37.422, 15)\nm.add_layer(geometry, {'color': 'black'}, 'Geometry [black]: geometry')\nm.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')\nm\n```"]]
