QgsContrastEnhancementFunction Class Reference

A contrast enhancement funcion is the base class for all raster contrast enhancements. More...

#include <qgscontrastenhancementfunction.h>

Inheritance diagram for QgsContrastEnhancementFunction:

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.
virtual bool	isValueInDisplayableRange (double)
	A customicable method to indicate if the pixels is displayable.
void	setMaximumValue (double)
	Mustator for the maximum value.
void	setMinimumValue (double)
	Mutator for the minimum value.

Protected Attributes
double	mMaximumValue
	User defineable maximum value for the band, used for enhanceContrasting.
double	mMinimumValue
	User defineable minimum value for the band, used for enhanceContrasting.
double	mMinimumMaximumRange
	Minimum maximum range for the band, used for enhanceContrasting.
QGis::DataType	mQgsRasterDataType
	Data type of the band.

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.

References mMaximumValue, mMinimumMaximumRange, mMinimumValue, and mQgsRasterDataType.

QgsContrastEnhancementFunction::QgsContrastEnhancementFunction

(

const QgsContrastEnhancementFunction &

f

)

Definition at line 29 of file qgscontrastenhancementfunction.cpp.

References mMaximumValue, mMinimumMaximumRange, mMinimumValue, and mQgsRasterDataType.

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.

References QGis::Byte, QgsContrastEnhancement::maximumValuePossible(), QgsContrastEnhancement::minimumValuePossible(), and mQgsRasterDataType.

Referenced by QgsContrastEnhancement::enhanceContrast(), and QgsContrastEnhancement::generateLookupTable().

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.

References QgsContrastEnhancement::maximumValuePossible(), QgsContrastEnhancement::minimumValuePossible(), and mQgsRasterDataType.

Referenced by QgsContrastEnhancement::isValueInDisplayableRange().

void QgsContrastEnhancementFunction::setMaximumValue

(

double

theValue

)

Mustator for the maximum value.

Definition at line 60 of file qgscontrastenhancementfunction.cpp.

References QgsContrastEnhancement::maximumValuePossible(), mMaximumValue, mMinimumMaximumRange, mMinimumValue, and mQgsRasterDataType.

Referenced by QgsContrastEnhancement::setMaximumValue().

void QgsContrastEnhancementFunction::setMinimumValue

(

double

theValue

)

Mutator for the minimum value.

Definition at line 74 of file qgscontrastenhancementfunction.cpp.

References QgsContrastEnhancement::minimumValuePossible(), mMaximumValue, mMinimumMaximumRange, mMinimumValue, and mQgsRasterDataType.

Referenced by QgsContrastEnhancement::setMinimumValue().

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.

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

double QgsContrastEnhancementFunction::mMinimumMaximumRange

protected

Minimum maximum range for the band, used for enhanceContrasting.

Definition at line 59 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 56 of file qgscontrastenhancementfunction.h.

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

QGis::DataType QgsContrastEnhancementFunction::mQgsRasterDataType

protected

Data type of the band.

Definition at line 62 of file qgscontrastenhancementfunction.h.

Referenced by QgsClipToMinMaxEnhancement::enhance(), enhance(), isValueInDisplayableRange(), QgsContrastEnhancementFunction(), setMaximumValue(), and setMinimumValue().

---

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

• /tmp/buildd/qgis-2.2.0+wheezy1/src/core/raster/qgscontrastenhancementfunction.h
• /tmp/buildd/qgis-2.2.0+wheezy1/src/core/raster/qgscontrastenhancementfunction.cpp