QGIS API Documentation 3.99.0-Master (c22de0620c0)
Loading...
Searching...
No Matches
qgsalgorithmrasterlogicalop.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmrasterlogicalop.h
3 ---------------------
4 begin : March 2019
5 copyright : (C) 2019 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 QGSALGORITHMRASTERLOGICALOP_H
19#define QGSALGORITHMRASTERLOGICALOP_H
20
21
22#include "qgis_sip.h"
25#include "qgsrasterprojector.h"
26
27#define SIP_NO_FILE
28
30
34class ANALYSIS_EXPORT QgsRasterBooleanLogicAlgorithmBase : public QgsProcessingAlgorithm
35{
36 public:
37 QgsRasterBooleanLogicAlgorithmBase() = default;
38
39 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
40 QStringList tags() const override;
41 QString group() const override;
42 QString groupId() const override;
43
44 protected:
45 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
46 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
47
48 std::function<void( const std::vector<std::unique_ptr<QgsRasterBlock>> &, bool &, bool &, int, int, bool )> mExtractValFunc;
49
50 private:
51 std::vector<QgsRasterAnalysisUtils::RasterLogicInput> mInputs;
53 double mNoDataValue = -9999;
54 int mLayerWidth = 0;
55 int mLayerHeight = 0;
56 QgsRectangle mExtent;
58 double mRasterUnitsPerPixelX = 0;
59 double mRasterUnitsPerPixelY = 0;
60 bool mTreatNodataAsFalse = false;
61 friend class TestQgsProcessingAlgsPt1;
62};
63
67class ANALYSIS_EXPORT QgsRasterLogicalOrAlgorithm : public QgsRasterBooleanLogicAlgorithmBase
68{
69 public:
70 QgsRasterLogicalOrAlgorithm();
71
72 QString name() const override;
73 QString displayName() const override;
74 QString shortHelpString() const override;
75 QString shortDescription() const override;
76 QgsRasterLogicalOrAlgorithm *createInstance() const override SIP_FACTORY;
77};
78
82class ANALYSIS_EXPORT QgsRasterLogicalAndAlgorithm : public QgsRasterBooleanLogicAlgorithmBase
83{
84 public:
85 QgsRasterLogicalAndAlgorithm();
86
87 QString name() const override;
88 QString displayName() const override;
89 QString shortHelpString() const override;
90 QString shortDescription() const override;
91 QgsRasterLogicalAndAlgorithm *createInstance() const override SIP_FACTORY;
92};
93
95
96#endif // QGSALGORITHMRASTERLOGICALOP_H
DataType
Raster data types.
Definition qgis.h:390
@ Float32
Thirty two bit floating point (float).
Definition qgis.h:398
Represents a coordinate reference system (CRS).
Abstract base class for processing algorithms.
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
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 QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback)=0
Runs the algorithm using the specified parameters.
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
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