QGIS API Documentation
3.0.2-Girona (307d082)
|
A contrast enhancement function is the base class for all raster contrast enhancements. More...
#include <qgscontrastenhancementfunction.h>
Public Member Functions | |
QgsContrastEnhancementFunction (Qgis::DataType, double, double) | |
QgsContrastEnhancementFunction (const QgsContrastEnhancementFunction &f) | |
virtual | ~QgsContrastEnhancementFunction ()=default |
virtual int | enhance (double) |
A customizable method that takes in a double and returns a int between 0 and 255. More... | |
virtual bool | isValueInDisplayableRange (double) |
A customicable method to indicate if the pixels is displayable. More... | |
void | setMaximumValue (double) |
Mustator for the maximum value. More... | |
void | setMinimumValue (double) |
Mutator for the minimum value. More... | |
Protected Attributes | |
double | mMaximumValue |
User defineable maximum value for the band, used for enhanceContrasting. More... | |
double | mMinimumMaximumRange |
Minimum maximum range for the band, used for enhanceContrasting. More... | |
double | mMinimumValue |
User defineable minimum value for the band, used for enhanceContrasting. More... | |
Qgis::DataType | mQgsRasterDataType |
Data type of the band. More... | |
A contrast enhancement function is the base class for all raster contrast enhancements.
The purpose of a contrast enhancement is to enhanceContrast or clip a pixel value into a specified bounding range.
Definition at line 32 of file qgscontrastenhancementfunction.h.
QgsContrastEnhancementFunction::QgsContrastEnhancementFunction | ( | Qgis::DataType | dataType, |
double | minimumValue, | ||
double | maximumValue | ||
) |
Definition at line 22 of file qgscontrastenhancementfunction.cpp.
QgsContrastEnhancementFunction::QgsContrastEnhancementFunction | ( | const QgsContrastEnhancementFunction & | f | ) |
Definition at line 30 of file qgscontrastenhancementfunction.cpp.
|
virtualdefault |
|
virtual |
A customizable method that takes in a double and returns a int between 0 and 255.
Reimplemented in QgsClipToMinMaxEnhancement, QgsLinearMinMaxEnhancementWithClip, and QgsLinearMinMaxEnhancement.
Definition at line 38 of file qgscontrastenhancementfunction.cpp.
|
virtual |
A customicable method to indicate if the pixels is displayable.
Reimplemented in QgsClipToMinMaxEnhancement, and QgsLinearMinMaxEnhancementWithClip.
Definition at line 50 of file qgscontrastenhancementfunction.cpp.
void QgsContrastEnhancementFunction::setMaximumValue | ( | double | value | ) |
Mustator for the maximum value.
Definition at line 57 of file qgscontrastenhancementfunction.cpp.
void QgsContrastEnhancementFunction::setMinimumValue | ( | double | value | ) |
Mutator for the minimum value.
Definition at line 71 of file qgscontrastenhancementfunction.cpp.
|
protected |
User defineable maximum value for the band, used for enhanceContrasting.
Definition at line 54 of file qgscontrastenhancementfunction.h.
|
protected |
Minimum maximum range for the band, used for enhanceContrasting.
Definition at line 60 of file qgscontrastenhancementfunction.h.
|
protected |
User defineable minimum value for the band, used for enhanceContrasting.
Definition at line 57 of file qgscontrastenhancementfunction.h.
|
protected |
Data type of the band.
Definition at line 63 of file qgscontrastenhancementfunction.h.