QGIS API Documentation 4.1.0-Master (5bf3c20f3c9)
Loading...
Searching...
No Matches
qgsalgorithmreclassifybylayer.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmreclassifybylayer.h
3 ---------------------
4 begin : June, 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 QGSALGORITHMRECLASSIFYBYLAYER_H
19#define QGSALGORITHMRECLASSIFYBYLAYER_H
20
21
22#include "qgis_sip.h"
24#include "qgsreclassifyutils.h"
25
26#define SIP_NO_FILE
27
29
33class QgsReclassifyAlgorithmBase : public QgsProcessingAlgorithm
34{
35 public:
36 QString group() const final;
37 QString groupId() const final;
38 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) final;
39
40 protected:
45 virtual void addAlgorithmParams() = 0;
46
47 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) final;
48
52 virtual bool _prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) = 0;
53
57 virtual QVector<QgsReclassifyUtils::RasterClass> createClasses(
58 QgsReclassifyUtils::RasterClass::BoundsType boundsType, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback
59 ) = 0;
60
61 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) final;
62
63 std::unique_ptr<QgsRasterInterface> mInterface;
64
66 double mNoDataValue = -9999;
67 int mBand = 1;
68 QgsRectangle mExtent;
70 double mRasterUnitsPerPixelX = 0;
71 double mRasterUnitsPerPixelY = 0;
72 int mNbCellsXProvider = 0;
73 int mNbCellsYProvider = 0;
74 QgsReclassifyUtils::RasterClass::BoundsType mBoundsType = QgsReclassifyUtils::RasterClass::IncludeMax;
75 bool mUseNoDataForMissingValues = false;
76};
77
81class QgsReclassifyByLayerAlgorithm : public QgsReclassifyAlgorithmBase
82{
83 public:
84 QgsReclassifyByLayerAlgorithm() = default;
85 QString name() const override;
86 QString displayName() const override;
87 QStringList tags() const override;
88 QString shortHelpString() const override;
89 QString shortDescription() const override;
90 QgsReclassifyByLayerAlgorithm *createInstance() const override SIP_FACTORY;
91
92 protected:
93 void addAlgorithmParams() override;
94 bool _prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
95 QVector<QgsReclassifyUtils::RasterClass> createClasses(
96 QgsReclassifyUtils::RasterClass::BoundsType boundsType, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback
97 ) override;
98
99 private:
100 int mMinFieldIdx = -1;
101 int mMaxFieldIdx = -1;
102 int mValueFieldIdx = -1;
103 QgsFeatureIterator mTableIterator;
104};
105
109class QgsReclassifyByTableAlgorithm : public QgsReclassifyAlgorithmBase
110{
111 public:
112 QgsReclassifyByTableAlgorithm() = default;
113 QString name() const override;
114 QString displayName() const override;
115 QStringList tags() const override;
116 QString shortHelpString() const override;
117 QString shortDescription() const override;
118 QgsReclassifyByTableAlgorithm *createInstance() const override SIP_FACTORY;
119
120 protected:
121 void addAlgorithmParams() override;
122 bool _prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
123 QVector<QgsReclassifyUtils::RasterClass> createClasses(
124 QgsReclassifyUtils::RasterClass::BoundsType boundsType, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback
125 ) override;
126};
127
129
130#endif // QGSALGORITHMRECLASSIFYBYLAYER_H
DataType
Raster data types.
Definition qgis.h:393
@ Float32
Thirty two bit floating point (float).
Definition qgis.h:401
Represents a coordinate reference system (CRS).
Abstract base class for processing algorithms.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback)
Prepares the algorithm to run using the specified parameters.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback)=0
Runs the algorithm using the specified parameters.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
Contains information about the context in which a processing algorithm is executed.
Base class for providing feedback from a processing algorithm.
A rectangle specified with double values.
#define SIP_FACTORY
Definition qgis_sip.h:83