QGIS API Documentation  3.26.3-Buenos Aires (65e4edfdad)
qgscontrastenhancementfunction.h
Go to the documentation of this file.
1 /* **************************************************************************
2  qgscontrastenhancementfunction.h - description
3  -------------------
4 begin : Fri Nov 16 2007
5 copyright : (C) 2007 by Peter J. Ersts
6 email : [email protected]
7 
8 ****************************************************************************/
9 
10 /* **************************************************************************
11  * *
12  * This program is free software; you can redistribute it and/or modify *
13  * it under the terms of the GNU General Public License as published by *
14  * the Free Software Foundation; either version 2 of the License, or *
15  * (at your option) any later version. *
16  * *
17  ***************************************************************************/
18 
19 #ifndef QGSCONTRASTENHANCEMENTFUNCTION_H
20 #define QGSCONTRASTENHANCEMENTFUNCTION_H
21 
22 #include "qgis_core.h"
23 #include "qgis.h"
24 
33 {
34 
35  public:
39  virtual ~QgsContrastEnhancementFunction() = default;
40 
44  virtual int enhance( double value );
45 
49  virtual bool isValueInDisplayableRange( double value );
50 
56  void setMaximumValue( double value );
57 
63  void setMinimumValue( double value );
64 
71  double maximumValue() const { return mMaximumValue; }
72 
79  double minimumValue() const { return mMinimumValue; }
80 
81  protected:
83  double mMaximumValue;
84 
86  double mMinimumValue;
87 
90 
93 
94  double mMaximumValuePossible = std::numeric_limits< double >::max() SIP_SKIP;
95  double mMinimumValuePossible = std::numeric_limits< double >::lowest() SIP_SKIP;
96 
97  private:
98 #ifdef SIP_RUN
100 #endif
101 };
102 
103 #endif
Qgis::DataType
DataType
Raster data types.
Definition: qgis.h:128
qgis.h
QgsContrastEnhancementFunction::minimumValue
double minimumValue() const
Returns the minimum value.
Definition: qgscontrastenhancementfunction.h:79
SIP_SKIP
#define SIP_SKIP
Definition: qgis_sip.h:126
QgsContrastEnhancementFunction
A contrast enhancement function is the base class for all raster contrast enhancements.
Definition: qgscontrastenhancementfunction.h:32
QgsContrastEnhancementFunction::mQgsRasterDataType
Qgis::DataType mQgsRasterDataType
Data type of the band.
Definition: qgscontrastenhancementfunction.h:92
QgsContrastEnhancementFunction::mMaximumValue
double mMaximumValue
User defineable maximum value for the band, used for enhanceContrasting.
Definition: qgscontrastenhancementfunction.h:83
QgsContrastEnhancementFunction::mMinimumValue
double mMinimumValue
User defineable minimum value for the band, used for enhanceContrasting.
Definition: qgscontrastenhancementfunction.h:86
QgsContrastEnhancementFunction::maximumValue
double maximumValue() const
Returns the maximum value.
Definition: qgscontrastenhancementfunction.h:71
QgsContrastEnhancementFunction::mMinimumMaximumRange
double mMinimumMaximumRange
Minimum maximum range for the band, used for enhanceContrasting.
Definition: qgscontrastenhancementfunction.h:89