Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Geometry.Rectangle.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 | Rectangle.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 Rectangle object.
var rectangle = ee.Geometry.Rectangle(-122.09, 37.42, -122.08, 37.43);
// Define other inputs.
var inputGeom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425);
// Apply the contains method to the Rectangle object.
var rectangleContains = rectangle.contains({'right': inputGeom, 'maxError': 1});
// Print the result to the console.
print('rectangle.contains(...) =', rectangleContains);
// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(rectangle,
{'color': 'black'},
'Geometry [black]: rectangle');
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 Rectangle object.
rectangle = ee.Geometry.Rectangle(-122.09, 37.42, -122.08, 37.43)
# Define other inputs.
input_geom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425)
# Apply the contains method to the Rectangle object.
rectangle_contains = rectangle.contains(right=input_geom, maxError=1)
# Print the result.
display('rectangle.contains(...) =', rectangle_contains)
# Display relevant geometries on the map.
m = geemap.Map()
m.set_center(-122.085, 37.422, 15)
m.add_layer(rectangle, {'color': 'black'}, 'Geometry [black]: rectangle')
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 applicable to Rectangle geometries and takes the target geometry, allowed error margin, and projection as input parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe operation can be performed using a specified projection or defaults to a spherical coordinate system with linear distances measured in meters.\u003c/p\u003e\n"],["\u003cp\u003eExamples are provided in JavaScript, Python, and Colab for demonstrating the usage of the \u003ccode\u003econtains\u003c/code\u003e method.\u003c/p\u003e\n"]]],[],null,["# ee.Geometry.Rectangle.contains\n\nReturns true if and only if one geometry contains the other.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|------------------------------------------------------|---------|\n| Rectangle.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 Rectangle object.\nvar rectangle = ee.Geometry.Rectangle(-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 Rectangle object.\nvar rectangleContains = rectangle.contains({'right': inputGeom, 'maxError': 1});\n\n// Print the result to the console.\nprint('rectangle.contains(...) =', rectangleContains);\n\n// Display relevant geometries on the map.\nMap.setCenter(-122.085, 37.422, 15);\nMap.addLayer(rectangle,\n {'color': 'black'},\n 'Geometry [black]: rectangle');\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 Rectangle object.\nrectangle = ee.Geometry.Rectangle(-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 Rectangle object.\nrectangle_contains = rectangle.contains(right=input_geom, maxError=1)\n\n# Print the result.\ndisplay('rectangle.contains(...) =', rectangle_contains)\n\n# Display relevant geometries on the map.\nm = geemap.Map()\nm.set_center(-122.085, 37.422, 15)\nm.add_layer(rectangle, {'color': 'black'}, 'Geometry [black]: rectangle')\nm.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')\nm\n```"]]