QGIS API Documentation  3.2.0-Bonn (bc43194)
Public Member Functions | List of all members
QgsClipToMinMaxEnhancement Class Reference

A raster contrast enhancement that will clip a value to the specified min/max range. More...

#include <qgscliptominmaxenhancement.h>

Inheritance diagram for QgsClipToMinMaxEnhancement:
Inheritance graph
[legend]

Public Member Functions

 QgsClipToMinMaxEnhancement (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...
 
bool isValueInDisplayableRange (double) override
 A customizable method to indicate if a pixel's value is within the displayable range. More...
 
- Public Member Functions inherited from QgsContrastEnhancementFunction
 QgsContrastEnhancementFunction (Qgis::DataType, double, double)
 
 QgsContrastEnhancementFunction (const QgsContrastEnhancementFunction &f)
 
virtual ~QgsContrastEnhancementFunction ()=default
 
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 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 raster contrast enhancement that will clip a value to the specified min/max range.

For example if a min max range of [10,240] is specified in the constructor, and a value of 250 is called using enhance(), the value will be truncated ('clipped') to 240.

Definition at line 32 of file qgscliptominmaxenhancement.h.

Constructor & Destructor Documentation

◆ QgsClipToMinMaxEnhancement()

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

Definition at line 22 of file qgscliptominmaxenhancement.cpp.

Member Function Documentation

◆ enhance()

int QgsClipToMinMaxEnhancement::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 26 of file qgscliptominmaxenhancement.cpp.

◆ isValueInDisplayableRange()

bool QgsClipToMinMaxEnhancement::isValueInDisplayableRange ( double  value)
overridevirtual

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

Reimplemented from QgsContrastEnhancementFunction.

Definition at line 43 of file qgscliptominmaxenhancement.cpp.


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