Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Geometry.closestPoint
Stay organized with collections
Save and categorize content based on your preferences.
Returns the point on the right input that is nearest to the left input. If either input is empty, null is returned. If both inputs are unbounded, an arbitrary point is returned. If one input is unbounded, an arbitrary point in the bounded input is returned.
| Usage | Returns | Geometry.closestPoint(right, maxError, proj) | Object |
| 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. |
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 Geometry object.
var geometry = ee.Geometry({
'type': 'Polygon',
'coordinates':
[[[-122.081, 37.417],
[-122.086, 37.421],
[-122.084, 37.418],
[-122.089, 37.416]]]
});
// Define other inputs.
var inputGeom = ee.Geometry.Polygon(
[[[-122.068, 37.418],
[-122.068, 37.416],
[-122.064, 37.416],
[-122.064, 37.418]]]);
// Apply the closestPoints method to the Geometry objects.
var closestPoints = ee.Dictionary(geometry.closestPoints({'right': inputGeom, 'maxError': 1}));
// Print the result to the console.
print('geometry.closestPoints(...) =', closestPoints);
// There is also a one-sided API for convenience.
var closestPointOnInputGeom = geometry.closestPoint({'right': inputGeom, 'maxError': 1});
print('geometry.closestPoint(...) =', closestPointOnInputGeom);
// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(geometry,
{'color': 'black'},
'Geometry [black]: geometry');
Map.addLayer(inputGeom,
{'color': 'blue'},
'Parameter [blue]: inputGeom');
Map.addLayer(closestPoints.getGeometry('left'),
{'color': 'red'},
'Result [red]: closestPointOnLeft');
Map.addLayer(closestPoints.getGeometry('right'),
{'color': 'red'},
'Result [red]: closestPointOnRight');
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 2024-10-23 UTC.
[null,null,["Last updated 2024-10-23 UTC."],[[["\u003cp\u003e\u003ccode\u003eclosestPoint()\u003c/code\u003e returns the nearest point on the right geometry to the left geometry, returning null if either input is empty.\u003c/p\u003e\n"],["\u003cp\u003eIf only one input is unbounded, an arbitrary point in the bounded input is returned, and if both are unbounded, an arbitrary point is returned.\u003c/p\u003e\n"],["\u003cp\u003eIt accepts an optional \u003ccode\u003emaxError\u003c/code\u003e for reprojection and an optional \u003ccode\u003eproj\u003c/code\u003e to define the projection for the operation, defaulting to spherical coordinates in meters if unspecified.\u003c/p\u003e\n"],["\u003cp\u003eThere is also a one-sided API: \u003ccode\u003eclosestPointOnInputGeom\u003c/code\u003e that returns a feature representing the closest point only on the input geometry.\u003c/p\u003e\n"]]],[],null,["# ee.Geometry.closestPoint\n\nReturns the point on the right input that is nearest to the left input. If either input is empty, null is returned. If both inputs are unbounded, an arbitrary point is returned. If one input is unbounded, an arbitrary point in the bounded input is returned.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|---------------------------------------------------------|---------|\n| Geometry.closestPoint`(right, `*maxError* `, `*proj*`)` | Object |\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| `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 Geometry object.\nvar geometry = ee.Geometry({\n 'type': 'Polygon',\n 'coordinates':\n [[[-122.081, 37.417],\n [-122.086, 37.421],\n [-122.084, 37.418],\n [-122.089, 37.416]]]\n});\n\n// Define other inputs.\nvar inputGeom = ee.Geometry.Polygon(\n [[[-122.068, 37.418],\n [-122.068, 37.416],\n [-122.064, 37.416],\n [-122.064, 37.418]]]);\n\n// Apply the closestPoints method to the Geometry objects.\nvar closestPoints = ee.Dictionary(geometry.closestPoints({'right': inputGeom, 'maxError': 1}));\n\n// Print the result to the console.\nprint('geometry.closestPoints(...) =', closestPoints);\n\n// There is also a one-sided API for convenience.\nvar closestPointOnInputGeom = geometry.closestPoint({'right': inputGeom, 'maxError': 1});\nprint('geometry.closestPoint(...) =', closestPointOnInputGeom);\n\n// Display relevant geometries on the map.\nMap.setCenter(-122.085, 37.422, 15);\nMap.addLayer(geometry,\n {'color': 'black'},\n 'Geometry [black]: geometry');\nMap.addLayer(inputGeom,\n {'color': 'blue'},\n 'Parameter [blue]: inputGeom');\nMap.addLayer(closestPoints.getGeometry('left'),\n {'color': 'red'},\n 'Result [red]: closestPointOnLeft');\nMap.addLayer(closestPoints.getGeometry('right'),\n {'color': 'red'},\n 'Result [red]: closestPointOnRight');\n```"]]