QGIS API Documentation  3.13.0-Master (b73bd58cfb)
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:
38  virtual ~QgsContrastEnhancementFunction() = default;
39 
43  virtual int enhance( double value );
44 
48  virtual bool isValueInDisplayableRange( double value );
49 
55  void setMaximumValue( double value );
56 
62  void setMinimumValue( double value );
63 
70  double maximumValue() const { return mMaximumValue; }
71 
78  double minimumValue() const { return mMinimumValue; }
79 
80  protected:
82  double mMaximumValue;
83 
85  double mMinimumValue;
86 
89 
92 
93  double mMaximumValuePossible = std::numeric_limits< double >::max() SIP_SKIP;
94  double mMinimumValuePossible = std::numeric_limits< double >::lowest() SIP_SKIP;
95 
96 };
97 
98 #endif
DataType
Raster data types.
Definition: qgis.h:101
double maximumValue() const
Returns the maximum value.
#define SIP_SKIP
Definition: qgis_sip.h:126
double mMinimumMaximumRange
Minimum maximum range for the band, used for enhanceContrasting.
Qgis::DataType mQgsRasterDataType
Data type of the band.
A contrast enhancement function is the base class for all raster contrast enhancements.
double mMaximumValue
User defineable maximum value for the band, used for enhanceContrasting.
double mMinimumValue
User defineable minimum value for the band, used for enhanceContrasting.
double minimumValue() const
Returns the minimum value.