Announcement: All noncommercial projects registered to use Earth Engine beforeApril 15, 2025 mustverify noncommercial eligibility to maintain access. If you have not verified by September 26, 2025, your access may be on hold.

ee.Geometry.LinearRing.withinDistance

  • ThewithinDistance method returns true if and only if two geometries are within a specified distance of each other.

  • The method takes the right operand geometry, a distance threshold, an optional maximum error for reprojection, and an optional projection as arguments.

  • The distance is in the units of the specified projection or in meters if no projection is specified.

  • The method is available for use in both JavaScript and Python environments with Earth Engine.

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

UsageReturns
LinearRing.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 LinearRing object.varlinearRing=ee.Geometry.LinearRing([[-122.091,37.420],[-122.085,37.422],[-122.080,37.430]]);// Define other inputs.varinputGeom=ee.Geometry.Point(-122.090,37.423);// Apply the withinDistance method to the LinearRing object.varlinearRingWithinDistance=linearRing.withinDistance({'right':inputGeom,'distance':500,'maxError':1});// Print the result to the console.print('linearRing.withinDistance(...) =',linearRingWithinDistance);// Display relevant geometries on the map.Map.setCenter(-122.085,37.422,15);Map.addLayer(linearRing,{'color':'black'},'Geometry [black]: linearRing');Map.addLayer(inputGeom,{'color':'blue'},'Parameter [blue]: inputGeom');

Python setup

See the Python Environment page for information on the Python API and usinggeemap for interactive development.

importeeimportgeemap.coreasgeemap

Colab (Python)

# Define a LinearRing object.linearring=ee.Geometry.LinearRing([[-122.091,37.420],[-122.085,37.422],[-122.080,37.430]])# Define other inputs.input_geom=ee.Geometry.Point(-122.090,37.423)# Apply the withinDistance method to the LinearRing object.linearring_within_distance=linearring.withinDistance(right=input_geom,distance=500,maxError=1)# Print the result.display('linearring.withinDistance(...) =',linearring_within_distance)# Display relevant geometries on the map.m=geemap.Map()m.set_center(-122.085,37.422,15)m.add_layer(linearring,{'color':'black'},'Geometry [black]: linearring')m.add_layer(input_geom,{'color':'blue'},'Parameter [blue]: input_geom')m

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2023-12-06 UTC.