geopandas.GeoSeries.crosses#

GeoSeries.crosses(other, align=True)[source]#

Returns a Series of dtype('bool') with value True for each aligned geometry that cross other.

An object is said to cross other if its interior intersects the interior of the other but does not contain it, and the dimension of the intersection is less than the dimension of the one or the other.

The operation works on a 1-to-1 row-wise manner:

Parameters:
otherGeoSeries or geometric object

The GeoSeries (elementwise) or geometric object to test if is crossed.

alignbool (default True)

If True, automatically aligns GeoSeries based on their indices. If False, the order of elements is preserved.

Returns:
Series (bool)

Notes

This method works in a row-wise manner. It does not check if an element of one GeoSeries crosses any element of the other one.

Examples

>>> from shapely.geometry import Polygon, LineString, Point
>>> s = geopandas.GeoSeries(
...     [
...         Polygon([(0, 0), (2, 2), (0, 2)]),
...         LineString([(0, 0), (2, 2)]),
...         LineString([(2, 0), (0, 2)]),
...         Point(0, 1),
...     ],
... )
>>> s2 = geopandas.GeoSeries(
...     [
...         LineString([(1, 0), (1, 3)]),
...         LineString([(2, 0), (0, 2)]),
...         Point(1, 1),
...         Point(0, 1),
...     ],
...     index=range(1, 5),
... )
>>> s
0    POLYGON ((0.00000 0.00000, 2.00000 2.00000, 0....
1        LINESTRING (0.00000 0.00000, 2.00000 2.00000)
2        LINESTRING (2.00000 0.00000, 0.00000 2.00000)
3                              POINT (0.00000 1.00000)
dtype: geometry
>>> s2
1    LINESTRING (1.00000 0.00000, 1.00000 3.00000)
2    LINESTRING (2.00000 0.00000, 0.00000 2.00000)
3                          POINT (1.00000 1.00000)
4                          POINT (0.00000 1.00000)
dtype: geometry

We can check if each geometry of GeoSeries crosses a single geometry:

>>> line = LineString([(-1, 1), (3, 1)])
>>> s.crosses(line)
0     True
1     True
2     True
3    False
dtype: bool

We can also check two GeoSeries against each other, row by row. The GeoSeries above have different indices. We can either align both GeoSeries based on index values and compare elements with the same index using align=True or ignore index and compare elements based on their matching order using align=False:

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

Notice that a line does not cross a point that it contains.