QGIS API Documentation  3.11.0-Master (68611307d7)
Public Member Functions | List of all members
QgsLinearMinMaxEnhancement Class Reference

A color enhancement function that performs a linear enhanceContrast between min and max. More...

#include <qgslinearminmaxenhancement.h>

Inheritance diagram for QgsLinearMinMaxEnhancement:
Inheritance graph
[legend]

Public Member Functions

 QgsLinearMinMaxEnhancement (Qgis::DataType, double, double)
 
int enhance (double) override
 A customizable method that takes in a double value and returns a int between 0 and 255. More...
 
- Public Member Functions inherited from QgsContrastEnhancementFunction
 QgsContrastEnhancementFunction (Qgis::DataType, double, double)
 
 QgsContrastEnhancementFunction (const QgsContrastEnhancementFunction &f)
 
virtual ~QgsContrastEnhancementFunction ()=default
 
virtual bool isValueInDisplayableRange (double value)
 A customizable method to indicate if a pixel's value is within the displayable range. More...
 
double maximumValue () const
 Returns the maximum value. More...
 
double minimumValue () const
 Returns the minimum value. More...
 
void setMaximumValue (double value)
 Sets the maximum value. More...
 
void setMinimumValue (double value)
 Sets the minimum value. More...
 

Additional Inherited Members

- Protected Attributes inherited from QgsContrastEnhancementFunction
double mMaximumValue
 User defineable maximum value for the band, used for enhanceContrasting. More...
 
double mMaximumValuePossible = std::numeric_limits< double >::max()
 
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...
 
double mMinimumValuePossible = std::numeric_limits< double >::lowest()
 
Qgis::DataType mQgsRasterDataType
 Data type of the band. More...
 

Detailed Description

A color enhancement function that performs a linear enhanceContrast between min and max.

Definition at line 29 of file qgslinearminmaxenhancement.h.

Constructor & Destructor Documentation

◆ QgsLinearMinMaxEnhancement()

QgsLinearMinMaxEnhancement::QgsLinearMinMaxEnhancement ( Qgis::DataType  qgsRasterDataType,
double  minimumValue,
double  maximumValue 
)

Definition at line 21 of file qgslinearminmaxenhancement.cpp.

Member Function Documentation

◆ enhance()

int QgsLinearMinMaxEnhancement::enhance ( double  value)
overridevirtual

A customizable method that takes in a double value and returns a int between 0 and 255.

Reimplemented from QgsContrastEnhancementFunction.

Definition at line 25 of file qgslinearminmaxenhancement.cpp.


The documentation for this class was generated from the following files: