QGIS API Documentation  2.3.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
QgsLinearMinMaxEnhancement Class Reference

A color enhancement function that performs a linear enhanceContrast between min and max. More...

#include <qgslinearminmaxenhancement.h>

Inheritance diagram for QgsLinearMinMaxEnhancement:
Inheritance graph
[legend]
Collaboration diagram for QgsLinearMinMaxEnhancement:
Collaboration graph
[legend]

Public Member Functions

 QgsLinearMinMaxEnhancement (QGis::DataType, double, double)
 
int enhance (double)
 A customizable method that takes in a double and returns a int between 0 and 255. More...
 
- Public Member Functions inherited from QgsContrastEnhancementFunction
 QgsContrastEnhancementFunction (QGis::DataType, double, double)
 
 QgsContrastEnhancementFunction (const QgsContrastEnhancementFunction &f)
 
virtual ~QgsContrastEnhancementFunction ()
 
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...
 

Additional Inherited Members

- Protected Attributes inherited from QgsContrastEnhancementFunction
double mMaximumValue
 User defineable maximum value for the band, used for enhanceContrasting. More...
 
double mMinimumValue
 User defineable minimum value for the band, used for enhanceContrasting. More...
 
double mMinimumMaximumRange
 Minimum maximum range for the band, used for enhanceContrasting. More...
 
QGis::DataType mQgsRasterDataType
 Data type of the band. More...
 

Detailed Description

A color enhancement function that performs a linear enhanceContrast between min and max.

Definition at line 27 of file qgslinearminmaxenhancement.h.

Constructor & Destructor Documentation

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

Definition at line 21 of file qgslinearminmaxenhancement.cpp.

Member Function Documentation

int QgsLinearMinMaxEnhancement::enhance ( double  theValue)
virtual

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

References QgsContrastEnhancementFunction::mMinimumMaximumRange, and QgsContrastEnhancementFunction::mMinimumValue.


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