QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Protected Attributes | List of all members
QgsContrastEnhancementFunction Class Reference

A contrast enhancement funcion 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 ()
 
virtual int enhance (double)
 A customizable method that takes in a double and returns a int between 0 and 255. More...
 
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...
 

Protected Attributes

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 contrast enhancement funcion 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 31 of file qgscontrastenhancementfunction.h.

Constructor & Destructor Documentation

QgsContrastEnhancementFunction::QgsContrastEnhancementFunction ( QGis::DataType  theDataType,
double  theMinimumValue,
double  theMaximumValue 
)

Definition at line 21 of file qgscontrastenhancementfunction.cpp.

QgsContrastEnhancementFunction::QgsContrastEnhancementFunction ( const QgsContrastEnhancementFunction f)

Definition at line 29 of file qgscontrastenhancementfunction.cpp.

virtual QgsContrastEnhancementFunction::~QgsContrastEnhancementFunction ( )
inlinevirtual

Definition at line 37 of file qgscontrastenhancementfunction.h.

Member Function Documentation

int QgsContrastEnhancementFunction::enhance ( double  theValue)
virtual

A customizable method that takes in a double and returns a int between 0 and 255.

Reimplemented in QgsClipToMinMaxEnhancement, QgsLinearMinMaxEnhancementWithClip, and QgsLinearMinMaxEnhancement.

Definition at line 37 of file qgscontrastenhancementfunction.cpp.

bool QgsContrastEnhancementFunction::isValueInDisplayableRange ( double  theValue)
virtual

A customicable method to indicate if the pixels is displayable.

Reimplemented in QgsClipToMinMaxEnhancement, and QgsLinearMinMaxEnhancementWithClip.

Definition at line 49 of file qgscontrastenhancementfunction.cpp.

void QgsContrastEnhancementFunction::setMaximumValue ( double  theValue)

Mustator for the maximum value.

Definition at line 60 of file qgscontrastenhancementfunction.cpp.

void QgsContrastEnhancementFunction::setMinimumValue ( double  theValue)

Mutator for the minimum value.

Definition at line 74 of file qgscontrastenhancementfunction.cpp.

Member Data Documentation

double QgsContrastEnhancementFunction::mMaximumValue
protected

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

Definition at line 53 of file qgscontrastenhancementfunction.h.

double QgsContrastEnhancementFunction::mMinimumMaximumRange
protected

Minimum maximum range for the band, used for enhanceContrasting.

Definition at line 59 of file qgscontrastenhancementfunction.h.

double QgsContrastEnhancementFunction::mMinimumValue
protected

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

Definition at line 56 of file qgscontrastenhancementfunction.h.

QGis::DataType QgsContrastEnhancementFunction::mQgsRasterDataType
protected

Data type of the band.

Definition at line 62 of file qgscontrastenhancementfunction.h.


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