QGIS API Documentation 3.43.0-Master (261ee7da134)
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#define SIP_NO_FILE
22
23#include "qgis_sip.h"
24#include "qgsprocessingalgorithm.h"
25#include "qgsapplication.h"
26
28
32class QgsFuzzifyRasterAlgorithmBase : 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:
44 virtual void addAlgorithmParams() = 0;
45
46 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) final;
47
51 virtual bool prepareAlgorithmFuzzificationParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) = 0;
52
56 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) final;
57
61 virtual void fuzzify( QgsRasterDataProvider *destinationProvider, QgsProcessingFeedback *feedback ) = 0;
62
63 QgsRasterLayer *mInputRaster = nullptr;
64 int mBand = 1;
65 std::unique_ptr<QgsRasterInterface> mInterface;
66 QgsRectangle mExtent;
67 QgsCoordinateReferenceSystem mCrs;
68 int mLayerWidth = 0;
69 int mLayerHeight = 0;
70 int mNbCellsXProvider = 0;
71 int mNbCellsYProvider = 0;
72
73 Qgis::DataType mDataType = Qgis::DataType::Float32;
74 const double mNoDataValue = -9999;
75};
76
77
78class QgsFuzzifyRasterLinearMembershipAlgorithm : public QgsFuzzifyRasterAlgorithmBase
79{
80 public:
81 QgsFuzzifyRasterLinearMembershipAlgorithm() = default;
82 QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmFuzzifyLinear.svg" ) ); }
83 QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmFuzzifyLinear.svg" ) ); }
84 QString name() const override;
85 QString displayName() const override;
86 QStringList tags() const override;
87 QString shortDescription() const override;
88 QString shortHelpString() const override;
89 QgsFuzzifyRasterLinearMembershipAlgorithm *createInstance() const override SIP_FACTORY;
90
91 protected:
92 void addAlgorithmParams() override;
93 bool prepareAlgorithmFuzzificationParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
94 void fuzzify( QgsRasterDataProvider *destinationProvider, QgsProcessingFeedback *feedback ) override;
95
96 private:
97 double mFuzzifyLowBound = 0;
98 double mFuzzifyHighBound = 0;
99};
100
101
102class QgsFuzzifyRasterPowerMembershipAlgorithm : public QgsFuzzifyRasterAlgorithmBase
103{
104 public:
105 QgsFuzzifyRasterPowerMembershipAlgorithm() = default;
106 QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmFuzzifyPower.svg" ) ); }
107 QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmFuzzifyPower.svg" ) ); }
108 QString name() const override;
109 QString displayName() const override;
110 QStringList tags() const override;
111 QString shortDescription() const override;
112 QString shortHelpString() const override;
113 QgsFuzzifyRasterPowerMembershipAlgorithm *createInstance() const override SIP_FACTORY;
114
115 protected:
116 void addAlgorithmParams() override;
117 bool prepareAlgorithmFuzzificationParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
118 void fuzzify( QgsRasterDataProvider *destinationProvider, QgsProcessingFeedback *feedback ) override;
119
120 private:
121 double mFuzzifyLowBound = 0;
122 double mFuzzifyHighBound = 0;
123 double mFuzzifyExponent = 0;
124};
125
126
127class QgsFuzzifyRasterLargeMembershipAlgorithm : public QgsFuzzifyRasterAlgorithmBase
128{
129 public:
130 QgsFuzzifyRasterLargeMembershipAlgorithm() = default;
131 QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmFuzzifyLarge.svg" ) ); }
132 QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmFuzzifyLarge.svg" ) ); }
133 QString name() const override;
134 QString displayName() const override;
135 QStringList tags() const override;
136 QString shortHelpString() const override;
137 QString shortDescription() const override;
138 QgsFuzzifyRasterLargeMembershipAlgorithm *createInstance() const override SIP_FACTORY;
139
140 protected:
141 void addAlgorithmParams() override;
142 bool prepareAlgorithmFuzzificationParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
143 void fuzzify( QgsRasterDataProvider *destinationProvider, QgsProcessingFeedback *feedback ) override;
144
145 private:
146 double mFuzzifyMidpoint = 0;
147 double mFuzzifySpread = 0;
148};
149
150
151class QgsFuzzifyRasterSmallMembershipAlgorithm : public QgsFuzzifyRasterAlgorithmBase
152{
153 public:
154 QgsFuzzifyRasterSmallMembershipAlgorithm() = default;
155 QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmFuzzifySmall.svg" ) ); }
156 QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmFuzzifySmall.svg" ) ); }
157 QString name() const override;
158 QString displayName() const override;
159 QStringList tags() const override;
160 QString shortHelpString() const override;
161 QString shortDescription() const override;
162 QgsFuzzifyRasterSmallMembershipAlgorithm *createInstance() const override SIP_FACTORY;
163
164 protected:
165 void addAlgorithmParams() override;
166 bool prepareAlgorithmFuzzificationParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
167 void fuzzify( QgsRasterDataProvider *destinationProvider, QgsProcessingFeedback *feedback ) override;
168
169 private:
170 double mFuzzifyMidpoint = 0;
171 double mFuzzifySpread = 0;
172};
173
174
175class QgsFuzzifyRasterGaussianMembershipAlgorithm : public QgsFuzzifyRasterAlgorithmBase
176{
177 public:
178 QgsFuzzifyRasterGaussianMembershipAlgorithm() = default;
179 QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmFuzzifyGaussian.svg" ) ); }
180 QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmFuzzifyGaussian.svg" ) ); }
181 QString name() const override;
182 QString displayName() const override;
183 QStringList tags() const override;
184 QString shortHelpString() const override;
185 QString shortDescription() const override;
186 QgsFuzzifyRasterGaussianMembershipAlgorithm *createInstance() const override SIP_FACTORY;
187
188 protected:
189 void addAlgorithmParams() override;
190 bool prepareAlgorithmFuzzificationParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
191 void fuzzify( QgsRasterDataProvider *destinationProvider, QgsProcessingFeedback *feedback ) override;
192
193 private:
194 double mFuzzifyMidpoint = 0;
195 double mFuzzifySpread = 0;
196};
197
198
199class QgsFuzzifyRasterNearMembershipAlgorithm : public QgsFuzzifyRasterAlgorithmBase
200{
201 public:
202 QgsFuzzifyRasterNearMembershipAlgorithm() = default;
203 QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmFuzzifyNear.svg" ) ); }
204 QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmFuzzifyNear.svg" ) ); }
205 QString name() const override;
206 QString displayName() const override;
207 QStringList tags() const override;
208 QString shortHelpString() const override;
209 QString shortDescription() const override;
210 QgsFuzzifyRasterNearMembershipAlgorithm *createInstance() const override SIP_FACTORY;
211
212 protected:
213 void addAlgorithmParams() override;
214 bool prepareAlgorithmFuzzificationParameters( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
215 void fuzzify( QgsRasterDataProvider *destinationProvider, QgsProcessingFeedback *feedback ) override;
216
217 private:
218 double mFuzzifyMidpoint = 0;
219 double mFuzzifySpread = 0;
220};
221
222
224
225#endif // QGSALGORITHMFUZZIFYRASTER_H
Qgis::DataType
DataType
Raster data types.
Definition qgis.h:351
Qgis::DataType::Float32
@ Float32
Thirty two bit floating point (float)
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:797
QgsApplication::iconPath
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
Definition qgsapplication.cpp:786
QgsCoordinateReferenceSystem
Represents a coordinate reference system (CRS).
Definition qgscoordinatereferencesystem.h:212
QgsProcessingAlgorithm
Abstract base class for processing algorithms.
Definition qgsprocessingalgorithm.h:51
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition qgsprocessingalgorithm.h:211
QgsProcessingAlgorithm::prepareAlgorithm
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback)
Prepares the algorithm to run using the specified parameters.
Definition qgsprocessingalgorithm.cpp:472
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition qgsprocessingalgorithm.h:220
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:89
QgsRasterLayer
Represents a raster layer.
Definition qgsrasterlayer.h:79
QgsRectangle
A rectangle specified with double values.
Definition qgsrectangle.h:44
qgis_sip.h
SIP_FACTORY
#define SIP_FACTORY
Definition qgis_sip.h:76
Generated on Mon Jun 2 2025 00:14:09 for QGIS API Documentation by doxygen 1.9.8