ee.Geometry.LineString.containedIn

  • 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 various geometry types, such as LineStrings, with parameters for specifying the containing geometry, error margin, and projection.

  • The result is a boolean value indicating whether the first geometry (left) is contained within the second geometry (right).

  • Optional parameters like maxError and proj allow for handling reprojection and specifying the operational projection, respectively.

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

UsageReturns
LineString.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 LineString object.
var lineString = ee.Geometry.LineString([[-122.09, 37.42], [-122.08, 37.43]]);

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

// Apply the containedIn method to the LineString object.
var lineStringContainedIn = lineString.containedIn({'right': inputGeom, 'maxError': 1});

// Print the result to the console.
print('lineString.containedIn(...) =', lineStringContainedIn);

// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(lineString,
             {'color': 'black'},
             'Geometry [black]: lineString');
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 LineString object.
linestring = ee.Geometry.LineString([[-122.09, 37.42], [-122.08, 37.43]])

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

# Apply the containedIn method to the LineString object.
linestring_contained_in = linestring.containedIn(right=input_geom, maxError=1)

# Print the result.
display('linestring.containedIn(...) =', linestring_contained_in)

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