Quantum GIS API Documentation  1.7.4
Public Member Functions
QgsClipToMinMaxEnhancement Class Reference

A raster contrast enhancement that will clip a value to the specified min/max range. More...

#include <qgscliptominmaxenhancement.h>

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

List of all members.

Public Member Functions

 QgsClipToMinMaxEnhancement (QgsContrastEnhancement::QgsRasterDataType, double, double)
int enhance (double)
 A customizable method that takes in a double and returns a int between 0 and 255.
bool isValueInDisplayableRange (double)
 A customicable method to indicate if the pixels is displayable.

Detailed Description

A raster contrast enhancement that will clip a value to the specified min/max range.

For example if a min max range of [10,240] is specified in the constructor, and a value of 250 is called using enhance(), the value will be truncated ('clipped') to 240.

Definition at line 30 of file qgscliptominmaxenhancement.h.


Constructor & Destructor Documentation

QgsClipToMinMaxEnhancement::QgsClipToMinMaxEnhancement ( QgsContrastEnhancement::QgsRasterDataType  theQgsRasterDataType,
double  theMinimumValue,
double  theMaximumValue 
)

Definition at line 21 of file qgscliptominmaxenhancement.cpp.


Member Function Documentation

int QgsClipToMinMaxEnhancement::enhance ( double  theValue) [virtual]
bool QgsClipToMinMaxEnhancement::isValueInDisplayableRange ( double  theValue) [virtual]

A customicable method to indicate if the pixels is displayable.

Reimplemented from QgsContrastEnhancementFunction.

Definition at line 42 of file qgscliptominmaxenhancement.cpp.

References QgsContrastEnhancementFunction::mMaximumValue.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines