> ## 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.within

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

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

An object is said to be within `other` if at least one of its points is located
in the `interior` and no points are located in the `exterior` of the other.
If either object is empty, this operation returns `False`.

This is the inverse of `contains` in the sense that the
expression `a.within(b) == b.contains(a)` always evaluates to
`True`.

Note: Sedona's behavior may also differ from Geopandas for GeometryCollections and for geometries that are equal.

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

## Signature

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

## Parameters

<ParamField path="other" type="GeoSeries or geometric object" required>
  The GeoSeries (elementwise) or geometric object to test if each
  geometry is within.
</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 `within` any element of the other one.
</Note>

**See also**

* `GeoSeries.contains`

## Examples

```python theme={"system"}
>>> from shapely.geometry import Polygon, LineString, Point
>>> s = GeoSeries(
...     [
...         Polygon([(0, 0), (2, 2), (0, 2)]),
...         Polygon([(0, 0), (1, 2), (0, 2)]),
...         LineString([(0, 0), (0, 2)]),
...         Point(0, 1),
...     ],
... )
>>> s2 = 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),
... )
```

```python theme={"system"}
>>> 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
```

```python theme={"system"}
>>> 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
```

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

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

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

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


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