[processing] port spatial index algorithm to C++

qgis · Nov 25, 2019 · aed17ba · aed17ba
1 parent 7033c31
commit aed17ba
Show file tree

Hide file tree

Showing 8 changed files with 160 additions and 83 deletions.
diff --git a/python/plugins/processing/algs/help/qgis.yaml b/python/plugins/processing/algs/help/qgis.yaml
@@ -93,9 +93,6 @@ qgis:countpointsinpolygon: >
 qgis:creategrid: >
   This algorithm creates a vector layer with a grid covering a given extent. Elements in the grid can be points, lines or polygons.The size and/or placement of each element in the grid is defined using a horizontal and vertical spacing. The CRS of the output layer must be defined. The grid extent and the spacing values must be expressed in the coordinates and units of this CRS. The top-left point (minX, maxY) is used as the reference point. That means that, at that point, an element is guaranteed to be placed. Unless the width and height of the selected extent is a multiple of the selected spacing, that is not true for the other points that define that extent.
 
-qgis:createspatialindex: >
-  Creates an index to speed up access to the features in a layer based on their spatial location. Support for spatial index creation is dependent on the layer's data provider.
-
 qgis:createpointslayerfromtable: >
   This algorithm creates points layer from a table with columns that contain coordinates fields. Besides X and Y coordinates you can also specify Z and M fields.
 

diff --git a/python/plugins/processing/algs/qgis/QgisAlgorithmProvider.py b/python/plugins/processing/algs/qgis/QgisAlgorithmProvider.py
@@ -103,7 +103,6 @@
 from .SingleSidedBuffer import SingleSidedBuffer
 from .SnapGeometries import SnapGeometriesToLayer
 from .SpatialiteExecuteSQL import SpatialiteExecuteSQL
-from .SpatialIndex import SpatialIndex
 from .SpatialJoin import SpatialJoin
 from .SpatialJoinSummary import SpatialJoinSummary
 from .StatisticsByCategories import StatisticsByCategories
@@ -207,7 +206,6 @@ def getAlgs(self):
                 SingleSidedBuffer(),
                 SnapGeometriesToLayer(),
                 SpatialiteExecuteSQL(),
-                SpatialIndex(),
                 SpatialJoin(),
                 SpatialJoinSummary(),
                 StatisticsByCategories(),

diff --git a/python/plugins/processing/algs/qgis/SpatialIndex.py b/python/plugins/processing/algs/qgis/SpatialIndex.py
diff --git a/python/plugins/processing/tests/testdata/qgis_algorithm_tests2.yaml b/python/plugins/processing/tests/testdata/qgis_algorithm_tests2.yaml
@@ -1919,7 +1919,7 @@ tests:
         type: vector
         in_place_result: true
 
-  - algorithm: qgis:createspatialindex
+  - algorithm: native:createspatialindex
     name: Create spatial index
     params:
       INPUT:

diff --git a/src/analysis/CMakeLists.txt b/src/analysis/CMakeLists.txt
@@ -116,6 +116,7 @@ SET(QGIS_ANALYSIS_SRCS
   processing/qgsalgorithmslope.cpp
   processing/qgsalgorithmsmooth.cpp
   processing/qgsalgorithmsnaptogrid.cpp
+  processing/qgsalgorithmspatialindex.cpp
   processing/qgsalgorithmsplitfeaturesbyattributecharacter.cpp
   processing/qgsalgorithmsplitlineantimeridian.cpp
   processing/qgsalgorithmsplitlinesbylength.cpp

diff --git a/src/analysis/processing/qgsalgorithmspatialindex.cpp b/src/analysis/processing/qgsalgorithmspatialindex.cpp
@@ -0,0 +1,101 @@
+/***************************************************************************
+                         qgsalgorithmspatialraster.cpp
+                         ---------------------
+    begin                : November 2019
+    copyright            : (C) 2019 by Alexander Bruy
+    email                : alexander dot bruy at gmail dot com
+ ***************************************************************************/
+
+/***************************************************************************
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ ***************************************************************************/
+
+#include "qgsalgorithmspatialindex.h"
+#include "qgsvectorlayer.h"
+#include "qgsvectordataprovider.h"
+
+///@cond PRIVATE
+
+QString QgsSpatialIndexAlgorithm::name() const
+{
+  return QStringLiteral( "createspatialindex" );
+}
+
+QString QgsSpatialIndexAlgorithm::displayName() const
+{
+  return QObject::tr( "Create spatial index" );
+}
+
+QStringList QgsSpatialIndexAlgorithm::tags() const
+{
+  return QObject::tr( "table,spatial,geometry,index,create,vector" ).split( ',' );
+}
+
+QString QgsSpatialIndexAlgorithm::group() const
+{
+  return QObject::tr( "Vector general" );
+}
+
+QString QgsSpatialIndexAlgorithm::groupId() const
+{
+  return QStringLiteral( "vectorgeneral" );
+}
+
+QgsProcessingAlgorithm::Flags QgsSpatialIndexAlgorithm::flags() const
+{
+  return QgsProcessingAlgorithm::flags() | QgsProcessingAlgorithm::FlagNoThreading;
+}
+
+
+QString QgsSpatialIndexAlgorithm::shortHelpString() const
+{
+  return QObject::tr( "Creates an index to speed up access to the features "
+                      "in a layer based on their spatial location. Support "
+                      "for spatial index creation is dependent on the layer's "
+                      "data provider." );
+}
+
+QgsSpatialIndexAlgorithm *QgsSpatialIndexAlgorithm::createInstance() const
+{
+  return new QgsSpatialIndexAlgorithm();
+}
+
+void QgsSpatialIndexAlgorithm::initAlgorithm( const QVariantMap & )
+{
+  addParameter( new QgsProcessingParameterVectorLayer( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ) ) );
+
+  addOutput( new QgsProcessingOutputVectorLayer( QStringLiteral( "OUTPUT" ), QObject::tr( "Indexed layer" ) ) );
+}
+
+QVariantMap QgsSpatialIndexAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
+{
+  QgsVectorLayer *layer = parameterAsVectorLayer( parameters, QStringLiteral( "INPUT" ), context );
+
+  if ( !layer )
+    throw QgsProcessingException( QObject::tr( "Could not load source layer for %1." ).arg( QStringLiteral( "INPUT" ) ) );
+
+  QgsVectorDataProvider *provider = layer->dataProvider();
+
+  if ( provider->capabilities() & QgsVectorDataProvider::CreateSpatialIndex )
+  {
+    if ( !provider->createSpatialIndex() )
+    {
+      feedback->pushInfo( QObject::tr( "Could not create spatial index" ) );
+    }
+  }
+  else
+  {
+    feedback->pushInfo( QObject::tr( "Layer's data provider does not support spatial indexes" ) );
+  }
+
+  QVariantMap outputs;
+  outputs.insert( QStringLiteral( "OUTPUT" ), layer->id() );
+  return outputs;
+}
+
+///@endcond
diff --git a/src/analysis/processing/qgsalgorithmspatialindex.h b/src/analysis/processing/qgsalgorithmspatialindex.h
@@ -0,0 +1,55 @@
+/***************************************************************************
+                         qgsalgorithmspatialindex.h
+                         ------------------------------
+    begin                : November 2019
+    copyright            : (C) 2019 by Alexander Bruy
+    email                : alexander dot bruy at gmail dot com
+ ***************************************************************************/
+
+/***************************************************************************
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ ***************************************************************************/
+
+#ifndef QGSALGORITHMSPATIALINDEX_H
+#define QGSALGORITHMSPATIALINDEX_H
+
+#define SIP_NO_FILE
+
+#include "qgis_sip.h"
+#include "qgsprocessingalgorithm.h"
+
+///@cond PRIVATE
+
+/**
+ * Native constant raster algorithm.
+ */
+class QgsSpatialIndexAlgorithm : public QgsProcessingAlgorithm
+{
+
+  public:
+
+    QgsSpatialIndexAlgorithm() = default;
+    void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
+    QString name() const override;
+    QString displayName() const override;
+    QStringList tags() const override;
+    QString group() const override;
+    QString groupId() const override;
+    Flags flags() const override;
+    QString shortHelpString() const override;
+    QgsSpatialIndexAlgorithm *createInstance() const override SIP_FACTORY;
+
+  protected:
+
+    QVariantMap processAlgorithm( const QVariantMap &parameters,
+                                  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
+};
+
+///@endcond PRIVATE
+
+#endif // QGSALGORITHMSPATIALINDEX_H
diff --git a/src/analysis/processing/qgsnativealgorithms.cpp b/src/analysis/processing/qgsnativealgorithms.cpp
@@ -110,6 +110,7 @@
 #include "qgsalgorithmslope.h"
 #include "qgsalgorithmsmooth.h"
 #include "qgsalgorithmsnaptogrid.h"
+#include "qgsalgorithmspatialindex.h"
 #include "qgsalgorithmsplitlineantimeridian.h"
 #include "qgsalgorithmsplitlinesbylength.h"
 #include "qgsalgorithmsplitwithlines.h"
@@ -281,6 +282,7 @@ void QgsNativeAlgorithms::loadAlgorithms()
   addAlgorithm( new QgsSlopeAlgorithm() );
   addAlgorithm( new QgsSmoothAlgorithm() );
   addAlgorithm( new QgsSnapToGridAlgorithm() );
+  addAlgorithm( new QgsSpatialIndexAlgorithm() );
   addAlgorithm( new QgsSplitFeaturesByAttributeCharacterAlgorithm() );
   addAlgorithm( new QgsSplitGeometryAtAntimeridianAlgorithm() );
   addAlgorithm( new QgsSplitLinesByLengthAlgorithm() );