Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Filter.contains
Stay organized with collections
Save and categorize content based on your preferences.
Creates a unary or binary filter that passes if the left geometry contains the right geometry (empty geometries are not contained in anything).
| Usage | Returns | ee.Filter.contains(leftField, rightValue, rightField, leftValue, maxError) | Filter |
| Argument | Type | Details | 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."],[[["\u003cp\u003eDetermines if a geometry completely encloses another geometry, passing if the left geometry contains the right geometry.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes either field selectors or direct values for both the left and right geometries in the comparison.\u003c/p\u003e\n"],["\u003cp\u003eEmpty geometries are considered to not be contained within any other geometry.\u003c/p\u003e\n"],["\u003cp\u003eIncludes an optional \u003ccode\u003emaxError\u003c/code\u003e parameter to control the allowable reprojection error during the filter's application.\u003c/p\u003e\n"]]],["This describes the creation of a filter that checks if a left geometry contains a right geometry. The filter, accessible via `ee.Filter.contains`, accepts either `leftField` and `rightField` (selectors) or `leftValue` and `rightValue` (objects) to define the geometries. An optional `maxError` argument specifies the maximum allowable reprojection error. The function returns a `Filter` object. Empty geometries are never considered contained.\n"],null,["# ee.Filter.contains\n\nCreates a unary or binary filter that passes if the left geometry contains the right geometry (empty geometries are not contained in anything).\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|------------------------------------------------------------------------------------------------------|---------|\n| `ee.Filter.contains(`*leftField* `, `*rightValue* `, `*rightField* `, `*leftValue* `, `*maxError*`)` | Filter |\n\n| Argument | Type | Details |\n|--------------|-----------------------|---------------------------------------------------------------------------------------|\n| `leftField` | String, default: null | A selector for the left operand. Should not be specified if leftValue is specified. |\n| `rightValue` | Object, default: null | The value of the right operand. Should not be specified if rightField is specified. |\n| `rightField` | String, default: null | A selector for the right operand. Should not be specified if rightValue is specified. |\n| `leftValue` | Object, default: null | The value of the left operand. Should not be specified if leftField is specified. |\n| `maxError` | ErrorMargin, optional | The maximum reprojection error allowed during filter application. |"]]