Announcement: All noncommercial projects registered to use Earth Engine before April 15, 2025 must verify noncommercial eligibility to maintain Earth Engine access.
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\u003eReturns \u003ccode\u003etrue\u003c/code\u003e if the input geometries are within the specified distance of one another.\u003c/p\u003e\n"],["\u003cp\u003eTakes a Geometry as the left operand and another Geometry as the right operand, along with a distance threshold.\u003c/p\u003e\n"],["\u003cp\u003eDistance is in meters or in the units of the specified projection.\u003c/p\u003e\n"],["\u003cp\u003eOptionally accepts \u003ccode\u003emaxError\u003c/code\u003e for reprojection tolerance and a \u003ccode\u003eproj\u003c/code\u003e for the operation's coordinate system.\u003c/p\u003e\n"]]],[],null,["# ee.Geometry.Rectangle.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| Rectangle.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 Rectangle object.\nvar rectangle = ee.Geometry.Rectangle(-122.09, 37.42, -122.08, 37.43);\n\n// Define other inputs.\nvar inputGeom = ee.Geometry.Point(-122.090, 37.423);\n\n// Apply the withinDistance method to the Rectangle object.\nvar rectangleWithinDistance = rectangle.withinDistance({'right': inputGeom, 'distance': 500, 'maxError': 1});\n\n// Print the result to the console.\nprint('rectangle.withinDistance(...) =', rectangleWithinDistance);\n\n// Display relevant geometries on the map.\nMap.setCenter(-122.085, 37.422, 15);\nMap.addLayer(rectangle,\n {'color': 'black'},\n 'Geometry [black]: rectangle');\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 Rectangle object.\nrectangle = ee.Geometry.Rectangle(-122.09, 37.42, -122.08, 37.43)\n\n# Define other inputs.\ninput_geom = ee.Geometry.Point(-122.090, 37.423)\n\n# Apply the withinDistance method to the Rectangle object.\nrectangle_within_distance = rectangle.withinDistance(\n right=input_geom, distance=500, maxError=1\n)\n\n# Print the result.\ndisplay('rectangle.withinDistance(...) =', rectangle_within_distance)\n\n# Display relevant geometries on the map.\nm = geemap.Map()\nm.set_center(-122.085, 37.422, 15)\nm.add_layer(rectangle, {'color': 'black'}, 'Geometry [black]: rectangle')\nm.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')\nm\n```"]]