File: sindex.rst

package info (click to toggle)
python-geopandas 1.1.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 14,848 kB
  • sloc: python: 26,022; makefile: 147; sh: 25
file content (39 lines) | stat: -rw-r--r-- 809 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
=============
Spatial index
=============
.. currentmodule:: geopandas

GeoPandas will use the STRtree implementation provided by the Shapely
(``shapely.STRtree``)


``GeoSeries.sindex`` creates a spatial index, which can use the methods and
properties documented below.

See the User Guide page :doc:`../user_guide/spatial_indexing` for more.

Constructor
-----------
.. autosummary::
   :toctree: api/

    GeoSeries.sindex

Spatial index object
--------------------

The spatial index object returned from :attr:`GeoSeries.sindex` has the following
methods:

.. currentmodule:: geopandas.sindex.SpatialIndex
.. autosummary::
   :toctree: api/

    intersection
    is_empty
    nearest
    query
    size
    valid_query_predicates

The spatial index offers the full capability of :class:`shapely.STRtree`.