Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Geometry.BBox.withinDistance
Stay organized with collections
Save and categorize content based on your preferences.
Returns true if and only if the geometries are within a specified distance.
| Usage | Returns | BBox.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 BBox object.
var bBox = ee.Geometry.BBox(-122.09, 37.42, -122.08, 37.43);
// Define other inputs.
var inputGeom = ee.Geometry.Point(-122.090, 37.423);
// Apply the withinDistance method to the BBox object.
var bBoxWithinDistance = bBox.withinDistance({'right': inputGeom, 'distance': 500, 'maxError': 1});
// Print the result to the console.
print('bBox.withinDistance(...) =', bBoxWithinDistance);
// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(bBox,
{'color': 'black'},
'Geometry [black]: bBox');
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 BBox object.
bbox = ee.Geometry.BBox(-122.09, 37.42, -122.08, 37.43)
# Define other inputs.
input_geom = ee.Geometry.Point(-122.090, 37.423)
# Apply the withinDistance method to the BBox object.
bbox_within_distance = bbox.withinDistance(
right=input_geom, distance=500, maxError=1
)
# Print the result.
display('bbox.withinDistance(...) =', bbox_within_distance)
# Display relevant geometries on the map.
m = geemap.Map()
m.set_center(-122.085, 37.422, 15)
m.add_layer(bbox, {'color': 'black'}, 'Geometry [black]: bbox')
m.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')
m
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-12-06 UTC.
[null,null,["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.\u003c/p\u003e\n"],["\u003cp\u003eIt returns \u003ccode\u003etrue\u003c/code\u003e if the geometries are within the given distance, otherwise \u003ccode\u003efalse\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe distance can be specified in meters or in the units of a projected coordinate system.\u003c/p\u003e\n"],["\u003cp\u003eAn optional \u003ccode\u003emaxError\u003c/code\u003e parameter controls the tolerance for reprojection errors.\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 tolerance, and an optional `proj` for the projection. The method returns `true` if the `left` geometry (using the BBox as example) is within the specified distance of the `right` geometry, and `false` otherwise. The distance unit defaults to meters or to the specified projection units. Example code demonstrates how to use it in JavaScript and Python.\n"],null,["# ee.Geometry.BBox.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| BBox.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 BBox object.\nvar bBox = ee.Geometry.BBox(-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 BBox object.\nvar bBoxWithinDistance = bBox.withinDistance({'right': inputGeom, 'distance': 500, 'maxError': 1});\n\n// Print the result to the console.\nprint('bBox.withinDistance(...) =', bBoxWithinDistance);\n\n// Display relevant geometries on the map.\nMap.setCenter(-122.085, 37.422, 15);\nMap.addLayer(bBox,\n {'color': 'black'},\n 'Geometry [black]: bBox');\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 BBox object.\nbbox = ee.Geometry.BBox(-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 BBox object.\nbbox_within_distance = bbox.withinDistance(\n right=input_geom, distance=500, maxError=1\n)\n\n# Print the result.\ndisplay('bbox.withinDistance(...) =', bbox_within_distance)\n\n# Display relevant geometries on the map.\nm = geemap.Map()\nm.set_center(-122.085, 37.422, 15)\nm.add_layer(bbox, {'color': 'black'}, 'Geometry [black]: bbox')\nm.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')\nm\n```"]]