ee.Geometry.LinearRing.distance

  • distance() calculates the minimum distance between two geometries, with one being a LinearRing.

  • The distance is returned as a float and can be calculated using a specified projection or spherically in meters.

  • Optional parameters allow for controlling the error margin (maxError) and the projection (proj) used in the calculation.

  • This function is accessible within both the JavaScript and Python Earth Engine APIs.

 Returns the minimum distance between two geometries.

UsageReturns
LinearRing.distance(right, maxError, proj, spherical)Float
ArgumentTypeDetails
this: leftGeometryThe geometry used as the left operand of the operation.
rightGeometryThe geometry used as the right operand of the operation.
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.
sphericalBoolean, default: falseIf true, the calculation will be done on the unit sphere. If false, the calculation will be elliptical, taking earth flattening into account. Ignored if proj is specified. Default is false.

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 distance method to the LinearRing object.
var linearRingDistance = linearRing.distance({'right': inputGeom, 'maxError': 1});

// Print the result to the console.
print('linearRing.distance(...) =', linearRingDistance);

// 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 using geemap for interactive development.

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 distance method to the LinearRing object.
linearring_distance = linearring.distance(right=input_geom, maxError=1)

# Print the result.
display('linearring.distance(...) =', linearring_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