QGIS API Documentation  2.99.0-Master (e077efd)
qgscontrastenhancementfunction.cpp
Go to the documentation of this file.
1 /* **************************************************************************
2  qgscontrastenhancementfunction.cpp - 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 
20 #include "qgscontrastenhancement.h"
21 
22 QgsContrastEnhancementFunction::QgsContrastEnhancementFunction( Qgis::DataType theDataType, double theMinimumValue, double theMaximumValue )
23 {
24  mQgsRasterDataType = theDataType;
25  mMaximumValue = theMaximumValue;
26  mMinimumValue = theMinimumValue;
28 }
29 
31 {
36 }
37 
39 {
41  {
42  return static_cast<int>( theValue );
43  }
44  else
45  {
47  }
48 }
49 
51 {
52  //A default check is to see if the provided value is with the range for the data type
54  {
55  return false;
56  }
57 
58  return true;
59 }
60 
62 {
64  {
66  }
67  else
68  {
69  mMaximumValue = theValue;
70  }
71 
73 }
74 
76 {
77 
79  {
81  }
82  else
83  {
84  mMinimumValue = theValue;
85  }
86 
88 }
static double minimumValuePossible(Qgis::DataType)
Helper function that returns the minimum possible value for a GDAL data type.
DataType
Raster data types.
Definition: qgis.h:60
void setMinimumValue(double)
Mutator for the minimum value.
QgsContrastEnhancementFunction(Qgis::DataType, double, double)
double mMinimumMaximumRange
Minimum maximum range for the band, used for enhanceContrasting.
Qgis::DataType mQgsRasterDataType
Data type of the band.
A contrast enhancement funcion 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.
static double maximumValuePossible(Qgis::DataType)
Helper function that returns the maximum possible value for a GDAL data type.
virtual int enhance(double)
A customizable method that takes in a double and returns a int between 0 and 255. ...
virtual bool isValueInDisplayableRange(double)
A customicable method to indicate if the pixels is displayable.
Eight bit unsigned integer (quint8)
Definition: qgis.h:63
void setMaximumValue(double)
Mustator for the maximum value.