> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wherobots.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GeoDataFrame.covered_by

> Returns a Series of dtype('bool') with value True for each aligned geometry that is entirely covered by other.

Returns a `Series` of `dtype('bool')` with value `True` for
each aligned geometry that is entirely covered by `other`.

An object A is said to cover another object B if no points of B lie
in the exterior of A.

Note: Sedona's implementation instead returns False for identical geometries.
Sedona's behavior may differ from Geopandas for GeometryCollections.

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

See
[https://lin-ear-th-inking.blogspot.com/2007/06/subtleties-of-ogc-covers-spatial.html](https://lin-ear-th-inking.blogspot.com/2007/06/subtleties-of-ogc-covers-spatial.html)
for reference.

## Signature

```python theme={"system"}
covered_by(other, align=None)
```

## Parameters

<ParamField path="other" type="Geoseries or geometric object" required>
  The Geoseries (elementwise) or geometric object to check is being covered.
</ParamField>

<ParamField path="align" type="bool | None (default None)" default="None">
  If True, automatically aligns GeoSeries based on their indices. None defaults to True.
  If False, the order of elements is preserved.
</ParamField>

## Returns

<ResponseField name="return" type="Series(bool)" />

<Note>
  This method works in a row-wise manner. It does not check if an element
  of one GeoSeries is `covered_by` any element of the other one.
</Note>

**See also**

* `GeoSeries.covers`
* `GeoSeries.overlaps`

## Examples

```python theme={"system"}
>>> from shapely.geometry import Polygon, LineString, Point
>>> s = GeoSeries(
...     [
...         Polygon([(0.5, 0.5), (1.5, 0.5), (1.5, 1.5), (0.5, 1.5)]),
...         Polygon([(0, 0), (2, 0), (2, 2), (0, 2)]),
...         LineString([(1, 1), (1.5, 1.5)]),
...         Point(0, 0),
...     ],
... )
>>> s2 = GeoSeries(
...     [
...         Polygon([(0, 0), (2, 0), (2, 2), (0, 2)]),
...         Polygon([(0, 0), (2, 2), (0, 2)]),
...         LineString([(0, 0), (2, 2)]),
...         Point(0, 0),
...     ],
...     index=range(1, 5),
... )
```

```python theme={"system"}
>>> s
0    POLYGON ((0.5 0.5, 1.5 0.5, 1.5 1.5, 0.5 1.5, ...
1                  POLYGON ((0 0, 2 0, 2 2, 0 2, 0 0))
2                            LINESTRING (1 1, 1.5 1.5)
3                                          POINT (0 0)
dtype: geometry
>>>
```

```python theme={"system"}
>>> s2
1    POLYGON ((0 0, 2 0, 2 2, 0 2, 0 0))
2         POLYGON ((0 0, 2 2, 0 2, 0 0))
3                  LINESTRING (0 0, 2 2)
4                            POINT (0 0)
dtype: geometry
```

We can check if each geometry of GeoSeries is covered by a single
geometry:

```python theme={"system"}
>>> poly = Polygon([(0, 0), (2, 0), (2, 2), (0, 2)])
>>> s.covered_by(poly)
0    True
1    True
2    True
3    True
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`:

```python theme={"system"}
>>> s.covered_by(s2, align=True)
0    False
1     True
2     True
3     True
4    False
dtype: bool
```

```python theme={"system"}
>>> s.covered_by(s2, align=False)
0     True
1    False
2     True
3     True
dtype: bool
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.