Quantum GIS API Documentation  1.7.5-Wroclaw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups 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 (QgsContrastEnhancement::QgsRasterDataType, double, double)
 
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...
 
QgsContrastEnhancement::QgsRasterDataType 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 30 of file qgscontrastenhancementfunction.h.

Constructor & Destructor Documentation

QgsContrastEnhancementFunction::QgsContrastEnhancementFunction ( QgsContrastEnhancement::QgsRasterDataType  theDataType,
double  theMinimumValue,
double  theMaximumValue 
)
virtual QgsContrastEnhancementFunction::~QgsContrastEnhancementFunction ( )
inlinevirtual

Definition at line 35 of file qgscontrastenhancementfunction.h.

Member Function Documentation

int QgsContrastEnhancementFunction::enhance ( double  theValue)
virtual
bool QgsContrastEnhancementFunction::isValueInDisplayableRange ( double  theValue)
virtual
void QgsContrastEnhancementFunction::setMaximumValue ( double  theValue)
void QgsContrastEnhancementFunction::setMinimumValue ( double  theValue)

Member Data Documentation

double QgsContrastEnhancementFunction::mMaximumValue
protected
double QgsContrastEnhancementFunction::mMinimumMaximumRange
protected

Minimum maximum range for the band, used for enhanceContrasting.

Definition at line 57 of file qgscontrastenhancementfunction.h.

Referenced by QgsLinearMinMaxEnhancement::enhance(), QgsLinearMinMaxEnhancementWithClip::enhance(), QgsContrastEnhancementFunction(), setMaximumValue(), and setMinimumValue().

double QgsContrastEnhancementFunction::mMinimumValue
protected

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

Definition at line 54 of file qgscontrastenhancementfunction.h.

Referenced by QgsLinearMinMaxEnhancement::enhance(), QgsLinearMinMaxEnhancementWithClip::enhance(), QgsContrastEnhancementFunction(), setMaximumValue(), and setMinimumValue().

QgsContrastEnhancement::QgsRasterDataType QgsContrastEnhancementFunction::mQgsRasterDataType
protected

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