ee.Geometry.MultiPoint.containedIn
Returns true if and only if one geometry is contained in the other.
Usage | Returns |
---|
MultiPoint.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 MultiPoint object.
var multiPoint = ee.Geometry.MultiPoint([[-122.082, 37.420], [-122.081, 37.426]]);
// Define other inputs.
var inputGeom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425);
// Apply the containedIn method to the MultiPoint object.
var multiPointContainedIn = multiPoint.containedIn({'right': inputGeom, 'maxError': 1});
// Print the result to the console.
print('multiPoint.containedIn(...) =', multiPointContainedIn);
// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(multiPoint,
{'color': 'black'},
'Geometry [black]: multiPoint');
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 MultiPoint object.
multipoint = ee.Geometry.MultiPoint([[-122.082, 37.420], [-122.081, 37.426]])
# Define other inputs.
input_geom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425)
# Apply the containedIn method to the MultiPoint object.
multipoint_contained_in = multipoint.containedIn(right=input_geom, maxError=1)
# Print the result.
display('multipoint.containedIn(...) =', multipoint_contained_in)
# Display relevant geometries on the map.
m = geemap.Map()
m.set_center(-122.085, 37.422, 15)
m.add_layer(multipoint, {'color': 'black'}, 'Geometry [black]: multipoint')
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 within another, returning true if it is and false otherwise."],["It can be applied to `MultiPoint` geometries to check their containment within other geometries, such as bounding boxes."],["Optional parameters like `maxError` and `proj` allow for controlling the error tolerance during reprojection and specifying the projection for the operation, respectively."]]],[]]