QgsMultiBandColorRenderer Class Reference

Renderer for multiband images with the color components. More...

#include <qgsmultibandcolorrenderer.h>

Inheritance diagram for QgsMultiBandColorRenderer:

Collaboration diagram for QgsMultiBandColorRenderer:

List of all members.

Public Member Functions
	QgsMultiBandColorRenderer (QgsRasterInterface *input, int redBand, int greenBand, int blueBand, QgsContrastEnhancement *redEnhancement=0, QgsContrastEnhancement *greenEnhancement=0, QgsContrastEnhancement *blueEnhancement=0)
	~QgsMultiBandColorRenderer ()
QgsRasterBlock *	block (int bandNo, QgsRectangle const &extent, int width, int height)
	Read block of data using given extent and size.
int	blueBand () const
const QgsContrastEnhancement *	blueContrastEnhancement () const
QgsRasterInterface *	clone () const
	Clone itself, create deep copy.
int	greenBand () const
const QgsContrastEnhancement *	greenContrastEnhancement () const
int	redBand () const
const QgsContrastEnhancement *	redContrastEnhancement () const
void	setBlueBand (int band)
void	setBlueContrastEnhancement (QgsContrastEnhancement *ce)
	Takes ownership.
void	setGreenBand (int band)
void	setGreenContrastEnhancement (QgsContrastEnhancement *ce)
	Takes ownership.
void	setRedBand (int band)
void	setRedContrastEnhancement (QgsContrastEnhancement *ce)
	Takes ownership.
QList< int >	usesBands () const
	Returns a list of band numbers used by the renderer.
void	writeXML (QDomDocument &doc, QDomElement &parentElem) const
	Write base class members to xml.
Static Public Member Functions
static QgsRasterRenderer *	create (const QDomElement &elem, QgsRasterInterface *input)
Private Attributes
int	mBlueBand
QgsContrastEnhancement *	mBlueContrastEnhancement
int	mGreenBand
QgsContrastEnhancement *	mGreenContrastEnhancement
int	mRedBand
QgsContrastEnhancement *	mRedContrastEnhancement

---

Detailed Description

Renderer for multiband images with the color components.

Definition at line 29 of file qgsmultibandcolorrenderer.h.

---

Constructor & Destructor Documentation

QgsMultiBandColorRenderer::QgsMultiBandColorRenderer	(	QgsRasterInterface *	input,
		int	redBand,
		int	greenBand,
		int	blueBand,
		QgsContrastEnhancement *	redEnhancement = 0,
		QgsContrastEnhancement *	greenEnhancement = 0,
		QgsContrastEnhancement *	blueEnhancement = 0
	)

Definition at line 27 of file qgsmultibandcolorrenderer.cpp.

Referenced by clone(), and create().

QgsMultiBandColorRenderer::~QgsMultiBandColorRenderer

(

)

Definition at line 36 of file qgsmultibandcolorrenderer.cpp.

References mBlueContrastEnhancement, mGreenContrastEnhancement, and mRedContrastEnhancement.

---

Member Function Documentation

QgsRasterBlock * QgsMultiBandColorRenderer::block	(	int	bandNo,
		QgsRectangle const &	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 QgsRasterRenderer.

Definition at line 126 of file qgsmultibandcolorrenderer.cpp.

References QgsRasterTransparency::alphaValue(), QGis::ARGB32_Premultiplied, QgsRasterInterface::block(), QgsContrastEnhancement::enhanceContrast(), QgsRasterBlock::isNoData(), QgsContrastEnhancement::isValueInDisplayableRange(), QgsRasterRenderer::mAlphaBand, mBlueBand, mBlueContrastEnhancement, mGreenBand, mGreenContrastEnhancement, QgsRasterInterface::mInput, QgsRasterRenderer::mOpacity, QgsRasterRenderer::mRasterTransparency, mRedBand, mRedContrastEnhancement, QgsRasterRenderer::NODATA_COLOR, QgsDebugMsg, qgsDoubleNear(), QgsRasterBlock::reset(), QgsRasterBlock::setColor(), QgsRasterRenderer::usesTransparency(), and QgsRasterBlock::value().

int QgsMultiBandColorRenderer::blueBand

(

)

const [inline]

Definition at line 46 of file qgsmultibandcolorrenderer.h.

Referenced by create(), QgsRasterLayer::setContrastEnhancement(), and QgsMultiBandColorRendererWidget::setFromRenderer().

const QgsContrastEnhancement* QgsMultiBandColorRenderer::blueContrastEnhancement

(

)

const [inline]

Definition at line 57 of file qgsmultibandcolorrenderer.h.

Referenced by create(), and QgsMultiBandColorRendererWidget::setFromRenderer().

QgsRasterInterface * QgsMultiBandColorRenderer::clone

(

)

const [virtual]

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 43 of file qgsmultibandcolorrenderer.cpp.

References QgsRasterRenderer::mAlphaBand, mBlueBand, mBlueContrastEnhancement, mGreenBand, mGreenContrastEnhancement, QgsRasterRenderer::mOpacity, QgsRasterRenderer::mRasterTransparency, mRedBand, mRedContrastEnhancement, QgsMultiBandColorRenderer(), QgsRasterRenderer::setAlphaBand(), setBlueContrastEnhancement(), setGreenContrastEnhancement(), QgsRasterRenderer::setOpacity(), QgsRasterRenderer::setRasterTransparency(), and setRedContrastEnhancement().

QgsRasterRenderer * QgsMultiBandColorRenderer::create	(	const QDomElement &	elem,
		QgsRasterInterface *	input
	)		[static]

Definition at line 80 of file qgsmultibandcolorrenderer.cpp.

References blueBand(), blueContrastEnhancement(), QgsRasterInterface::dataType(), greenBand(), greenContrastEnhancement(), QgsMultiBandColorRenderer(), QgsRasterRenderer::readXML(), QgsContrastEnhancement::readXML(), redBand(), and redContrastEnhancement().

Referenced by QgsRasterRendererRegistry::QgsRasterRendererRegistry().

int QgsMultiBandColorRenderer::greenBand

(

)

const [inline]

Definition at line 44 of file qgsmultibandcolorrenderer.h.

Referenced by create(), QgsRasterLayer::setContrastEnhancement(), and QgsMultiBandColorRendererWidget::setFromRenderer().

const QgsContrastEnhancement* QgsMultiBandColorRenderer::greenContrastEnhancement

(

)

const [inline]

Definition at line 53 of file qgsmultibandcolorrenderer.h.

Referenced by create(), and QgsMultiBandColorRendererWidget::setFromRenderer().

int QgsMultiBandColorRenderer::redBand

(

)

const [inline]

Definition at line 42 of file qgsmultibandcolorrenderer.h.

Referenced by create(), QgsRasterLayer::setContrastEnhancement(), and QgsMultiBandColorRendererWidget::setFromRenderer().

const QgsContrastEnhancement* QgsMultiBandColorRenderer::redContrastEnhancement

(

)

const [inline]

Definition at line 49 of file qgsmultibandcolorrenderer.h.

Referenced by create(), and QgsMultiBandColorRendererWidget::setFromRenderer().

void QgsMultiBandColorRenderer::setBlueBand

(

int

band

)

[inline]

Definition at line 47 of file qgsmultibandcolorrenderer.h.

void QgsMultiBandColorRenderer::setBlueContrastEnhancement

(

QgsContrastEnhancement *

ce

)

Takes ownership.

Definition at line 75 of file qgsmultibandcolorrenderer.cpp.

References mBlueContrastEnhancement.

Referenced by clone(), QgsRasterLayer::setContrastEnhancement(), and QgsMultiBandColorRendererWidget::setCustomMinMaxValues().

void QgsMultiBandColorRenderer::setGreenBand

(

int

band

)

[inline]

Definition at line 45 of file qgsmultibandcolorrenderer.h.

void QgsMultiBandColorRenderer::setGreenContrastEnhancement

(

QgsContrastEnhancement *

ce

)

Takes ownership.

Definition at line 70 of file qgsmultibandcolorrenderer.cpp.

References mGreenContrastEnhancement.

Referenced by clone(), QgsRasterLayer::setContrastEnhancement(), and QgsMultiBandColorRendererWidget::setCustomMinMaxValues().

void QgsMultiBandColorRenderer::setRedBand

(

int

band

)

[inline]

Definition at line 43 of file qgsmultibandcolorrenderer.h.

void QgsMultiBandColorRenderer::setRedContrastEnhancement

(

QgsContrastEnhancement *

ce

)

Takes ownership.

Definition at line 65 of file qgsmultibandcolorrenderer.cpp.

References mRedContrastEnhancement.

Referenced by clone(), QgsRasterLayer::setContrastEnhancement(), and QgsMultiBandColorRendererWidget::setCustomMinMaxValues().

QList< int > QgsMultiBandColorRenderer::usesBands

(

)

const [virtual]

Returns a list of band numbers used by the renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 355 of file qgsmultibandcolorrenderer.cpp.

References mBlueBand, mGreenBand, and mRedBand.

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

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 320 of file qgsmultibandcolorrenderer.cpp.

References QgsRasterRenderer::_writeXML(), mBlueBand, mBlueContrastEnhancement, mGreenBand, mGreenContrastEnhancement, mRedBand, mRedContrastEnhancement, and QgsContrastEnhancement::writeXML().

---

Member Data Documentation

int QgsMultiBandColorRenderer::mBlueBand [private]

Definition at line 68 of file qgsmultibandcolorrenderer.h.

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

QgsContrastEnhancement* QgsMultiBandColorRenderer::mBlueContrastEnhancement [private]

Definition at line 72 of file qgsmultibandcolorrenderer.h.

Referenced by block(), clone(), setBlueContrastEnhancement(), writeXML(), and ~QgsMultiBandColorRenderer().

int QgsMultiBandColorRenderer::mGreenBand [private]

Definition at line 67 of file qgsmultibandcolorrenderer.h.

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

QgsContrastEnhancement* QgsMultiBandColorRenderer::mGreenContrastEnhancement [private]

Definition at line 71 of file qgsmultibandcolorrenderer.h.

Referenced by block(), clone(), setGreenContrastEnhancement(), writeXML(), and ~QgsMultiBandColorRenderer().

int QgsMultiBandColorRenderer::mRedBand [private]

Definition at line 66 of file qgsmultibandcolorrenderer.h.

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

QgsContrastEnhancement* QgsMultiBandColorRenderer::mRedContrastEnhancement [private]

Definition at line 70 of file qgsmultibandcolorrenderer.h.

Referenced by block(), clone(), setRedContrastEnhancement(), writeXML(), and ~QgsMultiBandColorRenderer().

---

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

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