ee.Geometry.MultiLineString.containedIn
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
// 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
# 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."],[[["The `containedIn()` method determines if one geometry is fully enclosed by another, returning true if it is and false otherwise."],["It can be applied to `MultiLineString` geometries to check their containment within other geometries like `BBox` or other polygons."],["This method accepts optional parameters such as `maxError` to control reprojection accuracy and `proj` to define the projection for calculations."],["Examples provided demonstrate the usage with JavaScript and Python, showing how to define geometries, apply the method, and visualize results on a map."]]],["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"]]