QGIS API Documentation  3.21.0-Master (56b4176581)
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 #define SIP_NO_FILE
22 
23 #include "qgis_sip.h"
24 #include "qgsprocessingalgorithm.h"
25 #include "qgsrasterprojector.h"
26 #include "qgsrasteranalysisutils.h"
27 
29 
33 class ANALYSIS_EXPORT QgsRasterBooleanLogicAlgorithmBase : public QgsProcessingAlgorithm
34 {
35 
36  public:
37 
38  QgsRasterBooleanLogicAlgorithmBase() = default;
39 
40  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
41  QStringList tags() const override;
42  QString group() const override;
43  QString groupId() const override;
44 
45  protected:
46 
47  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
48  QVariantMap processAlgorithm( const QVariantMap &parameters,
49  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
50 
51  std::function<void( const std::vector< std::unique_ptr< QgsRasterBlock > > &, bool &, bool &, int, int, bool )> mExtractValFunc;
52 
53  private:
54 
55  std::vector< QgsRasterAnalysisUtils::RasterLogicInput > mInputs;
57  double mNoDataValue = -9999;
58  int mLayerWidth;
59  int mLayerHeight;
60  QgsRectangle mExtent;
62  double mRasterUnitsPerPixelX;
63  double mRasterUnitsPerPixelY;
64  bool mTreatNodataAsFalse = false;
65  friend class TestQgsProcessingAlgs;
66 };
67 
71 class ANALYSIS_EXPORT QgsRasterLogicalOrAlgorithm : public QgsRasterBooleanLogicAlgorithmBase
72 {
73 
74  public:
75 
76  QgsRasterLogicalOrAlgorithm();
77 
78  QString name() const override;
79  QString displayName() const override;
80  QString shortHelpString() const override;
81  QString shortDescription() const override;
82  QgsRasterLogicalOrAlgorithm *createInstance() const override SIP_FACTORY;
83 
84 };
85 
89 class ANALYSIS_EXPORT QgsRasterLogicalAndAlgorithm : public QgsRasterBooleanLogicAlgorithmBase
90 {
91 
92  public:
93 
94  QgsRasterLogicalAndAlgorithm();
95 
96  QString name() const override;
97  QString displayName() const override;
98  QString shortHelpString() const override;
99  QString shortDescription() const override;
100  QgsRasterLogicalAndAlgorithm *createInstance() const override SIP_FACTORY;
101 
102 };
103 
105 
106 #endif // QGSALGORITHMRASTERLOGICALOP_H
107 
108 
DataType
Raster data types.
Definition: qgis.h:120
@ Float32
Thirty two bit floating point (float)
This class 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 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 QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
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.
Definition: qgsrectangle.h:42
#define SIP_FACTORY
Definition: qgis_sip.h:76