ee.Geometry.Point.withinDistance

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

  • Returns true only if the distance between geometries is less than or equal to the provided threshold.

  • Accepts optional projection and error margin parameters for customization.

  • Uses spherical coordinates and meters for distance if projection is not specified.

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

UsageReturns
Point.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 Point object.
var point = ee.Geometry.Point(-122.082, 37.42);

// Define other inputs.
var inputGeom = ee.Geometry.Point(-122.090, 37.423);

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

// Print the result to the console.
print('point.withinDistance(...) =', pointWithinDistance);

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

# Define other inputs.
input_geom = ee.Geometry.Point(-122.090, 37.423)

# Apply the withinDistance method to the Point object.
point_within_distance = point.withinDistance(
    right=input_geom, distance=500, maxError=1
)

# Print the result.
display('point.withinDistance(...) =', point_within_distance)

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