ee.Geometry.containedIn
Returns true if and only if one geometry is contained in the other.
Usage | Returns |
---|
Geometry.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 Geometry object.
var geometry = ee.Geometry({
'type': 'Polygon',
'coordinates':
[[[-122.081, 37.417],
[-122.086, 37.421],
[-122.084, 37.418],
[-122.089, 37.416]]]
});
// Define other inputs.
var inputGeom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425);
// Apply the containedIn method to the Geometry object.
var geometryContainedIn = geometry.containedIn({'right': inputGeom, 'maxError': 1});
// Print the result to the console.
print('geometry.containedIn(...) =', geometryContainedIn);
// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(geometry,
{'color': 'black'},
'Geometry [black]: geometry');
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 Geometry object.
geometry = ee.Geometry({
'type': 'Polygon',
'coordinates': [[
[-122.081, 37.417],
[-122.086, 37.421],
[-122.084, 37.418],
[-122.089, 37.416],
]],
})
# Define other inputs.
input_geom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425)
# Apply the containedIn method to the Geometry object.
geometry_contained_in = geometry.containedIn(right=input_geom, maxError=1)
# Print the result.
display('geometry.containedIn(...) =', geometry_contained_in)
# Display relevant geometries on the map.
m = geemap.Map()
m.set_center(-122.085, 37.422, 15)
m.add_layer(geometry, {'color': 'black'}, 'Geometry [black]: geometry')
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 takes a 'right' geometry as input to compare against the calling geometry ('left')."],["Optional parameters include 'maxError' for reprojection tolerance and 'proj' to specify the projection for the operation."],["This method is useful for spatial analysis tasks, like checking if a feature is within a specific boundary."]]],["The `containedIn` method checks if one geometry is fully within another, returning `true` if so, `false` otherwise. It takes a `right` geometry as input, along with optional `maxError` (error tolerance) and `proj` (projection) parameters. The operation defaults to a spherical coordinate system if no projection is provided. The method is used as `Geometry.containedIn(right, maxError, proj)`, where the geometry it is called on acts as the `left` operand.\n"]]