ee.Filter.withinDistance
Creates a unary or binary filter that passes if the left geometry is within a specified distance of the right geometry. If used as a join condition, this distance is used as a join measure.
| Usage | Returns |
|---|
ee.Filter.withinDistance(distance, leftField, rightValue, rightField, leftValue, maxError) | Filter |
| Argument | Type | Details |
|---|
distance | Float | The maximum distance for which the filter will return true. |
leftField | String, default: null | A selector for the left operand. Should not be specified if leftValue is specified. |
rightValue | Object, default: null | The value of the right operand. Should not be specified if rightField is specified. |
rightField | String, default: null | A selector for the right operand. Should not be specified if rightValue is specified. |
leftValue | Object, default: null | The value of the left operand. Should not be specified if leftField is specified. |
maxError | ErrorMargin, optional | The maximum reprojection error allowed during filter application. |
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-10-06 UTC.
[null,null,["Last updated 2023-10-06 UTC."],[[["Determines if one geometry lies within a specified distance of another, useful for filtering and spatial joins."],["Operates on two geometries, allowing specification by field or direct value for both."],["Distance is a crucial parameter defining the maximum allowable separation for the filter to pass."],["Offers flexibility with optional error margin control during reprojection."]]],["This functionality generates a filter based on the proximity of two geometries. It verifies if a left geometry falls within a designated `distance` of a right geometry. The `distance` parameter dictates the threshold for a true result. It accepts parameters such as `leftField`, `rightValue`, `rightField`, `leftValue`, and `maxError`. The filter's operation can be defined via fields or direct values for each geometry. When used in a join, it measures join proximity by the specified `distance`.\n"]]