QGIS API Documentation  3.17.0-Master (ca637cfeb2)
qgsalgorithmdbscanclustering.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmdbscanclustering.h
3  ---------------------
4  begin : July 2018
5  copyright : (C) 2018 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSALGORITHMDBSCANCLUSTERING_H
19 #define QGSALGORITHMDBSCANCLUSTERING_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis_sip.h"
24 #include "qgis_analysis.h"
25 #include "qgsprocessingalgorithm.h"
26 #include <unordered_map>
27 
29 
31 
32 
36 class ANALYSIS_EXPORT QgsDbscanClusteringAlgorithm : public QgsProcessingAlgorithm
37 {
38 
39  public:
40 
41  QgsDbscanClusteringAlgorithm() = default;
42  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
43  QString name() const override;
44  QString displayName() const override;
45  QString shortDescription() const override;
46  QStringList tags() const override;
47  QString group() const override;
48  QString groupId() const override;
49  QString shortHelpString() const override;
50  QgsDbscanClusteringAlgorithm *createInstance() const override SIP_FACTORY;
51 
52  protected:
53 
54  QVariantMap processAlgorithm( const QVariantMap &parameters,
55  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
56  private:
57  static void dbscan( std::size_t minSize,
58  double eps,
59  bool borderPointsAreNoise,
60  long featureCount,
61  QgsFeatureIterator features,
62  QgsSpatialIndexKDBush &index,
63  std::unordered_map< QgsFeatureId, int> &idToCluster,
64  QgsProcessingFeedback *feedback );
65 };
66 
68 
69 #endif // QGSALGORITHMDBSCANCLUSTERING_H
70 
71 
Wrapper for iterator of features from vector data provider or vector layer.
A very fast static spatial index for 2D points based on a flat KD-tree.
Base class for providing feedback from a processing algorithm.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features ...
Definition: qgsfeatureid.h:28
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Abstract base class for processing algorithms.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
#define SIP_FACTORY
Definition: qgis_sip.h:76
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Contains information about the context in which a processing algorithm is executed.