QGIS API Documentation  2.5.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 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 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.

Constructor & Destructor Documentation

QgsContrastEnhancementFunction::QgsContrastEnhancementFunction ( QGis::DataType  theDataType,
double  theMinimumValue,
double  theMaximumValue 
)
QgsContrastEnhancementFunction::QgsContrastEnhancementFunction ( const QgsContrastEnhancementFunction f)
virtual QgsContrastEnhancementFunction::~QgsContrastEnhancementFunction ( )
inlinevirtual

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.

bool QgsContrastEnhancementFunction::isValueInDisplayableRange ( double  theValue)
virtual

A customicable method to indicate if the pixels is displayable.

Reimplemented in QgsClipToMinMaxEnhancement, and QgsLinearMinMaxEnhancementWithClip.

void QgsContrastEnhancementFunction::setMaximumValue ( double  theValue)

Mustator for the maximum value.

void QgsContrastEnhancementFunction::setMinimumValue ( double  theValue)

Mutator for the minimum value.

Member Data Documentation

double QgsContrastEnhancementFunction::mMaximumValue
protected

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

double QgsContrastEnhancementFunction::mMinimumMaximumRange
protected

Minimum maximum range for the band, used for enhanceContrasting.

double QgsContrastEnhancementFunction::mMinimumValue
protected

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

QGis::DataType QgsContrastEnhancementFunction::mQgsRasterDataType
protected

Data type of the band.


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