ee.Geometry.MultiPolygon.contains
Returns true if and only if one geometry contains the other.
Usage | Returns |
---|
MultiPolygon.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. |
Examples
// Define a MultiPolygon object.
var multiPolygon = ee.Geometry.MultiPolygon(
[[[[-122.092, 37.424],
[-122.086, 37.418],
[-122.079, 37.425],
[-122.085, 37.423]]],
[[[-122.081, 37.417],
[-122.086, 37.421],
[-122.089, 37.416]]]]);
// Define other inputs.
var inputGeom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425);
// Apply the contains method to the MultiPolygon object.
var multiPolygonContains = multiPolygon.contains({'right': inputGeom, 'maxError': 1});
// Print the result to the console.
print('multiPolygon.contains(...) =', multiPolygonContains);
// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(multiPolygon,
{'color': 'black'},
'Geometry [black]: multiPolygon');
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 MultiPolygon object.
multipolygon = ee.Geometry.MultiPolygon([
[[
[-122.092, 37.424],
[-122.086, 37.418],
[-122.079, 37.425],
[-122.085, 37.423],
]],
[[[-122.081, 37.417], [-122.086, 37.421], [-122.089, 37.416]]],
])
# Define other inputs.
input_geom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425)
# Apply the contains method to the MultiPolygon object.
multipolygon_contains = multipolygon.contains(right=input_geom, maxError=1)
# Print the result.
display('multipolygon.contains(...) =', multipolygon_contains)
# Display relevant geometries on the map.
m = geemap.Map()
m.set_center(-122.085, 37.422, 15)
m.add_layer(
multipolygon, {'color': 'black'}, 'Geometry [black]: multipolygon'
)
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 `contains` method returns true if the first geometry completely contains the second geometry."],["It can be used with MultiPolygon geometries and accepts a right-hand geometry as input."],["Optional parameters include `maxError` for reprojection tolerance and `proj` for specifying the projection."],["The method returns a boolean value indicating whether the containment condition is true or false."]]],["The `contains` method determines if one geometry fully encompasses another, returning `true` if so. It uses a left geometry (`this`) and a right geometry (`right`) as input. Optional arguments include `maxError`, which sets the tolerance for reprojection errors, and `proj`, which specifies the projection. The method is demonstrated with a MultiPolygon example, testing if it contains a given bounding box. Results and geometries are displayed via code samples.\n"]]