Announcement: All noncommercial projects registered to use Earth Engine before April 15, 2025 must verify noncommercial eligibility to maintain Earth Engine access.
Stay organized with collections
Save and categorize content based on your preferences.
Returns true if and only if one geometry contains the other.
Usage
Returns
BBox.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 fully encloses another.\u003c/p\u003e\n"],["\u003cp\u003eIt returns \u003ccode\u003etrue\u003c/code\u003e only if the first geometry completely contains the second geometry.\u003c/p\u003e\n"],["\u003cp\u003eOptional parameters allow for error tolerance during reprojection and specifying the projection for the operation.\u003c/p\u003e\n"],["\u003cp\u003eUsage involves providing the geometry to be checked against as the \u003ccode\u003eright\u003c/code\u003e parameter within an object.\u003c/p\u003e\n"]]],["The `BBox.contains()` method checks if one geometry fully encompasses another, returning `true` if it does, and `false` otherwise. It takes a `right` geometry as input, along with optional `maxError` (error tolerance) and `proj` (projection) parameters. `left` is the geometry calling the operation. The method operates on BBox objects. It is shown how to set it up in JavaScript and Python, including example of printing to console, and displaying them on a map.\n"],null,["# ee.Geometry.BBox.contains\n\nReturns true if and only if one geometry contains the other.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|-------------------------------------------------|---------|\n| BBox.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 BBox object.\nvar bBox = ee.Geometry.BBox(-122.09, 37.42, -122.08, 37.43);\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 BBox object.\nvar bBoxContains = bBox.contains({'right': inputGeom, 'maxError': 1});\n\n// Print the result to the console.\nprint('bBox.contains(...) =', bBoxContains);\n\n// Display relevant geometries on the map.\nMap.setCenter(-122.085, 37.422, 15);\nMap.addLayer(bBox,\n {'color': 'black'},\n 'Geometry [black]: bBox');\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 BBox object.\nbbox = ee.Geometry.BBox(-122.09, 37.42, -122.08, 37.43)\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 BBox object.\nbbox_contains = bbox.contains(right=input_geom, maxError=1)\n\n# Print the result.\ndisplay('bbox.contains(...) =', bbox_contains)\n\n# Display relevant geometries on the map.\nm = geemap.Map()\nm.set_center(-122.085, 37.422, 15)\nm.add_layer(bbox, {'color': 'black'}, 'Geometry [black]: bbox')\nm.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')\nm\n```"]]