Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Filter.isContained
Stay organized with collections
Save and categorize content based on your preferences.
Creates a unary or binary filter that passes if the right geometry contains the left geometry (empty geometries are not contained in anything).
| Usage | Returns | ee.Filter.isContained(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\u003eThe \u003ccode\u003eee.Filter.isContained\u003c/code\u003e function creates a filter that checks if one geometry fully contains another.\u003c/p\u003e\n"],["\u003cp\u003eIt can be used to filter data based on spatial relationships between two geometries, either by specifying fields or direct values.\u003c/p\u003e\n"],["\u003cp\u003eThe filter considers geometries to be contained even if their boundaries overlap.\u003c/p\u003e\n"],["\u003cp\u003eAn optional \u003ccode\u003emaxError\u003c/code\u003e parameter can be included to account for potential reprojection inaccuracies.\u003c/p\u003e\n"]]],["This filter determines if a left geometry is contained within a right geometry. It uses `ee.Filter.isContained()` and accepts either field selectors (`leftField`, `rightField`) or specific values (`leftValue`, `rightValue`) for each geometry. The filter is unary or binary based on the provided inputs. The `maxError` parameter allows setting a tolerance for reprojection errors. Empty geometries are not considered contained in any other geometry.\n"],null,["# ee.Filter.isContained\n\nCreates a unary or binary filter that passes if the right geometry contains the left geometry (empty geometries are not contained in anything).\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|---------------------------------------------------------------------------------------------------------|---------|\n| `ee.Filter.isContained(`*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. |"]]