geopandas.GeoSeries.within

GeoSeries.within(other, align=None)

返回一个 Series，其 dtype('bool') 为 True，表示每个对齐的几何体在 other 之内。

如果一个对象的至少一个点位于内部而没有点位于外部，则该对象被认为在其他对象内。如果任一对象为空，此操作返回False。

这是contains()的反向含义，因为表达式a.within(b) == b.contains(a)始终评估为True。

该操作以一对一的行方式进行：

Parameters:

otherGeoSeries or geometric object

要测试每个几何体是否在的GeoSeries（逐元素）或几何对象。

alignbool | None (default None)

如果为真，则根据其索引自动对齐GeoSeries。 如果为假，则保留元素的顺序。 None默认为真。

Returns:

Series (bool)

另请参阅

GeoSeries.contains

笔记

此方法按行工作。它不会检查一个 GeoSeries 的元素是否 within 任何 另一个元素。

示例

>>> from shapely.geometry import Polygon, LineString, Point
>>> s = geopandas.GeoSeries(
...     [
...         Polygon([(0, 0), (2, 2), (0, 2)]),
...         Polygon([(0, 0), (1, 2), (0, 2)]),
...         LineString([(0, 0), (0, 2)]),
...         Point(0, 1),
...     ],
... )
>>> s2 = geopandas.GeoSeries(
...     [
...         Polygon([(0, 0), (1, 1), (0, 1)]),
...         LineString([(0, 0), (0, 2)]),
...         LineString([(0, 0), (0, 1)]),
...         Point(0, 1),
...     ],
...     index=range(1, 5),
... )

>>> s
0    POLYGON ((0 0, 2 2, 0 2, 0 0))
1    POLYGON ((0 0, 1 2, 0 2, 0 0))
2             LINESTRING (0 0, 0 2)
3                       POINT (0 1)
dtype: geometry

>>> s2
1    POLYGON ((0 0, 1 1, 0 1, 0 0))
2             LINESTRING (0 0, 0 2)
3             LINESTRING (0 0, 0 1)
4                       POINT (0 1)
dtype: geometry

我们可以检查GeoSeries中的每个几何图形是否在一个单一的几何图形内：

>>> polygon = Polygon([(0, 0), (2, 2), (0, 2)])
>>> s.within(polygon)
0     True
1     True
2    False
3    False
dtype: bool

我们还可以逐行检查两个GeoSeries。 上面的GeoSeries具有不同的索引。我们可以基于索引值对两个GeoSeries进行对齐，并使用相同索引比较元素，使用 align=True，或者忽略索引并根据它们的匹配顺序比较元素，使用 align=False:

>>> s2.within(s)
0    False
1    False
2     True
3    False
4    False
dtype: bool

>>> s2.within(s, align=False)
1     True
2    False
3     True
4     True
dtype: bool