ee.Geometry.MultiPoint.withinDistance

  • withinDistance determines if a geometry (left) is within a specified distance of another geometry (right).

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

  • Distance is measured in meters or in the units of the provided projection (proj).

  • Optional parameters include maxError to control reprojection accuracy.

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

UsageReturns
MultiPoint.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 MultiPoint object.
var multiPoint = ee.Geometry.MultiPoint([[-122.082, 37.420], [-122.081, 37.426]]);

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

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

// Print the result to the console.
print('multiPoint.withinDistance(...) =', multiPointWithinDistance);

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

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

# Apply the withinDistance method to the MultiPoint object.
multipoint_within_distance = multipoint.withinDistance(
    right=input_geom, distance=500, maxError=1
)

# Print the result.
display('multipoint.withinDistance(...) =', multipoint_within_distance)

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