QGIS API Documentation 3.99.0-Master (26c88405ac0)
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#define SIP_NO_FILE
22
23#include "qgis_sip.h"
25#include "qgsreclassifyutils.h"
26
28
32class QgsReclassifyAlgorithmBase : public QgsProcessingAlgorithm
33{
34 public:
35 QString group() const final;
36 QString groupId() const final;
37 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) final;
38
39 protected:
40
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,
59 const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback
60 ) = 0;
61
62 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) final;
63
64 std::unique_ptr<QgsRasterInterface> mInterface;
65
67 double mNoDataValue = -9999;
68 int mBand = 1;
69 QgsRectangle mExtent;
71 double mRasterUnitsPerPixelX = 0;
72 double mRasterUnitsPerPixelY = 0;
73 int mNbCellsXProvider = 0;
74 int mNbCellsYProvider = 0;
75 QgsReclassifyUtils::RasterClass::BoundsType mBoundsType = QgsReclassifyUtils::RasterClass::IncludeMax;
76 bool mUseNoDataForMissingValues = false;
77};
78
82class QgsReclassifyByLayerAlgorithm : public QgsReclassifyAlgorithmBase
83{
84 public:
85 QgsReclassifyByLayerAlgorithm() = default;
86 QString name() const override;
87 QString displayName() const override;
88 QStringList tags() const override;
89 QString shortHelpString() const override;
90 QString shortDescription() const override;
91 QgsReclassifyByLayerAlgorithm *createInstance() const override SIP_FACTORY;
92
93 protected:
94 void addAlgorithmParams() override;
95 bool _prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
96 QVector<QgsReclassifyUtils::RasterClass> createClasses(
97 QgsReclassifyUtils::RasterClass::BoundsType boundsType,
98 const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback
99 ) override;
100
101 private:
102 int mMinFieldIdx = -1;
103 int mMaxFieldIdx = -1;
104 int mValueFieldIdx = -1;
105 QgsFeatureIterator mTableIterator;
106};
107
111class QgsReclassifyByTableAlgorithm : public QgsReclassifyAlgorithmBase
112{
113 public:
114 QgsReclassifyByTableAlgorithm() = default;
115 QString name() const override;
116 QString displayName() const override;
117 QStringList tags() const override;
118 QString shortHelpString() const override;
119 QString shortDescription() const override;
120 QgsReclassifyByTableAlgorithm *createInstance() const override SIP_FACTORY;
121
122 protected:
123 void addAlgorithmParams() override;
124 bool _prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
125 QVector<QgsReclassifyUtils::RasterClass> createClasses( QgsReclassifyUtils::RasterClass::BoundsType boundsType, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
126};
127
129
130#endif // QGSALGORITHMRECLASSIFYBYLAYER_H
DataType
Raster data types.
Definition qgis.h:372
@ Float32
Thirty two bit floating point (float).
Definition qgis.h:380
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:84