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
QgsLinearMinMaxEnhancementWithClip Class Reference

A linear enhanceContrast enhancement that first clips to min max and then enhanceContrastes linearly between min and max. More...

#include <qgslinearminmaxenhancementwithclip.h>

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

Public Member Functions

 QgsLinearMinMaxEnhancementWithClip (QGis::DataType, double, double)
 
int enhance (double)
 A customizable method that takes in a double and returns a int between 0 and 255. More...
 
bool isValueInDisplayableRange (double)
 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 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 linear enhanceContrast enhancement that first clips to min max and then enhanceContrastes linearly between min and max.

Definition at line 28 of file qgslinearminmaxenhancementwithclip.h.

Constructor & Destructor Documentation

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

Definition at line 21 of file qgslinearminmaxenhancementwithclip.cpp.

Member Function Documentation

int QgsLinearMinMaxEnhancementWithClip::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 qgslinearminmaxenhancementwithclip.cpp.

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

bool QgsLinearMinMaxEnhancementWithClip::isValueInDisplayableRange ( double  theValue)
virtual

A customicable method to indicate if the pixels is displayable.

Reimplemented from QgsContrastEnhancementFunction.

Definition at line 45 of file qgslinearminmaxenhancementwithclip.cpp.

References QgsContrastEnhancementFunction::mMaximumValue.


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