QGIS API Documentation 3.99.0-Master (18a1e75d814)
Loading...
Searching...
No Matches
qgsalgorithmfuzzifyraster.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmrasterlayeruniquevalues.h
3 ---------------------
4 begin : October 2019
5 copyright : (C) 2019 by Clemens Raffler
6 email : clemens dot raffler 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 QGSFUZZIFYRASTERALGORITHM_H
19#define QGSFUZZIFYRASTERALGORITHM_H
20
21
22#include "qgis_sip.h"
23#include "qgsapplication.h"
24#include "qgsprocessingalgorithm.h"
25
26#include <QString>
27
28#define SIP_NO_FILE
29
30using namespace Qt::StringLiterals;
31
33
37class QgsFuzzifyRasterAlgorithmBase : public QgsProcessingAlgorithm
38{
39 public:
40 QString group() const final;
41 QString groupId() const final;
42 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) final;
43
44 protected:
49 virtual void addAlgorithmParams() = 0;
50
51 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) final;
52
56 virtual bool prepareAlgorithmFuzzificationParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) = 0;
57
61 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) final;
62
66 virtual void fuzzify( QgsRasterDataProvider *destinationProvider, QgsProcessingFeedback *feedback ) = 0;
67
68 QgsRasterLayer *mInputRaster = nullptr;
69 int mBand = 1;
70 std::unique_ptr<QgsRasterInterface> mInterface;
71 QgsRectangle mExtent;
72 QgsCoordinateReferenceSystem mCrs;
73 int mLayerWidth = 0;
74 int mLayerHeight = 0;
75 int mNbCellsXProvider = 0;
76 int mNbCellsYProvider = 0;
77
78 Qgis::DataType mDataType = Qgis::DataType::Float32;
79 const double mNoDataValue = -9999;
80 double mMaxProgressDuringBlockWriting = 100;
81};
82
83
84class QgsFuzzifyRasterLinearMembershipAlgorithm : public QgsFuzzifyRasterAlgorithmBase
85{
86 public:
87 QgsFuzzifyRasterLinearMembershipAlgorithm() = default;
88 QIcon icon() const override { return QgsApplication::getThemeIcon( u"/algorithms/mAlgorithmFuzzifyLinear.svg"_s ); }
89 QString svgIconPath() const override { return QgsApplication::iconPath( u"/algorithms/mAlgorithmFuzzifyLinear.svg"_s ); }
90 QString name() const override;
91 QString displayName() const override;
92 QStringList tags() const override;
93 QString shortDescription() const override;
94 QString shortHelpString() const override;
95 QgsFuzzifyRasterLinearMembershipAlgorithm *createInstance() const override SIP_FACTORY;
96
97 protected:
98 void addAlgorithmParams() override;
99 bool prepareAlgorithmFuzzificationParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
100 void fuzzify( QgsRasterDataProvider *destinationProvider, QgsProcessingFeedback *feedback ) override;
101
102 private:
103 double mFuzzifyLowBound = 0;
104 double mFuzzifyHighBound = 0;
105};
106
107
108class QgsFuzzifyRasterPowerMembershipAlgorithm : public QgsFuzzifyRasterAlgorithmBase
109{
110 public:
111 QgsFuzzifyRasterPowerMembershipAlgorithm() = default;
112 QIcon icon() const override { return QgsApplication::getThemeIcon( u"/algorithms/mAlgorithmFuzzifyPower.svg"_s ); }
113 QString svgIconPath() const override { return QgsApplication::iconPath( u"/algorithms/mAlgorithmFuzzifyPower.svg"_s ); }
114 QString name() const override;
115 QString displayName() const override;
116 QStringList tags() const override;
117 QString shortDescription() const override;
118 QString shortHelpString() const override;
119 QgsFuzzifyRasterPowerMembershipAlgorithm *createInstance() const override SIP_FACTORY;
120
121 protected:
122 void addAlgorithmParams() override;
123 bool prepareAlgorithmFuzzificationParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
124 void fuzzify( QgsRasterDataProvider *destinationProvider, QgsProcessingFeedback *feedback ) override;
125
126 private:
127 double mFuzzifyLowBound = 0;
128 double mFuzzifyHighBound = 0;
129 double mFuzzifyExponent = 0;
130};
131
132
133class QgsFuzzifyRasterLargeMembershipAlgorithm : public QgsFuzzifyRasterAlgorithmBase
134{
135 public:
136 QgsFuzzifyRasterLargeMembershipAlgorithm() = default;
137 QIcon icon() const override { return QgsApplication::getThemeIcon( u"/algorithms/mAlgorithmFuzzifyLarge.svg"_s ); }
138 QString svgIconPath() const override { return QgsApplication::iconPath( u"/algorithms/mAlgorithmFuzzifyLarge.svg"_s ); }
139 QString name() const override;
140 QString displayName() const override;
141 QStringList tags() const override;
142 QString shortHelpString() const override;
143 QString shortDescription() const override;
144 QgsFuzzifyRasterLargeMembershipAlgorithm *createInstance() const override SIP_FACTORY;
145
146 protected:
147 void addAlgorithmParams() override;
148 bool prepareAlgorithmFuzzificationParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
149 void fuzzify( QgsRasterDataProvider *destinationProvider, QgsProcessingFeedback *feedback ) override;
150
151 private:
152 double mFuzzifyMidpoint = 0;
153 double mFuzzifySpread = 0;
154};
155
156
157class QgsFuzzifyRasterSmallMembershipAlgorithm : public QgsFuzzifyRasterAlgorithmBase
158{
159 public:
160 QgsFuzzifyRasterSmallMembershipAlgorithm() = default;
161 QIcon icon() const override { return QgsApplication::getThemeIcon( u"/algorithms/mAlgorithmFuzzifySmall.svg"_s ); }
162 QString svgIconPath() const override { return QgsApplication::iconPath( u"/algorithms/mAlgorithmFuzzifySmall.svg"_s ); }
163 QString name() const override;
164 QString displayName() const override;
165 QStringList tags() const override;
166 QString shortHelpString() const override;
167 QString shortDescription() const override;
168 QgsFuzzifyRasterSmallMembershipAlgorithm *createInstance() const override SIP_FACTORY;
169
170 protected:
171 void addAlgorithmParams() override;
172 bool prepareAlgorithmFuzzificationParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
173 void fuzzify( QgsRasterDataProvider *destinationProvider, QgsProcessingFeedback *feedback ) override;
174
175 private:
176 double mFuzzifyMidpoint = 0;
177 double mFuzzifySpread = 0;
178};
179
180
181class QgsFuzzifyRasterGaussianMembershipAlgorithm : public QgsFuzzifyRasterAlgorithmBase
182{
183 public:
184 QgsFuzzifyRasterGaussianMembershipAlgorithm() = default;
185 QIcon icon() const override { return QgsApplication::getThemeIcon( u"/algorithms/mAlgorithmFuzzifyGaussian.svg"_s ); }
186 QString svgIconPath() const override { return QgsApplication::iconPath( u"/algorithms/mAlgorithmFuzzifyGaussian.svg"_s ); }
187 QString name() const override;
188 QString displayName() const override;
189 QStringList tags() const override;
190 QString shortHelpString() const override;
191 QString shortDescription() const override;
192 QgsFuzzifyRasterGaussianMembershipAlgorithm *createInstance() const override SIP_FACTORY;
193
194 protected:
195 void addAlgorithmParams() override;
196 bool prepareAlgorithmFuzzificationParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
197 void fuzzify( QgsRasterDataProvider *destinationProvider, QgsProcessingFeedback *feedback ) override;
198
199 private:
200 double mFuzzifyMidpoint = 0;
201 double mFuzzifySpread = 0;
202};
203
204
205class QgsFuzzifyRasterNearMembershipAlgorithm : public QgsFuzzifyRasterAlgorithmBase
206{
207 public:
208 QgsFuzzifyRasterNearMembershipAlgorithm() = default;
209 QIcon icon() const override { return QgsApplication::getThemeIcon( u"/algorithms/mAlgorithmFuzzifyNear.svg"_s ); }
210 QString svgIconPath() const override { return QgsApplication::iconPath( u"/algorithms/mAlgorithmFuzzifyNear.svg"_s ); }
211 QString name() const override;
212 QString displayName() const override;
213 QStringList tags() const override;
214 QString shortHelpString() const override;
215 QString shortDescription() const override;
216 QgsFuzzifyRasterNearMembershipAlgorithm *createInstance() const override SIP_FACTORY;
217
218 protected:
219 void addAlgorithmParams() override;
220 bool prepareAlgorithmFuzzificationParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
221 void fuzzify( QgsRasterDataProvider *destinationProvider, QgsProcessingFeedback *feedback ) override;
222
223 private:
224 double mFuzzifyMidpoint = 0;
225 double mFuzzifySpread = 0;
226};
227
228
230
231#endif // QGSALGORITHMFUZZIFYRASTER_H
Qgis::DataType
DataType
Raster data types.
Definition qgis.h:390
Qgis::DataType::Float32
@ Float32
Thirty two bit floating point (float).
Definition qgis.h:398
QgsApplication::getThemeIcon
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
Definition qgsapplication.cpp:879
QgsApplication::iconPath
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
Definition qgsapplication.cpp:868
QgsCoordinateReferenceSystem
Represents a coordinate reference system (CRS).
Definition qgscoordinatereferencesystem.h:216
QgsProcessingAlgorithm
Abstract base class for processing algorithms.
Definition qgsprocessingalgorithm.h:52
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition qgsprocessingalgorithm.h:212
QgsProcessingAlgorithm::prepareAlgorithm
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback)
Prepares the algorithm to run using the specified parameters.
Definition qgsprocessingalgorithm.cpp:480
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition qgsprocessingalgorithm.h:221
QgsProcessingAlgorithm::processAlgorithm
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback)=0
Runs the algorithm using the specified parameters.
QgsProcessingAlgorithm::initAlgorithm
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition qgsprocessingcontext.h:45
QgsProcessingFeedback
Base class for providing feedback from a processing algorithm.
Definition qgsprocessingfeedback.h:38
QgsRasterDataProvider
Base class for raster data providers.
Definition qgsrasterdataprovider.h:92
QgsRasterLayer
Represents a raster layer.
Definition qgsrasterlayer.h:81
QgsRectangle
A rectangle specified with double values.
Definition qgsrectangle.h:47
qgis_sip.h
SIP_FACTORY
#define SIP_FACTORY
Definition qgis_sip.h:83
Generated on for QGIS API Documentation by doxygen 1.15.0