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:

Collaboration diagram for QgsClipToMinMaxEnhancement:

Public Member Functions
	QgsClipToMinMaxEnhancement (QGis::DataType, 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.
Public Member Functions inherited from QgsContrastEnhancementFunction
	QgsContrastEnhancementFunction (QGis::DataType, double, double)
	QgsContrastEnhancementFunction (const QgsContrastEnhancementFunction &f)
virtual	~QgsContrastEnhancementFunction ()
void	setMaximumValue (double)
	Mustator for the maximum value.
void	setMinimumValue (double)
	Mutator for the minimum value.

Additional Inherited Members
Protected Attributes inherited from QgsContrastEnhancementFunction
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 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	(	QGis::DataType	theQgsRasterDataType,
		double	theMinimumValue,
		double	theMaximumValue
	)

Definition at line 21 of file qgscliptominmaxenhancement.cpp.

Member Function Documentation

int QgsClipToMinMaxEnhancement::enhance ( double  theValue )

virtual

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

Reimplemented from QgsContrastEnhancementFunction.

Definition at line 25 of file qgscliptominmaxenhancement.cpp.

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

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:

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