Stay organized with collectionsSave and categorize content based on your preferences.
Returns true if and only if one geometry contains the other.
Usage
Returns
LinearRing.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 returns true if one geometry fully encloses the other.\u003c/p\u003e\n"],["\u003cp\u003eIt can be applied to LinearRing geometries and takes another geometry as 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\u003eThe method determines spatial relationships between geometries for analysis.\u003c/p\u003e\n"]]],["The `contains` method determines if one geometry fully encompasses another, returning `true` if so. It is invoked on a `LinearRing` object (`left`) and takes another `Geometry` (`right`) as input. Optional parameters include `maxError`, defining the tolerated reprojection error, and `proj`, specifying the projection for the operation; otherwise, spherical coordinates are used. An example shows how a `LinearRing` might contain a `BBox` geometry.\n"],null,["# ee.Geometry.LinearRing.contains\n\nReturns true if and only if one geometry contains the other.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|-------------------------------------------------------|---------|\n| LinearRing.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 LinearRing object.\nvar linearRing = ee.Geometry.LinearRing(\n [[-122.091, 37.420],\n [-122.085, 37.422],\n [-122.080, 37.430]]);\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 LinearRing object.\nvar linearRingContains = linearRing.contains({'right': inputGeom, 'maxError': 1});\n\n// Print the result to the console.\nprint('linearRing.contains(...) =', linearRingContains);\n\n// Display relevant geometries on the map.\nMap.setCenter(-122.085, 37.422, 15);\nMap.addLayer(linearRing,\n {'color': 'black'},\n 'Geometry [black]: linearRing');\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 LinearRing object.\nlinearring = ee.Geometry.LinearRing(\n [[-122.091, 37.420], [-122.085, 37.422], [-122.080, 37.430]]\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 LinearRing object.\nlinearring_contains = linearring.contains(right=input_geom, maxError=1)\n\n# Print the result.\ndisplay('linearring.contains(...) =', linearring_contains)\n\n# Display relevant geometries on the map.\nm = geemap.Map()\nm.set_center(-122.085, 37.422, 15)\nm.add_layer(linearring, {'color': 'black'}, 'Geometry [black]: linearring')\nm.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')\nm\n```"]]
