QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
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 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 ()
 
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 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 30 of file qgscliptominmaxenhancement.h.

Constructor & Destructor Documentation

◆ QgsClipToMinMaxEnhancement()

QgsClipToMinMaxEnhancement::QgsClipToMinMaxEnhancement ( QGis::DataType  theQgsRasterDataType,
double  theMinimumValue,
double  theMaximumValue 
)

Definition at line 21 of file qgscliptominmaxenhancement.cpp.

Member Function Documentation

◆ enhance()

int QgsClipToMinMaxEnhancement::enhance ( double  theValue)
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 qgscliptominmaxenhancement.cpp.

◆ isValueInDisplayableRange()

bool QgsClipToMinMaxEnhancement::isValueInDisplayableRange ( double  theValue)
overridevirtual

A customicable method to indicate if the pixels is displayable.

Reimplemented from QgsContrastEnhancementFunction.

Definition at line 42 of file qgscliptominmaxenhancement.cpp.


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