Renderer for paletted raster images. More...

#include <qgspalettedrasterrenderer.h>

Inheritance diagram for QgsPalettedRasterRenderer:

Public Member Functions
	QgsPalettedRasterRenderer (QgsRasterInterface input, int bandNumber, QColor colorArray, int nColors, const QVector< QString > &labels=QVector< QString >())
	Renderer owns color array. More...

	QgsPalettedRasterRenderer (QgsRasterInterface input, int bandNumber, QRgb colorArray, int nColors, const QVector< QString > &labels=QVector< QString >())

	~QgsPalettedRasterRenderer ()

QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height) override
	Read block of data using given extent and size. More...

QgsRasterBlock *	block2 (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override
	Read block of data using given extent and size. More...

QgsPalettedRasterRenderer *	clone () const override
	Clone itself, create deep copy. More...

QColor *	colors () const
	Returns copy of color array (caller takes ownership) More...

QString	label (int idx) const
	Return optional category label. More...

void	legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const override
	Get symbology items if provided by renderer. More...

int	nColors () const
	Returns number of colors. More...

QRgb *	rgbArray () const
	Returns copy of rgb array (caller takes ownership) More...

void	setLabel (int idx, const QString &label)
	Set category label. More...

QList< int >	usesBands () const override
	Returns a list of band numbers used by the renderer. More...

void	writeXML (QDomDocument &doc, QDomElement &parentElem) const override
	Write base class members to xml. More...

Public Member Functions inherited from QgsRasterRenderer
	QgsRasterRenderer (QgsRasterInterface *input=nullptr, const QString &type="")

virtual	~QgsRasterRenderer ()

int	alphaBand () const

virtual int	bandCount () const override
	Get number of bands. More...

void	copyCommonProperties (const QgsRasterRenderer *other)
	Copies common properties like opacity / transparency data from other renderer. More...

virtual QGis::DataType	dataType (int bandNo) const override
	Returns data type for the band specified by number. More...

double	opacity () const

const QgsRasterTransparency *	rasterTransparency () const

void	readXML (const QDomElement &rendererElem) override
	Sets base class members from xml. More...

void	setAlphaBand (int band)

virtual bool	setInput (QgsRasterInterface *input) override
	Set input. More...

void	setOpacity (double opacity)

void	setRasterTransparency (QgsRasterTransparency *t)

virtual QString	type () const

bool	usesTransparency () const

Public Member Functions inherited from QgsRasterInterface
	QgsRasterInterface (QgsRasterInterface *input=nullptr)

virtual	~QgsRasterInterface ()

virtual QgsRasterBandStats	bandStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
	Get band statistics. More...

virtual int	capabilities () const
	Returns a bitmask containing the supported capabilities. More...

QString	capabilitiesString () const
	Returns the above in friendly format. More...

virtual void	cumulativeCut (int theBandNo, double theLowerCount, double theUpperCount, double &theLowerValue, double &theUpperValue, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
	Find values for cumulative pixel count cut. More...

int	dataTypeSize (int bandNo)

virtual QgsRectangle	extent ()
	Get the extent of the interface. More...

virtual QString	generateBandName (int theBandNumber) const
	helper function to create zero padded band names More...

virtual bool	hasHistogram (int theBandNo, int theBinCount, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false)
	Returns true if histogram is available (cached, already calculated), the parameters are the same as in histogram() More...

virtual bool	hasStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
	Returns true if histogram is available (cached, already calculated). More...

virtual QgsRasterHistogram	histogram (int theBandNo, int theBinCount=0, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false)
	Get histogram. More...

virtual QgsRasterInterface *	input () const
	Current input. More...

virtual bool	on () const
	Is on/off. More...

virtual void	setOn (bool on)
	Set on/off. More...

virtual QGis::DataType	srcDataType (int bandNo) const
	Returns source data type for the band specified by number, source data type may be shorter than dataType. More...

virtual const QgsRasterInterface *	srcInput () const
	Get source / raw input, the first in pipe, usually provider. More...

virtual QgsRasterInterface *	srcInput ()

virtual int	xBlockSize () const
	Get block size. More...

virtual int	xSize () const
	Get raster size. More...

virtual int	yBlockSize () const

virtual int	ySize () const

Static Public Member Functions
static QgsRasterRenderer *	create (const QDomElement &elem, QgsRasterInterface *input)

Static Public Member Functions inherited from QgsRasterRenderer
static int	minMaxOriginFromName (const QString &theName)

static QString	minMaxOriginLabel (int theOrigin)

static QString	minMaxOriginName (int theOrigin)

Additional Inherited Members
Public Types inherited from QgsRasterRenderer
enum	MinMaxOrigin { MinMaxUnknown = 0, MinMaxUser = 1, MinMaxMinMax = 1 << 1, MinMaxCumulativeCut = 1 << 2, MinMaxStdDev = 1 << 3, MinMaxFullExtent = 1 << 4, MinMaxSubExtent = 1 << 5, MinMaxEstimated = 1 << 6, MinMaxExact = 1 << 7 }

Public Types inherited from QgsRasterInterface
enum	Capability { NoCapabilities = 0, Size = 1 << 1, Create = 1 << 2, Remove = 1 << 3, BuildPyramids = 1 << 4, Identify = 1 << 5, IdentifyValue = 1 << 6, IdentifyText = 1 << 7, IdentifyHtml = 1 << 8, IdentifyFeature = 1 << 9 }
	If you add to this, please also add to capabilitiesString() More...

Static Public Attributes inherited from QgsRasterRenderer
static const QRgb	NODATA_COLOR = qRgba( 0, 0, 0, 0 )

Protected Member Functions inherited from QgsRasterRenderer
void	_writeXML (QDomDocument &doc, QDomElement &rasterRendererElem) const
	Write upper class info into rasterrenderer element (called by writeXML method of subclasses) More...

Protected Member Functions inherited from QgsRasterInterface
void	initHistogram (QgsRasterHistogram &theHistogram, int theBandNo, int theBinCount=0, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false)
	Fill in histogram defaults if not specified. More...

void	initStatistics (QgsRasterBandStats &theStatistics, int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theBinCount=0)
	Fill in statistics defaults if not specified. More...

Protected Attributes inherited from QgsRasterRenderer
int	mAlphaBand
	Read alpha value from band. More...

double	mOpacity
	Global alpha value (0-1) More...

QgsRasterTransparency *	mRasterTransparency
	Raster transparency per color or value. More...

QString	mType

Protected Attributes inherited from QgsRasterInterface
QList< QgsRasterHistogram >	mHistograms
	List of cached histograms, all bands mixed. More...

QgsRasterInterface *	mInput

bool	mOn

QList< QgsRasterBandStats >	mStatistics
	List of cached statistics, all bands mixed. More...

Detailed Description

Renderer for paletted raster images.

Definition at line 31 of file qgspalettedrasterrenderer.h.

Constructor & Destructor Documentation

◆ QgsPalettedRasterRenderer() [1/2]

QgsPalettedRasterRenderer::QgsPalettedRasterRenderer	(	QgsRasterInterface *	input,
		int	bandNumber,
		QColor *	colorArray,
		int	nColors,
		const QVector< QString > &	labels = `QVector<QString>()`
	)

Renderer owns color array.

Definition at line 27 of file qgspalettedrasterrenderer.cpp.

◆ QgsPalettedRasterRenderer() [2/2]

QgsPalettedRasterRenderer::QgsPalettedRasterRenderer	(	QgsRasterInterface *	input,
		int	bandNumber,
		QRgb *	colorArray,
		int	nColors,
		const QVector< QString > &	labels = `QVector<QString>()`
	)

Definition at line 39 of file qgspalettedrasterrenderer.cpp.

◆ ~QgsPalettedRasterRenderer()

QgsPalettedRasterRenderer::~QgsPalettedRasterRenderer ( )

Definition at line 44 of file qgspalettedrasterrenderer.cpp.

Member Function Documentation

◆ block()

QgsRasterBlock * QgsPalettedRasterRenderer::block	(	int	bandNo,
		const QgsRectangle &	extent,
		int	width,
		int	height
	)

overridevirtual

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 154 of file qgspalettedrasterrenderer.cpp.

◆ block2()

QgsRasterBlock * QgsPalettedRasterRenderer::block2	(	int	bandNo,
		const QgsRectangle &	extent,
		int	width,
		int	height,
		QgsRasterBlockFeedback *	feedback = `nullptr`
	)

overridevirtual

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
feedback	optional raster feedback object for cancellation/preview

Note: This is extended version of block() method. Default implementation falls back to calling block().; Added in QGIS 2.18

Reimplemented from QgsRasterInterface.

Definition at line 159 of file qgspalettedrasterrenderer.cpp.

◆ clone()

QgsPalettedRasterRenderer * QgsPalettedRasterRenderer::clone ( ) const

overridevirtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 49 of file qgspalettedrasterrenderer.cpp.

◆ colors()

QColor * QgsPalettedRasterRenderer::colors ( ) const

Returns copy of color array (caller takes ownership)

Definition at line 117 of file qgspalettedrasterrenderer.cpp.

◆ create()

QgsRasterRenderer * QgsPalettedRasterRenderer::create	(	const QDomElement &	elem,
		QgsRasterInterface *	input
	)

static

Definition at line 58 of file qgspalettedrasterrenderer.cpp.

◆ label()

QString QgsPalettedRasterRenderer::label ( int idx ) const

inline

Return optional category label.

Note: added in 2.1

Definition at line 56 of file qgspalettedrasterrenderer.h.

◆ legendSymbologyItems()

void QgsPalettedRasterRenderer::legendSymbologyItems ( QList< QPair< QString, QColor > > & symbolItems ) const

overridevirtual

Get symbology items if provided by renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 276 of file qgspalettedrasterrenderer.cpp.

◆ nColors()

int QgsPalettedRasterRenderer::nColors ( ) const

inline

Returns number of colors.

Definition at line 45 of file qgspalettedrasterrenderer.h.

◆ rgbArray()

QRgb * QgsPalettedRasterRenderer::rgbArray ( ) const

Returns copy of rgb array (caller takes ownership)

Note: not available in python bindings

Definition at line 131 of file qgspalettedrasterrenderer.cpp.

◆ setLabel()

void QgsPalettedRasterRenderer::setLabel	(	int	idx,
		const QString &	label
	)

Set category label.

Note: added in 2.1

Definition at line 145 of file qgspalettedrasterrenderer.cpp.

◆ usesBands()

QList< int > QgsPalettedRasterRenderer::usesBands ( ) const

overridevirtual

Returns a list of band numbers used by the renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 285 of file qgspalettedrasterrenderer.cpp.

◆ writeXML()

void QgsPalettedRasterRenderer::writeXML	(	QDomDocument &	doc,
		QDomElement &	parentElem
	)		const

overridevirtual

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 248 of file qgspalettedrasterrenderer.cpp.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/core/raster/qgspalettedrasterrenderer.h
/tmp/buildd/qgis-2.18.21+99unstable/src/core/raster/qgspalettedrasterrenderer.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsPalettedRasterRenderer() [1/2]

◆ QgsPalettedRasterRenderer() [2/2]

◆ ~QgsPalettedRasterRenderer()

Member Function Documentation

◆ block()

◆ block2()

◆ clone()

◆ colors()

◆ create()

◆ label()

◆ legendSymbologyItems()

◆ nColors()

◆ rgbArray()

◆ setLabel()

◆ usesBands()

◆ writeXML()