ee.Geometry.LineString.contains

  • The contains method determines if one geometry fully encloses another, returning true if it does and false otherwise.

  • It's applicable to various geometry types, demonstrated here with LineString, and takes a 'right' geometry as input for comparison.

  • Optional parameters include 'maxError' for reprojection tolerance and 'proj' to define the projection for the operation.

  • Usage involves calling the method on a geometry object (e.g., lineString.contains()) with the necessary arguments.

 Returns true if and only if one geometry contains the other.

UsageReturns
LineString.contains(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 contains method to the LineString object.
var lineStringContains = lineString.contains({'right': inputGeom, 'maxError': 1});

// Print the result to the console.
print('lineString.contains(...) =', lineStringContains);

// 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 contains method to the LineString object.
linestring_contains = linestring.contains(right=input_geom, maxError=1)

# Print the result.
display('linestring.contains(...) =', linestring_contains)

# 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