ee.Geometry.LineString.withinDistance

  • Determines if one geometry lies within a specified distance of another geometry.

  • Returns true if the geometries are within the given distance, false otherwise.

  • Takes a distance threshold, optional projection, and maximum error as parameters.

  • Can be applied to various geometry types like LineString, Point, Polygon, etc.

  • Distance is measured in meters or in the units of the projected coordinate system if specified.

 Returns true if and only if the geometries are within a specified distance.

UsageReturns
LineString.withinDistance(right, distance, 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.
distanceFloatThe distance threshold. If a projection is specified, the distance is in units of that projected coordinate system, otherwise it is in meters.
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.Point(-122.090, 37.423);

// Apply the withinDistance method to the LineString object.
var lineStringWithinDistance = lineString.withinDistance({'right': inputGeom, 'distance': 500, 'maxError': 1});

// Print the result to the console.
print('lineString.withinDistance(...) =', lineStringWithinDistance);

// 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.Point(-122.090, 37.423)

# Apply the withinDistance method to the LineString object.
linestring_within_distance = linestring.withinDistance(
    right=input_geom, distance=500, maxError=1
)

# Print the result.
display('linestring.withinDistance(...) =', linestring_within_distance)

# 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