QgsBrightnessContrastFilter Class Reference

Brightness/contrast filter pipe for rasters. More...

#include <qgsbrightnesscontrastfilter.h>

Inheritance diagram for QgsBrightnessContrastFilter:

Collaboration diagram for QgsBrightnessContrastFilter:

List of all members.

Public Member Functions
	QgsBrightnessContrastFilter (QgsRasterInterface *input=0)
	~QgsBrightnessContrastFilter ()
int	bandCount () const
	Get number of bands.
QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height)
	Read block of data using given extent and size.
int	brightness () const
QgsRasterInterface *	clone () const
	Clone itself, create deep copy.
int	contrast () const
QGis::DataType	dataType (int bandNo) const
	Returns data type for the band specified by number.
void	readXML (const QDomElement &filterElem)
	Sets base class members from xml.
void	setBrightness (int brightness)
void	setContrast (int contrast)
bool	setInput (QgsRasterInterface *input)
	Set input.
void	writeXML (QDomDocument &doc, QDomElement &parentElem) const
	Write base class members to xml.
Private Member Functions
int	adjustColorComponent (int colorComponent, int alpha, int brightness, double contrastFactor) const
	Adjusts a color component by the specified brightness and contrast factor.
Private Attributes
int	mBrightness
	Current brightness coefficient value.
double	mContrast
	Current contrast coefficient value.

---

Detailed Description

Brightness/contrast filter pipe for rasters.

Definition at line 29 of file qgsbrightnesscontrastfilter.h.

---

Constructor & Destructor Documentation

QgsBrightnessContrastFilter::QgsBrightnessContrastFilter

(

QgsRasterInterface *

input = 0

)

Definition at line 25 of file qgsbrightnesscontrastfilter.cpp.

Referenced by clone().

QgsBrightnessContrastFilter::~QgsBrightnessContrastFilter

(

)

Definition at line 32 of file qgsbrightnesscontrastfilter.cpp.

---

Member Function Documentation

int QgsBrightnessContrastFilter::adjustColorComponent	(	int	colorComponent,
		int	alpha,
		int	brightness,
		double	contrastFactor
	)		const [private]

Adjusts a color component by the specified brightness and contrast factor.

Definition at line 175 of file qgsbrightnesscontrastfilter.cpp.

Referenced by block().

int QgsBrightnessContrastFilter::bandCount

(

)

const [virtual]

Get number of bands.

Implements QgsRasterInterface.

Definition at line 45 of file qgsbrightnesscontrastfilter.cpp.

References QgsRasterInterface::bandCount(), QgsRasterInterface::mInput, and QgsRasterInterface::mOn.

QgsRasterBlock * QgsBrightnessContrastFilter::block	(	int	bandNo,
		const QgsRectangle &	extent,
		int	width,
		int	height
	)		[virtual]

Read block of data using given extent and size.

Returns pointer to data. Caller is responsible to free the memory returned.

Parameters:

bandNo	band number
extent	extent of block
width	pixel width of block
height	pixel height of block

Implements QgsRasterInterface.

Definition at line 112 of file qgsbrightnesscontrastfilter.cpp.

References adjustColorComponent(), QGis::ARGB32_Premultiplied, QgsRasterInterface::block(), QgsRasterBlock::color(), QgsRasterBlock::isEmpty(), mBrightness, mContrast, QgsRasterInterface::mInput, QgsDebugMsg, QgsRasterBlock::reset(), QgsRasterBlock::setColor(), and QgsRectangle::toString().

int QgsBrightnessContrastFilter::brightness

(

)

const [inline]

Definition at line 46 of file qgsbrightnesscontrastfilter.h.

QgsRasterInterface * QgsBrightnessContrastFilter::clone

(

)

const [virtual]

Clone itself, create deep copy.

Implements QgsRasterInterface.

Definition at line 36 of file qgsbrightnesscontrastfilter.cpp.

References mBrightness, mContrast, QgsBrightnessContrastFilter(), QgsDebugMsg, setBrightness(), and setContrast().

int QgsBrightnessContrastFilter::contrast

(

)

const [inline]

Definition at line 49 of file qgsbrightnesscontrastfilter.h.

QGis::DataType QgsBrightnessContrastFilter::dataType

(

int

bandNo

)

const [virtual]

Returns data type for the band specified by number.

Implements QgsRasterInterface.

Definition at line 60 of file qgsbrightnesscontrastfilter.cpp.

References QGis::ARGB32_Premultiplied, QgsRasterInterface::dataType(), QgsRasterInterface::mInput, QgsRasterInterface::mOn, and QGis::UnknownDataType.

void QgsBrightnessContrastFilter::readXML

(

const QDomElement &

filterElem

)

[virtual]

Sets base class members from xml.

Usually called from create() methods of subclasses

Reimplemented from QgsRasterInterface.

Definition at line 208 of file qgsbrightnesscontrastfilter.cpp.

References mBrightness, and mContrast.

Referenced by QgsRasterLayer::readSymbology().

void QgsBrightnessContrastFilter::setBrightness

(

int

brightness

)

[inline]

Definition at line 45 of file qgsbrightnesscontrastfilter.h.

Referenced by clone().

void QgsBrightnessContrastFilter::setContrast

(

int

contrast

)

[inline]

Definition at line 48 of file qgsbrightnesscontrastfilter.h.

Referenced by clone().

bool QgsBrightnessContrastFilter::setInput

(

QgsRasterInterface *

input

)

[virtual]

Set input.

Returns true if set correctly, false if cannot use that input

Reimplemented from QgsRasterInterface.

Definition at line 75 of file qgsbrightnesscontrastfilter.cpp.

References QGis::ARGB32, QGis::ARGB32_Premultiplied, QgsRasterInterface::bandCount(), QgsRasterInterface::dataType(), QgsRasterInterface::input(), QgsRasterInterface::mInput, QgsRasterInterface::mOn, and QgsDebugMsg.

void QgsBrightnessContrastFilter::writeXML	(	QDomDocument &	doc,
		QDomElement &	parentElem
	)		const [virtual]

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 194 of file qgsbrightnesscontrastfilter.cpp.

References mBrightness, and mContrast.

---

Member Data Documentation

int QgsBrightnessContrastFilter::mBrightness [private]

Current brightness coefficient value.

Default: 0. Range: -255...255

Definition at line 61 of file qgsbrightnesscontrastfilter.h.

Referenced by block(), clone(), readXML(), and writeXML().

double QgsBrightnessContrastFilter::mContrast [private]

Current contrast coefficient value.

Default: 0. Range: -100...100

Definition at line 64 of file qgsbrightnesscontrastfilter.h.

Referenced by block(), clone(), readXML(), and writeXML().

---

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

• src/core/raster/qgsbrightnesscontrastfilter.h
• src/core/raster/qgsbrightnesscontrastfilter.cpp