Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Geometry.Polygon.contains
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 | 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');
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 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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-12-06 UTC.
[null,null,["Last updated 2023-12-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003econtains\u003c/code\u003e method determines if one geometry fully encloses another, returning true if it does and false otherwise.\u003c/p\u003e\n"],["\u003cp\u003eIt's used with the syntax \u003ccode\u003ePolygon.contains(right, maxError, proj)\u003c/code\u003e, where 'right' is the geometry being checked for containment.\u003c/p\u003e\n"],["\u003cp\u003eOptional parameters include \u003ccode\u003emaxError\u003c/code\u003e for reprojection tolerance and \u003ccode\u003eproj\u003c/code\u003e to define the projection for the operation, defaulting to spherical coordinates if unspecified.\u003c/p\u003e\n"],["\u003cp\u003eThe method is applicable to \u003ccode\u003ePolygon\u003c/code\u003e geometries in Earth Engine.\u003c/p\u003e\n"]]],["The `Polygon.contains()` method checks if one geometry fully encompasses another. It takes a `right` geometry as input, along with optional `maxError` and `proj` parameters for reprojection tolerance and projection definition. It returns a boolean value indicating containment. The method can be demonstrated in JavaScript and Python, showing how to define geometries and use the `contains` method. The examples show that a boolean is returned to the console, and they display geometries on a map.\n"],null,["# ee.Geometry.Polygon.contains\n\nReturns true if and only if one geometry contains the other.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|----------------------------------------------------|---------|\n| Polygon.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 Polygon object.\nvar polygon = ee.Geometry.Polygon(\n [[[-122.092, 37.424],\n [-122.086, 37.418],\n [-122.079, 37.425],\n [-122.085, 37.423]]]);\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 Polygon object.\nvar polygonContains = polygon.contains({'right': inputGeom, 'maxError': 1});\n\n// Print the result to the console.\nprint('polygon.contains(...) =', polygonContains);\n\n// Display relevant geometries on the map.\nMap.setCenter(-122.085, 37.422, 15);\nMap.addLayer(polygon,\n {'color': 'black'},\n 'Geometry [black]: polygon');\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 Polygon object.\npolygon = ee.Geometry.Polygon([[\n [-122.092, 37.424],\n [-122.086, 37.418],\n [-122.079, 37.425],\n [-122.085, 37.423],\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 Polygon object.\npolygon_contains = polygon.contains(right=input_geom, maxError=1)\n\n# Print the result.\ndisplay('polygon.contains(...) =', polygon_contains)\n\n# Display relevant geometries on the map.\nm = geemap.Map()\nm.set_center(-122.085, 37.422, 15)\nm.add_layer(polygon, {'color': 'black'}, 'Geometry [black]: polygon')\nm.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')\nm\n```"]]