ee.Geometry.LinearRing.containedIn

  • The containedIn() method returns true if one geometry is fully contained within another.

  • It can be applied to LinearRing geometries and takes a second 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 first geometry is contained within the second.

 Returns true if and only if one geometry is contained in the other.

UsageReturns
LinearRing.containedIn(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometryThe geometry used as the left operand of the operation.
rightGeometryThe geometry used as the right operand of the operation.
maxErrorErrorMargin, default: nullThe maximum amount of error tolerated when performing any necessary reprojection.
projProjection, default: nullThe 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 LinearRing object.
var linearRing = ee.Geometry.LinearRing(
    [[-122.091, 37.420],
     [-122.085, 37.422],
     [-122.080, 37.430]]);

// Define other inputs.
var inputGeom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425);

// Apply the containedIn method to the LinearRing object.
var linearRingContainedIn = linearRing.containedIn({'right': inputGeom, 'maxError': 1});

// Print the result to the console.
print('linearRing.containedIn(...) =', linearRingContainedIn);

// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(linearRing,
             {'color': 'black'},
             'Geometry [black]: linearRing');
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 LinearRing object.
linearring = ee.Geometry.LinearRing(
    [[-122.091, 37.420], [-122.085, 37.422], [-122.080, 37.430]]
)

# Define other inputs.
input_geom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425)

# Apply the containedIn method to the LinearRing object.
linearring_contained_in = linearring.containedIn(right=input_geom, maxError=1)

# Print the result.
display('linearring.containedIn(...) =', linearring_contained_in)

# Display relevant geometries on the map.
m = geemap.Map()
m.set_center(-122.085, 37.422, 15)
m.add_layer(linearring, {'color': 'black'}, 'Geometry [black]: linearring')
m.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')
m