QgsContrastEnhancementFunction class

A contrast enhancement function is the base class for all raster contrast enhancements.

Contents

The purpose of a contrast enhancement is to enhanceContrast or clip a pixel value into a specified bounding range.

Derived classes

class QgsClipToMinMaxEnhancement
A raster contrast enhancement that will clip a value to the specified min/max range.
class QgsLinearMinMaxEnhancement
A color enhancement function that performs a linear enhanceContrast between min and max.
class QgsLinearMinMaxEnhancementWithClip
A linear enhanceContrast enhancement that first clips to min max and then enhanceContrastes linearly between min and max.

Public functions

auto enhance(double value) -> int virtual
A customizable method that takes in a double value and returns a int between 0 and 255.
auto isValueInDisplayableRange(double value) -> bool virtual
A customizable method to indicate if a pixel's value is within the displayable range.
auto maximumValue() const -> double
Returns the maximum value.
auto minimumValue() const -> double
Returns the minimum value.
void setMaximumValue(double value)
Sets the maximum value.
void setMinimumValue(double value)
Sets the minimum value.

Protected variables

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.
Qgis::DataType mQgsRasterDataType
Data type of the band.

Function documentation

double QgsContrastEnhancementFunction::maximumValue() const

Returns the maximum value.

double QgsContrastEnhancementFunction::minimumValue() const

Returns the minimum value.

void QgsContrastEnhancementFunction::setMaximumValue(double value)

Sets the maximum value.

void QgsContrastEnhancementFunction::setMinimumValue(double value)

Sets the minimum value.