QGIS API Documentation  2.99.0-Master (bdf46d7)
Public Member Functions | Protected Attributes | List of all members
QgsContrastEnhancementFunction Class Reference

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

#include <qgscontrastenhancementfunction.h>

Inheritance diagram for QgsContrastEnhancementFunction:
Inheritance graph
[legend]

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...
 

Detailed Description

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 31 of file qgscontrastenhancementfunction.h.

Constructor & Destructor Documentation

◆ QgsContrastEnhancementFunction() [1/2]

QgsContrastEnhancementFunction::QgsContrastEnhancementFunction ( Qgis::DataType  dataType,
double  minimumValue,
double  maximumValue 
)

Definition at line 22 of file qgscontrastenhancementfunction.cpp.

◆ QgsContrastEnhancementFunction() [2/2]

QgsContrastEnhancementFunction::QgsContrastEnhancementFunction ( const QgsContrastEnhancementFunction f)

Definition at line 30 of file qgscontrastenhancementfunction.cpp.

◆ ~QgsContrastEnhancementFunction()

virtual QgsContrastEnhancementFunction::~QgsContrastEnhancementFunction ( )
virtualdefault

Member Function Documentation

◆ enhance()

int QgsContrastEnhancementFunction::enhance ( double  value)
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.

◆ isValueInDisplayableRange()

bool QgsContrastEnhancementFunction::isValueInDisplayableRange ( double  value)
virtual

A customicable method to indicate if the pixels is displayable.

Reimplemented in QgsClipToMinMaxEnhancement, and QgsLinearMinMaxEnhancementWithClip.

Definition at line 50 of file qgscontrastenhancementfunction.cpp.

◆ setMaximumValue()

void QgsContrastEnhancementFunction::setMaximumValue ( double  value)

Mustator for the maximum value.

Definition at line 61 of file qgscontrastenhancementfunction.cpp.

◆ setMinimumValue()

void QgsContrastEnhancementFunction::setMinimumValue ( double  value)

Mutator for the minimum value.

Definition at line 75 of file qgscontrastenhancementfunction.cpp.

Member Data Documentation

◆ mMaximumValue

double QgsContrastEnhancementFunction::mMaximumValue
protected

User defineable maximum value for the band, used for enhanceContrasting.

Definition at line 53 of file qgscontrastenhancementfunction.h.

◆ mMinimumMaximumRange

double QgsContrastEnhancementFunction::mMinimumMaximumRange
protected

Minimum maximum range for the band, used for enhanceContrasting.

Definition at line 59 of file qgscontrastenhancementfunction.h.

◆ mMinimumValue

double QgsContrastEnhancementFunction::mMinimumValue
protected

User defineable minimum value for the band, used for enhanceContrasting.

Definition at line 56 of file qgscontrastenhancementfunction.h.

◆ mQgsRasterDataType

Qgis::DataType QgsContrastEnhancementFunction::mQgsRasterDataType
protected

Data type of the band.

Definition at line 62 of file qgscontrastenhancementfunction.h.


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