QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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 : ersts@amnh.org
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 
21 QgsContrastEnhancementFunction::QgsContrastEnhancementFunction( QGis::DataType theDataType, double theMinimumValue, double theMaximumValue )
22 {
23  mQgsRasterDataType = theDataType;
24  mMaximumValue = theMaximumValue;
25  mMinimumValue = theMinimumValue;
27 }
28 
30 {
35 }
36 
38 {
40  {
41  return static_cast<int>( theValue );
42  }
43  else
44  {
46  }
47 }
48 
50 {
51  //A default check is to see if the provided value is with the range for the data type
53  {
54  return false;
55  }
56 
57  return true;
58 }
59 
61 {
63  {
65  }
66  else
67  {
68  mMaximumValue = theValue;
69  }
70 
72 }
73 
75 {
76 
78  {
80  }
81  else
82  {
83  mMinimumValue = theValue;
84  }
85 
87 }
static double maximumValuePossible(QGis::DataType)
Helper function that returns the maximum possible value for a GDAL data type.
void setMinimumValue(double)
Mutator for the minimum value.
static double minimumValuePossible(QGis::DataType)
Helper function that returns the minimum possible value for a GDAL data type.
QgsContrastEnhancementFunction(QGis::DataType, double, double)
double mMinimumMaximumRange
Minimum maximum range for the band, used for enhanceContrasting.
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.
DataType
Raster data types.
Definition: qgis.h:204
double mMinimumValue
User defineable minimum value for the band, used for enhanceContrasting.
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.
QGis::DataType mQgsRasterDataType
Data type of the band.
void setMaximumValue(double)
Mustator for the maximum value.