QGIS API Documentation  3.14.0-Pi (9f7028fd23)
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  int &clusterCount,
65  QgsProcessingFeedback *feedback );
66 };
67 
69 
70 #endif // QGSALGORITHMDBSCANCLUSTERING_H
71 
72 
QgsProcessingAlgorithm::shortDescription
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
Definition: qgsprocessingalgorithm.cpp:58
QgsProcessingAlgorithm::displayName
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
QgsProcessingFeedback
Definition: qgsprocessingfeedback.h:37
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:231
QgsProcessingAlgorithm::createInstance
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
QgsProcessingAlgorithm::name
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
QgsProcessingContext
Definition: qgsprocessingcontext.h:43
qgsprocessingalgorithm.h
qgis_sip.h
QgsProcessingAlgorithm::shortHelpString
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Definition: qgsprocessingalgorithm.cpp:63
QgsProcessingAlgorithm
Definition: qgsprocessingalgorithm.h:51
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:222
QgsFeatureIterator
Definition: qgsfeatureiterator.h:263
QgsSpatialIndexKDBush
Definition: qgsspatialindexkdbush.h:53
QgsProcessingAlgorithm::tags
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
Definition: qgsprocessingalgorithm.h:178
QgsProcessingAlgorithm::initAlgorithm
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
QgsFeatureId
qint64 QgsFeatureId
Definition: qgsfeatureid.h:25