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.containedIn
Stay organized with collections
Save and categorize content based on your preferences.
Returns true if and only if one geometry is contained in the other.
| Usage | Returns | Rectangle.containedIn(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 containedIn method to the Rectangle object.
var rectangleContainedIn = rectangle.containedIn({'right': inputGeom, 'maxError': 1});
// Print the result to the console.
print('rectangle.containedIn(...) =', rectangleContainedIn);
// 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 containedIn method to the Rectangle object.
rectangle_contained_in = rectangle.containedIn(right=input_geom, maxError=1)
# Print the result.
display('rectangle.containedIn(...) =', rectangle_contained_in)
# 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\u003econtainedIn()\u003c/code\u003e method determines if one geometry is fully enclosed within another, returning true if it is and false otherwise.\u003c/p\u003e\n"],["\u003cp\u003eIt's applicable to \u003ccode\u003eRectangle\u003c/code\u003e geometries and takes the containing geometry as the \u003ccode\u003eright\u003c/code\u003e input.\u003c/p\u003e\n"],["\u003cp\u003eOptional parameters include \u003ccode\u003emaxError\u003c/code\u003e for reprojection tolerance and \u003ccode\u003eproj\u003c/code\u003e for specifying the projection.\u003c/p\u003e\n"],["\u003cp\u003eReturns a boolean value indicating whether the first geometry ('this') is contained within the second geometry (\u003ccode\u003eright\u003c/code\u003e).\u003c/p\u003e\n"]]],["The `containedIn` method checks if one geometry is fully within another, returning `true` if so. It operates on two geometries (`left` and `right`). Users can set `maxError` for reprojection tolerance and `proj` for the coordinate system. The method, for example, applied to a rectangle determines if it is inside a given geometry. It will print the result, and can be visualized by adding both geometries to a map.\n"],null,["# ee.Geometry.Rectangle.containedIn\n\nReturns true if and only if one geometry is contained in the other.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|---------------------------------------------------------|---------|\n| Rectangle.containedIn`(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 containedIn method to the Rectangle object.\nvar rectangleContainedIn = rectangle.containedIn({'right': inputGeom, 'maxError': 1});\n\n// Print the result to the console.\nprint('rectangle.containedIn(...) =', rectangleContainedIn);\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 containedIn method to the Rectangle object.\nrectangle_contained_in = rectangle.containedIn(right=input_geom, maxError=1)\n\n# Print the result.\ndisplay('rectangle.containedIn(...) =', rectangle_contained_in)\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```"]]