Class: QgsSpatialIndex¶
-
class
qgis.core.
QgsSpatialIndex
¶ Bases:
QgsFeatureSink
Constructor for
QgsSpatialIndex
. Creates an empty R-tree index.QgsSpatialIndex(fi:
QgsFeatureIterator
, feedback:QgsFeedback
= None) Constructor - creates R-tree and bulk loads it with features from the iterator. This is much faster approach than creating an empty index and then inserting features one by one.The optional
feedback
object can be used to allow cancellation of bulk feature loading. Ownership offeedback
is not transferred, and callers must take care that the lifetime of feedback exceeds that of the spatial index construction.New in version 2.8.
QgsSpatialIndex(source:
QgsFeatureSource
, feedback:QgsFeedback
= None) Constructor - creates R-tree and bulk loads it with features from the source. This is much faster approach than creating an empty index and then inserting features one by one.The optional
feedback
object can be used to allow cancellation of bulk feature loading. Ownership offeedback
is not transferred, and callers must take care that the lifetime of feedback exceeds that of the spatial index construction.New in version 3.0.
QgsSpatialIndex(other:
QgsSpatialIndex
) Copy constructorA spatial index for
QgsFeature
objects.QgsSpatialIndex
objects are implicitly shared and can be inexpensively copied.Note
While the underlying libspatialindex is not thread safe on some platforms, the QgsSpatialIndex class implements its own locks and accordingly, a single
QgsSpatialIndex
object can safely be used across multiple threads.See also
Methods
Adds a
feature
to the index.Adds a list of
features
to the index.Removes a
feature
from the index.Adds a
feature
to the index.Returns a list of features with a bounding box which intersects the specified
rectangle
.Returns nearest neighbors to a
point
.Gets reference count - just for debugging!
-
addFeature
(self, feature: QgsFeature, flags: Union[QgsFeatureSink.Flags, QgsFeatureSink.Flag] = 0) → bool¶ Adds a
feature
to the index.The
flags
argument is ignored.New in version 3.4.
addFeature(self, id: int, bounds:
QgsRectangle
) -> bool Add a featureid
to the index with a specified bounding box.- Return type
bool
- Returns
true if feature was successfully added to index.
New in version 3.4.
- Parameters
feature (QgsFeature) –
flags (Union[QgsFeatureSink.Flags) –
-
addFeatures
(self, features: object, flags: Union[QgsFeatureSink.Flags, QgsFeatureSink.Flag] = 0) → bool¶ Adds a list of
features
to the index.The
flags
argument is ignored.See also
- Parameters
features (object) –
flags (Union[QgsFeatureSink.Flags) –
- Return type
bool
-
deleteFeature
(self, feature: QgsFeature) → bool¶ Removes a
feature
from the index.- Parameters
feature (QgsFeature) –
- Return type
bool
-
insertFeature
(self, feature: QgsFeature) → bool¶ Adds a
feature
to the index.Deprecated since version Use: addFeature() instead
insertFeature(self, id: int, bounds:
QgsRectangle
) -> bool Add a featureid
to the index with a specified bounding box.- Return type
bool
- Returns
true if feature was successfully added to index.
Deprecated since version Use: addFeature() instead
- Parameters
feature (QgsFeature) –
-
intersects
(self, rectangle: QgsRectangle) → object¶ Returns a list of features with a bounding box which intersects the specified
rectangle
.Note
The intersection test is performed based on the feature bounding boxes only, so for non-point geometry features it is necessary to manually test the returned features for exact geometry intersection when required.
- Parameters
rectangle (QgsRectangle) –
- Return type
object
-
nearestNeighbor
(self, point: QgsPointXY, neighbors: int) → object¶ Returns nearest neighbors to a
point
. The number of neighbours returned is specified by theneighbours
argument.Note
The nearest neighbour test is performed based on the feature bounding boxes only, so for non-point geometry features this method is not guaranteed to return the actual closest neighbours.
- Parameters
point (QgsPointXY) –
neighbors (int) –
- Return type
object
-
refs
(self) → int¶ Gets reference count - just for debugging!
- Return type
int
-