QgsSingleBandGrayRenderer Class Reference

Raster renderer pipe for single band gray. More...

#include <qgssinglebandgrayrenderer.h>

Inheritance diagram for QgsSingleBandGrayRenderer:

Collaboration diagram for QgsSingleBandGrayRenderer:

List of all members.

Public Types
enum	Gradient { BlackToWhite, WhiteToBlack }
Public Member Functions
	QgsSingleBandGrayRenderer (QgsRasterInterface *input, int grayBand)
	~QgsSingleBandGrayRenderer ()
QgsRasterBlock *	block (int bandNo, QgsRectangle const &extent, int width, int height)
	Read block of data using given extent and size.
QgsRasterInterface *	clone () const
	Clone itself, create deep copy.
const QgsContrastEnhancement *	contrastEnhancement () const
Gradient	gradient () const
int	grayBand () const
void	legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const
	Get symbology items if provided by renderer.
void	setContrastEnhancement (QgsContrastEnhancement *ce)
	Takes ownership.
void	setGradient (Gradient theGradient)
void	setGrayBand (int band)
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
QgsContrastEnhancement *	mContrastEnhancement
Gradient	mGradient
int	mGrayBand

---

Detailed Description

Raster renderer pipe for single band gray.

Definition at line 29 of file qgssinglebandgrayrenderer.h.

---

Member Enumeration Documentation

enum QgsSingleBandGrayRenderer::Gradient

Enumerator:

BlackToWhite
WhiteToBlack

Definition at line 32 of file qgssinglebandgrayrenderer.h.

---

Constructor & Destructor Documentation

QgsSingleBandGrayRenderer::QgsSingleBandGrayRenderer	(	QgsRasterInterface *	input,
		int	grayBand
	)

Definition at line 25 of file qgssinglebandgrayrenderer.cpp.

Referenced by clone(), and create().

QgsSingleBandGrayRenderer::~QgsSingleBandGrayRenderer

(

)

Definition at line 30 of file qgssinglebandgrayrenderer.cpp.

References mContrastEnhancement.

---

Member Function Documentation

QgsRasterBlock * QgsSingleBandGrayRenderer::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 82 of file qgssinglebandgrayrenderer.cpp.

References QgsRasterTransparency::alphaValue(), QGis::ARGB32_Premultiplied, QgsRasterInterface::block(), QgsContrastEnhancement::enhanceContrast(), QgsRasterBlock::isEmpty(), QgsRasterBlock::isNoData(), QgsContrastEnhancement::isValueInDisplayableRange(), QgsRasterRenderer::mAlphaBand, mContrastEnhancement, mGradient, mGrayBand, QgsRasterInterface::mInput, QgsRasterRenderer::mOpacity, QgsRasterRenderer::mRasterTransparency, QgsRasterRenderer::NODATA_COLOR, QgsDebugMsg, qgsDoubleNear(), QgsRasterBlock::reset(), QgsRasterBlock::setColor(), QgsRasterBlock::value(), and WhiteToBlack.

QgsRasterInterface * QgsSingleBandGrayRenderer::clone

(

)

const [virtual]

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 35 of file qgssinglebandgrayrenderer.cpp.

References QgsRasterRenderer::mAlphaBand, mContrastEnhancement, mGradient, mGrayBand, QgsRasterRenderer::mOpacity, QgsRasterRenderer::mRasterTransparency, QgsSingleBandGrayRenderer(), QgsRasterRenderer::setAlphaBand(), setContrastEnhancement(), setGradient(), QgsRasterRenderer::setOpacity(), and QgsRasterRenderer::setRasterTransparency().

const QgsContrastEnhancement* QgsSingleBandGrayRenderer::contrastEnhancement

(

)

const [inline]

Definition at line 48 of file qgssinglebandgrayrenderer.h.

Referenced by QgsSingleBandGrayRendererWidget::setFromRenderer().

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

Definition at line 49 of file qgssinglebandgrayrenderer.cpp.

References QgsRasterInterface::dataType(), grayBand(), QgsSingleBandGrayRenderer(), QgsRasterRenderer::readXML(), QgsContrastEnhancement::readXML(), setContrastEnhancement(), setGradient(), and WhiteToBlack.

Referenced by QgsRasterRendererRegistry::QgsRasterRendererRegistry().

Gradient QgsSingleBandGrayRenderer::gradient

(

)

const [inline]

Definition at line 53 of file qgssinglebandgrayrenderer.h.

Referenced by QgsSingleBandGrayRendererWidget::setFromRenderer(), and writeXML().

int QgsSingleBandGrayRenderer::grayBand

(

)

const [inline]

Definition at line 46 of file qgssinglebandgrayrenderer.h.

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

void QgsSingleBandGrayRenderer::legendSymbologyItems

(

QList< QPair< QString, QColor > > &

symbolItems

)

const [virtual]

Get symbology items if provided by renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 212 of file qgssinglebandgrayrenderer.cpp.

References QgsContrastEnhancement::contrastEnhancementAlgorithm(), QgsContrastEnhancement::maximumValue(), mContrastEnhancement, QgsContrastEnhancement::minimumValue(), and QgsContrastEnhancement::NoEnhancement.

void QgsSingleBandGrayRenderer::setContrastEnhancement

(

QgsContrastEnhancement *

ce

)

Takes ownership.

Definition at line 76 of file qgssinglebandgrayrenderer.cpp.

References mContrastEnhancement.

Referenced by clone(), create(), QgsSingleBandGrayRendererWidget::renderer(), and QgsRasterLayer::setContrastEnhancement().

void QgsSingleBandGrayRenderer::setGradient

(

Gradient

theGradient

)

[inline]

Definition at line 52 of file qgssinglebandgrayrenderer.h.

Referenced by clone(), create(), and QgsSingleBandGrayRendererWidget::renderer().

void QgsSingleBandGrayRenderer::setGrayBand

(

int

band

)

[inline]

Definition at line 47 of file qgssinglebandgrayrenderer.h.

QList< int > QgsSingleBandGrayRenderer::usesBands

(

)

const [virtual]

Returns a list of band numbers used by the renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 221 of file qgssinglebandgrayrenderer.cpp.

References mGrayBand.

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

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 180 of file qgssinglebandgrayrenderer.cpp.

References QgsRasterRenderer::_writeXML(), BlackToWhite, gradient(), mContrastEnhancement, mGradient, mGrayBand, and QgsContrastEnhancement::writeXML().

---

Member Data Documentation

QgsContrastEnhancement* QgsSingleBandGrayRenderer::mContrastEnhancement [private]

Definition at line 64 of file qgssinglebandgrayrenderer.h.

Referenced by block(), clone(), legendSymbologyItems(), setContrastEnhancement(), writeXML(), and ~QgsSingleBandGrayRenderer().

Gradient QgsSingleBandGrayRenderer::mGradient [private]

Definition at line 63 of file qgssinglebandgrayrenderer.h.

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

int QgsSingleBandGrayRenderer::mGrayBand [private]

Definition at line 62 of file qgssinglebandgrayrenderer.h.

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

---

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

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