Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Geometry.MultiLineString.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 | MultiLineString.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 MultiLineString object.
var multiLineString = ee.Geometry.MultiLineString(
[[[-122.088, 37.418], [-122.086, 37.422], [-122.082, 37.418]],
[[-122.087, 37.416], [-122.083, 37.416], [-122.082, 37.419]]]);
// Define other inputs.
var inputGeom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425);
// Apply the containedIn method to the MultiLineString object.
var multiLineStringContainedIn = multiLineString.containedIn({'right': inputGeom, 'maxError': 1});
// Print the result to the console.
print('multiLineString.containedIn(...) =', multiLineStringContainedIn);
// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(multiLineString,
{'color': 'black'},
'Geometry [black]: multiLineString');
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 MultiLineString object.
multilinestring = ee.Geometry.MultiLineString([
[[-122.088, 37.418], [-122.086, 37.422], [-122.082, 37.418]],
[[-122.087, 37.416], [-122.083, 37.416], [-122.082, 37.419]],
])
# Define other inputs.
input_geom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425)
# Apply the containedIn method to the MultiLineString object.
multilinestring_contained_in = multilinestring.containedIn(
right=input_geom, maxError=1
)
# Print the result.
display('multilinestring.containedIn(...) =', multilinestring_contained_in)
# Display relevant geometries on the map.
m = geemap.Map()
m.set_center(-122.085, 37.422, 15)
m.add_layer(
multilinestring, {'color': 'black'}, 'Geometry [black]: multilinestring'
)
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 by another, returning true if it is and false otherwise.\u003c/p\u003e\n"],["\u003cp\u003eIt can be applied to \u003ccode\u003eMultiLineString\u003c/code\u003e geometries to check their containment within other geometries like \u003ccode\u003eBBox\u003c/code\u003e or other polygons.\u003c/p\u003e\n"],["\u003cp\u003eThis method accepts optional parameters such as \u003ccode\u003emaxError\u003c/code\u003e to control reprojection accuracy and \u003ccode\u003eproj\u003c/code\u003e to define the projection for calculations.\u003c/p\u003e\n"],["\u003cp\u003eExamples provided demonstrate the usage with JavaScript and Python, showing how to define geometries, apply the method, and visualize results on a map.\u003c/p\u003e\n"]]],["The `containedIn` method checks if one geometry is entirely within another. It takes a right-side geometry (`right`), an optional `maxError` for reprojection tolerance, and an optional `proj` for specifying the operation's projection. It returns `true` if the left geometry (`this`) is contained within the right, and false otherwise. Examples demonstrate its use with a `MultiLineString` and a bounding box, and how to print the output and add them on a map.\n"],null,["# ee.Geometry.MultiLineString.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| MultiLineString.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 MultiLineString object.\nvar multiLineString = ee.Geometry.MultiLineString(\n [[[-122.088, 37.418], [-122.086, 37.422], [-122.082, 37.418]],\n [[-122.087, 37.416], [-122.083, 37.416], [-122.082, 37.419]]]);\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 MultiLineString object.\nvar multiLineStringContainedIn = multiLineString.containedIn({'right': inputGeom, 'maxError': 1});\n\n// Print the result to the console.\nprint('multiLineString.containedIn(...) =', multiLineStringContainedIn);\n\n// Display relevant geometries on the map.\nMap.setCenter(-122.085, 37.422, 15);\nMap.addLayer(multiLineString,\n {'color': 'black'},\n 'Geometry [black]: multiLineString');\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 MultiLineString object.\nmultilinestring = ee.Geometry.MultiLineString([\n [[-122.088, 37.418], [-122.086, 37.422], [-122.082, 37.418]],\n [[-122.087, 37.416], [-122.083, 37.416], [-122.082, 37.419]],\n])\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 MultiLineString object.\nmultilinestring_contained_in = multilinestring.containedIn(\n right=input_geom, maxError=1\n)\n\n# Print the result.\ndisplay('multilinestring.containedIn(...) =', multilinestring_contained_in)\n\n# Display relevant geometries on the map.\nm = geemap.Map()\nm.set_center(-122.085, 37.422, 15)\nm.add_layer(\n multilinestring, {'color': 'black'}, 'Geometry [black]: multilinestring'\n)\nm.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')\nm\n```"]]