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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-12-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003ewithinDistance()\u003c/code\u003e method determines if two geometries are within a specified distance of each other, returning true if they are and false otherwise.\u003c/p\u003e\n"],["\u003cp\u003eIt takes the distance threshold, an optional projection, and an optional error margin as parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe distance is measured in meters by default, or in the units of the projected coordinate system if specified.\u003c/p\u003e\n"],["\u003cp\u003eThis method can be applied to various geometry types like polygons and points, allowing for spatial relationship analysis.\u003c/p\u003e\n"]]],["The `withinDistance` method checks if two geometries are within a specified distance. It takes a right geometry, a distance threshold, an optional `maxError` for reprojection, and an optional projection. The method returns `true` if the geometries are within the distance, otherwise `false`. Distance units depend on the projection; meters are used by default. The examples demonstrate how to use `withinDistance` in both JavaScript and Python, showing setting up the parameters and the geometries, then printing the result and showing the geometries in a map.\n"],null,["# ee.Geometry.Polygon.withinDistance\n\nReturns true if and only if the geometries are within a specified distance.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|--------------------------------------------------------------------|---------|\n| Polygon.withinDistance`(right, distance, `*maxError* `, `*proj*`)` | Boolean |\n\n| Argument | Type | Details |\n|--------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| this: `left` | Geometry | The geometry used as the left operand of the operation. |\n| `right` | Geometry | The geometry used as the right operand of the operation. |\n| `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. |\n| `maxError` | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |\n| `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. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// Define a Polygon object.\nvar polygon = ee.Geometry.Polygon(\n [[[-122.092, 37.424],\n [-122.086, 37.418],\n [-122.079, 37.425],\n [-122.085, 37.423]]]);\n\n// Define other inputs.\nvar inputGeom = ee.Geometry.Point(-122.090, 37.423);\n\n// Apply the withinDistance method to the Polygon object.\nvar polygonWithinDistance = polygon.withinDistance({'right': inputGeom, 'distance': 500, 'maxError': 1});\n\n// Print the result to the console.\nprint('polygon.withinDistance(...) =', polygonWithinDistance);\n\n// Display relevant geometries on the map.\nMap.setCenter(-122.085, 37.422, 15);\nMap.addLayer(polygon,\n {'color': 'black'},\n 'Geometry [black]: polygon');\nMap.addLayer(inputGeom,\n {'color': 'blue'},\n 'Parameter [blue]: inputGeom');\n```\nPython setup\n\nSee the [Python Environment](/earth-engine/guides/python_install) page for information on the Python API and using\n`geemap` for interactive development. \n\n```python\nimport ee\nimport geemap.core as geemap\n```\n\n### Colab (Python)\n\n```python\n# Define a Polygon object.\npolygon = ee.Geometry.Polygon([[\n [-122.092, 37.424],\n [-122.086, 37.418],\n [-122.079, 37.425],\n [-122.085, 37.423],\n]])\n\n# Define other inputs.\ninput_geom = ee.Geometry.Point(-122.090, 37.423)\n\n# Apply the withinDistance method to the Polygon object.\npolygon_within_distance = polygon.withinDistance(\n right=input_geom, distance=500, maxError=1\n)\n\n# Print the result.\ndisplay('polygon.withinDistance(...) =', polygon_within_distance)\n\n# Display relevant geometries on the map.\nm = geemap.Map()\nm.set_center(-122.085, 37.422, 15)\nm.add_layer(polygon, {'color': 'black'}, 'Geometry [black]: polygon')\nm.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')\nm\n```"]]
