QGIS API Documentation  2.99.0-Master (53aba61)
Public Member Functions | List of all members
QgsLinearMinMaxEnhancementWithClip Class Reference

A linear enhanceContrast enhancement that first clips to min max and then enhanceContrastes linearly between min and max. More...

#include <qgslinearminmaxenhancementwithclip.h>

Inheritance diagram for QgsLinearMinMaxEnhancementWithClip:
Inheritance graph
[legend]

Public Member Functions

 QgsLinearMinMaxEnhancementWithClip (Qgis::DataType, double, double)
 
int enhance (double) override
 A customizable method that takes in a double and returns a int between 0 and 255. More...
 
bool isValueInDisplayableRange (double) override
 A customicable method to indicate if the pixels is displayable. More...
 
- Public Member Functions inherited from QgsContrastEnhancementFunction
 QgsContrastEnhancementFunction (Qgis::DataType, double, double)
 
 QgsContrastEnhancementFunction (const QgsContrastEnhancementFunction &f)
 
virtual ~QgsContrastEnhancementFunction ()=default
 
void setMaximumValue (double)
 Mustator for the maximum value. More...
 
void setMinimumValue (double)
 Mutator for 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 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...
 

Detailed Description

A linear enhanceContrast enhancement that first clips to min max and then enhanceContrastes linearly between min and max.

Definition at line 29 of file qgslinearminmaxenhancementwithclip.h.

Constructor & Destructor Documentation

◆ QgsLinearMinMaxEnhancementWithClip()

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

Definition at line 21 of file qgslinearminmaxenhancementwithclip.cpp.

Member Function Documentation

◆ enhance()

int QgsLinearMinMaxEnhancementWithClip::enhance ( double  value)
overridevirtual

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

Reimplemented from QgsContrastEnhancementFunction.

Definition at line 25 of file qgslinearminmaxenhancementwithclip.cpp.

◆ isValueInDisplayableRange()

bool QgsLinearMinMaxEnhancementWithClip::isValueInDisplayableRange ( double  value)
overridevirtual

A customicable method to indicate if the pixels is displayable.

Reimplemented from QgsContrastEnhancementFunction.

Definition at line 45 of file qgslinearminmaxenhancementwithclip.cpp.


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