QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
qgslinearminmaxenhancementwithclip.cpp
Go to the documentation of this file.
1/* **************************************************************************
2 qgslinearminmaxenhancementwithclip.cpp - description
3 -------------------
4begin : Fri Nov 16 2007
5copyright : (C) 2007 by Peter J. Ersts
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
21QgsLinearMinMaxEnhancementWithClip::QgsLinearMinMaxEnhancementWithClip( Qgis::DataType qgsRasterDataType, double minimumValue, double maximumValue ) : QgsContrastEnhancementFunction( qgsRasterDataType, minimumValue, maximumValue )
22{
23}
24
26{
27 if ( value < mMinimumValue || value > mMaximumValue )
28 {
29 return -1;
30 }
31
32 const int myStretchedValue = static_cast<int>( ( ( value - mMinimumValue ) / ( mMinimumMaximumRange ) ) * 255.0 );
33 if ( myStretchedValue < 0 )
34 {
35 return 0;
36 }
37 else if ( myStretchedValue > 255 )
38 {
39 return 255;
40 }
41
42 return myStretchedValue;
43}
44
46{
47 return !( value < mMinimumValue || value > mMaximumValue );
48}
DataType
Raster data types.
Definition: qgis.h:129
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 mMinimumMaximumRange
Minimum maximum range for the band, used for enhanceContrasting.
double mMinimumValue
User defineable minimum value for the band, used for enhanceContrasting.
int enhance(double) override
A customizable method that takes in a double value and returns a int between 0 and 255.
QgsLinearMinMaxEnhancementWithClip(Qgis::DataType, double, double)
bool isValueInDisplayableRange(double) override
A customizable method to indicate if a pixel's value is within the displayable range.