AI-generated Key Takeaways
-
The
withinDistancemethod 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.
| Usage | Returns |
|---|---|
LinearRing.
withinDistance
(right, distance, maxError
, proj
)
|
Boolean |
| Argument | Type | Details |
|---|---|---|
|
this:
left
|
Geometry | The geometry used as the left operand of the operation. |
right
|
Geometry | The geometry used as the right operand of the operation. |
distance
|
Float | The distance threshold. If a projection is specified, the distance is in units of that projected coordinate system, otherwise it is in meters. |
maxError
|
ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |
proj
|
Projection, default: null | The 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. var linearRing = ee . Geometry . LinearRing ( [[ - 122.091 , 37.420 ], [ - 122.085 , 37.422 ], [ - 122.080 , 37.430 ]]); // Define other inputs. var inputGeom = ee . Geometry . Point ( - 122.090 , 37.423 ); // Apply the withinDistance method to the LinearRing object. var linearRingWithinDistance = 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' );
import ee import geemap.core as geemap
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
