QGIS API Documentation  3.13.0-Master (7f54853aae)
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 value)
 A customizable method that takes in a double value and returns a int between 0 and 255. More...
 
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...
 

Protected Attributes

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

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 32 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 value and returns a int between 0 and 255.

Reimplemented in QgsClipToMinMaxEnhancement, QgsLinearMinMaxEnhancementWithClip, and QgsLinearMinMaxEnhancement.

Definition at line 42 of file qgscontrastenhancementfunction.cpp.

◆ isValueInDisplayableRange()

bool QgsContrastEnhancementFunction::isValueInDisplayableRange ( double  value)
virtual

A customizable method to indicate if a pixel's value is within the displayable range.

Reimplemented in QgsClipToMinMaxEnhancement, and QgsLinearMinMaxEnhancementWithClip.

Definition at line 54 of file qgscontrastenhancementfunction.cpp.

◆ maximumValue()

double QgsContrastEnhancementFunction::maximumValue ( ) const
inline

Returns the maximum value.

See also
setMaximumValue()
minimumValue()
Since
QGIS 3.2

Definition at line 70 of file qgscontrastenhancementfunction.h.

◆ minimumValue()

double QgsContrastEnhancementFunction::minimumValue ( ) const
inline

Returns the minimum value.

See also
setMinimumValue()
maximumValue()
Since
QGIS 3.2

Definition at line 78 of file qgscontrastenhancementfunction.h.

◆ setMaximumValue()

void QgsContrastEnhancementFunction::setMaximumValue ( double  value)

Sets the maximum value.

See also
maximumValue()
setMinimumValue()

Definition at line 61 of file qgscontrastenhancementfunction.cpp.

◆ setMinimumValue()

void QgsContrastEnhancementFunction::setMinimumValue ( double  value)

Sets the minimum value.

See also
minimumValue()
setMaximumValue()

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

◆ mMaximumValuePossible

double QgsContrastEnhancementFunction::mMaximumValuePossible = std::numeric_limits< double >::max()
protected

Definition at line 93 of file qgscontrastenhancementfunction.h.

◆ mMinimumMaximumRange

double QgsContrastEnhancementFunction::mMinimumMaximumRange
protected

Minimum maximum range for the band, used for enhanceContrasting.

Definition at line 88 of file qgscontrastenhancementfunction.h.

◆ mMinimumValue

double QgsContrastEnhancementFunction::mMinimumValue
protected

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

Definition at line 85 of file qgscontrastenhancementfunction.h.

◆ mMinimumValuePossible

double QgsContrastEnhancementFunction::mMinimumValuePossible = std::numeric_limits< double >::lowest()
protected

Definition at line 94 of file qgscontrastenhancementfunction.h.

◆ mQgsRasterDataType

Qgis::DataType QgsContrastEnhancementFunction::mQgsRasterDataType
protected

Data type of the band.

Definition at line 91 of file qgscontrastenhancementfunction.h.


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