Stay organized with collectionsSave and categorize content based on your preferences.
Produces a DOUBLE image where each pixel is the distance in meters from the pixel center to the nearest Point, LineString, or polygonal boundary in the collection. Note distance is also measured within interiors of polygons. Pixels that are not within 'searchRadius' meters of a geometry will be masked out.
Distances are computed on a sphere, so there is a small error proportional to the latitude difference between each pixel and the nearest geometry.
Usage
Returns
FeatureCollection.distance(searchRadius,maxError)
Image
Argument
Type
Details
this:features
FeatureCollection
Feature collection from which to get features used to compute pixel distances.
searchRadius
Float, default: 100000
Maximum distance in meters from each pixel to look for edges. Pixels will be masked unless there are edges within this distance.
maxError
Float, default: 100
Maximum reprojection error in meters, only used if the input polylines require reprojection. If '0' is provided, then this operation will fail if projection is required.
[[["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-10-06 UTC."],[[["\u003cp\u003eComputes the distance (in meters) from each pixel to the nearest point, line, or polygon within a given FeatureCollection.\u003c/p\u003e\n"],["\u003cp\u003eGenerates a double-precision image where pixel values represent the distance to the nearest feature.\u003c/p\u003e\n"],["\u003cp\u003eOffers adjustable search radius and maximum error parameters for controlling computation.\u003c/p\u003e\n"],["\u003cp\u003ePixels beyond the search radius or exceeding the error threshold are masked out.\u003c/p\u003e\n"],["\u003cp\u003eCalculations consider the Earth's curvature for accurate distance measurements.\u003c/p\u003e\n"]]],[],null,["# ee.FeatureCollection.distance\n\nProduces a DOUBLE image where each pixel is the distance in meters from the pixel center to the nearest Point, LineString, or polygonal boundary in the collection. Note distance is also measured within interiors of polygons. Pixels that are not within 'searchRadius' meters of a geometry will be masked out.\n\n\u003cbr /\u003e\n\nDistances are computed on a sphere, so there is a small error proportional to the latitude difference between each pixel and the nearest geometry.\n\n| Usage | Returns |\n|---------------------------------------------------------------|---------|\n| FeatureCollection.distance`(`*searchRadius* `, `*maxError*`)` | Image |\n\n| Argument | Type | Details |\n|------------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| this: `features` | FeatureCollection | Feature collection from which to get features used to compute pixel distances. |\n| `searchRadius` | Float, default: 100000 | Maximum distance in meters from each pixel to look for edges. Pixels will be masked unless there are edges within this distance. |\n| `maxError` | Float, default: 100 | Maximum reprojection error in meters, only used if the input polylines require reprojection. If '0' is provided, then this operation will fail if projection is required. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// FeatureCollection of power plants in Belgium.\nvar fc = ee.FeatureCollection('WRI/GPPD/power_plants')\n .filter('country_lg == \"Belgium\"');\n\n// Generate an image of distance to nearest power plant.\nvar distance = fc.distance({searchRadius: 50000, maxError: 50});\n\n// Display the image and FeatureCollection on the map.\nMap.setCenter(4.56, 50.78, 7);\nMap.addLayer(distance, {max: 50000}, 'Distance to power plants');\nMap.addLayer(fc, {color: 'red'}, 'Power plants');\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# FeatureCollection of power plants in Belgium.\nfc = ee.FeatureCollection('WRI/GPPD/power_plants').filter(\n 'country_lg == \"Belgium\"'\n)\n\n# Generate an image of distance to nearest power plant.\ndistance = fc.distance(searchRadius=50000, maxError=50)\n\n# Display the image and FeatureCollection on the map.\nm = geemap.Map()\nm.set_center(4.56, 50.78, 7)\nm.add_layer(distance, {'max': 50000}, 'Distance to power plants')\nm.add_layer(fc, {'color': 'red'}, 'Power plants')\nm\n```"]]
