Renderer for paletted raster images. More...

#include <qgspalettedrasterrenderer.h>

Inheritance diagram for QgsPalettedRasterRenderer:

[legend]

Classes
struct	Class
	Properties of a single value class. More...

class	MultiValueClass
	Properties of a multi value class: a class that contains multiple values. More...

Public Types
typedef QList< QgsPalettedRasterRenderer::Class >	ClassData
	Map of value to class properties.

typedef QList< QgsPalettedRasterRenderer::MultiValueClass >	MultiValueClassData
	Map of multi value to class properties.

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 , Prefetch = 1 << 10 }
	If you add to this, please also add to capabilitiesString() More...

Public Member Functions
	QgsPalettedRasterRenderer (const QgsPalettedRasterRenderer &)=delete
	QgsPalettedRasterRenderer cannot be copied. Use clone() instead.

	QgsPalettedRasterRenderer (QgsRasterInterface *input, int bandNumber, const ClassData &classes)
	Constructor for QgsPalettedRasterRenderer.

	QgsPalettedRasterRenderer (QgsRasterInterface *input, int bandNumber, const MultiValueClassData &classes)
	Constructor for QgsPalettedRasterRenderer from multi value classes.

bool	accept (QgsStyleEntityVisitorInterface *visitor) const override
	Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer.

int	band () const
	Returns the raster band used for rendering the raster.

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

bool	canCreateRasterAttributeTable () const override
	Returns `true` if the renderer is suitable for attribute table creation.

ClassData	classes () const
	Returns a map of value to classes (colors) used by the renderer.

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

QList< QgsLayerTreeModelLegendNode * >	createLegendNodes (QgsLayerTreeLayer *nodeLayer) override
	Creates a set of legend nodes representing the renderer.

Qgis::RasterRendererFlags	flags () const override
	Returns flags which dictate renderer behavior.

QString	label (double idx) const
	Returns optional category label.

QList< QPair< QString, QColor > >	legendSymbologyItems () const override
	Returns symbology items if provided by renderer.

MultiValueClassData	multiValueClasses () const
	Returns a map of multi value to classes (colors) used by the renderer.

int	nColors () const
	Returns number of colors.

const QgsPalettedRasterRenderer &	operator= (const QgsPalettedRasterRenderer &)=delete
	QgsPalettedRasterRenderer cannot be copied. Use clone() instead.

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

void	setMultiValueClasses (const MultiValueClassData &classes)
	Sets the multi value classes to setMultiValueClasses.

void	setSourceColorRamp (QgsColorRamp *ramp)
	Set the source color ramp.

QgsColorRamp *	sourceColorRamp () const
	Gets the source color ramp.

void	toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const override
	Used from subclasses to create SLD Rule elements following SLD v1.0 specs.

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

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

Public Member Functions inherited from QgsRasterRenderer
	QgsRasterRenderer (const QgsRasterRenderer &)=delete
	QgsRasterRenderer cannot be copied. Use clone() instead.

	QgsRasterRenderer (QgsRasterInterface *input=nullptr, const QString &type=QString())
	Constructor for QgsRasterRenderer.

	~QgsRasterRenderer () override

int	alphaBand () const

int	bandCount () const override
	Gets number of bands.

void	copyCommonProperties (const QgsRasterRenderer *other, bool copyMinMaxOrigin=true)
	Copies common properties like opacity / transparency data from other renderer.

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

const QgsRasterMinMaxOrigin &	minMaxOrigin () const
	Returns const reference to origin of min/max values.

QColor	nodataColor () const
	Returns the color to use for shading nodata pixels.

double	opacity () const
	Returns the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).

const QgsRasterRenderer &	operator= (const QgsRasterRenderer &)=delete
	QgsRasterRenderer cannot be copied. Use clone() instead.

const QgsRasterTransparency *	rasterTransparency () const

void	readXml (const QDomElement &rendererElem) override
	Sets base class members from xml. Usually called from create() methods of subclasses.

void	setAlphaBand (int band)

bool	setInput (QgsRasterInterface *input) override
	Set input.

void	setMinMaxOrigin (const QgsRasterMinMaxOrigin &origin)
	Sets origin of min/max values.

void	setNodataColor (const QColor &color)
	Sets the color to use for shading nodata pixels.

void	setOpacity (double opacity)
	Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).

void	setRasterTransparency (QgsRasterTransparency *t)

virtual QString	type () const
	Returns a unique string representation of the renderer type.

bool	usesTransparency () const

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

virtual	~QgsRasterInterface ()=default

Q_DECL_DEPRECATED QgsRasterBandStats	bandStatistics (int bandNo, int stats, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
	Returns the band statistics.

virtual QgsRasterBandStats	bandStatistics (int bandNo, Qgis::RasterBandStatistics stats=Qgis::RasterBandStatistic::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
	Returns the band statistics.

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

QString	capabilitiesString () const
	Returns the raster interface capabilities in friendly format.

virtual QString	colorInterpretationName (int bandNumber) const
	Returns the name of the color interpretation for the specified bandNumber.

virtual void	cumulativeCut (int bandNo, double lowerCount, double upperCount, double &lowerValue, double &upperValue, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
	Find values for cumulative pixel count cut.

int	dataTypeSize (int bandNo) const
	Returns the size (in bytes) for the data type for the specified band.

QString	displayBandName (int bandNumber) const
	Generates a friendly, descriptive name for the specified bandNumber.

virtual QgsRectangle	extent () const
	Gets the extent of the interface.

virtual QString	generateBandName (int bandNumber) const
	helper function to create zero padded band names

virtual bool	hasHistogram (int bandNo, int binCount, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false)
	Returns `true` if histogram is available (cached, already calculated)

Q_DECL_DEPRECATED bool	hasStatistics (int bandNo, int stats, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
	Returns `true` if histogram is available (cached, already calculated).

virtual bool	hasStatistics (int bandNo, Qgis::RasterBandStatistics stats=Qgis::RasterBandStatistic::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
	Returns `true` if histogram is available (cached, already calculated).

virtual QgsRasterHistogram	histogram (int bandNo, int binCount=0, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false, QgsRasterBlockFeedback *feedback=nullptr)
	Returns a band histogram.

virtual QgsRasterInterface *	input () const
	Current input.

virtual bool	on () const
	Returns whether the interface is on or off.

virtual void	setOn (bool on)
	Sets whether the interface is on or off.

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

virtual QgsRasterInterface *	sourceInput ()
	Gets source / raw input, the first in pipe, usually provider.

virtual const QgsRasterInterface *	sourceInput () const
	Gets source / raw input, the first in pipe, usually provider.

virtual int	xBlockSize () const
	Gets block size.

virtual int	xSize () const
	Gets raster size.

virtual int	yBlockSize () const

virtual int	ySize () const

Static Public Member Functions
static QgsPalettedRasterRenderer::ClassData	classDataFromFile (const QString &path)
	Opens a color table file and returns corresponding paletted renderer class data.

static QgsPalettedRasterRenderer::ClassData	classDataFromRaster (QgsRasterInterface raster, int bandNumber, QgsColorRamp ramp=nullptr, QgsRasterBlockFeedback *feedback=nullptr)
	Generates class data from a raster, for the specified bandNumber.

static QgsPalettedRasterRenderer::ClassData	classDataFromString (const QString &string)
	Converts a string containing a color table or class data to to paletted renderer class data.

static QString	classDataToString (const QgsPalettedRasterRenderer::ClassData &classes)
	Converts classes to a string representation, using the .clr/gdal color table file format.

static QgsPalettedRasterRenderer::ClassData	colorTableToClassData (const QList< QgsColorRampShader::ColorRampItem > &table)
	Converts a raster color table to paletted renderer class data.

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

static QgsPalettedRasterRenderer::MultiValueClassData	rasterAttributeTableToClassData (const QgsRasterAttributeTable attributeTable, int classificationColumn=-1, QgsColorRamp ramp=nullptr)
	Reads and returns classes from the Raster Attribute Table attributeTable, optionally classifying the attribute table by classificationColumn and setting the colors from ramp.

Additional Inherited Members
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)

QRgb	renderColorForNodataPixel () const
	Returns the color for the renderer to use to represent nodata pixels.

Protected Member Functions inherited from QgsRasterInterface
void	initHistogram (QgsRasterHistogram &histogram, int bandNo, int binCount, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &boundingBox=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false)
	Fill in histogram defaults if not specified.

Q_DECL_DEPRECATED void	initStatistics (QgsRasterBandStats &statistics, int bandNo, int stats, const QgsRectangle &boundingBox=QgsRectangle(), int binCount=0) const
	Fill in statistics defaults if not specified.

void	initStatistics (QgsRasterBandStats &statistics, int bandNo, Qgis::RasterBandStatistics stats=Qgis::RasterBandStatistic::All, const QgsRectangle &boundingBox=QgsRectangle(), int binCount=0) const
	Fill in statistics defaults if not specified.

Protected Attributes inherited from QgsRasterRenderer
int	mAlphaBand = -1
	Read alpha value from band.

QgsRasterMinMaxOrigin	mMinMaxOrigin
	Origin of min/max values.

double	mOpacity = 1.0
	Global alpha value (0-1)

QgsRasterTransparency *	mRasterTransparency = nullptr
	Raster transparency per color or value. Overwrites global alpha value.

QString	mType

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

QgsRasterInterface *	mInput = nullptr

bool	mOn = true

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

Detailed Description

Renderer for paletted raster images.

Definition at line 36 of file qgspalettedrasterrenderer.h.

Member Typedef Documentation

◆ ClassData

typedef QList< QgsPalettedRasterRenderer::Class > QgsPalettedRasterRenderer::ClassData

Map of value to class properties.

Definition at line 84 of file qgspalettedrasterrenderer.h.

◆ MultiValueClassData

typedef QList< QgsPalettedRasterRenderer::MultiValueClass > QgsPalettedRasterRenderer::MultiValueClassData

Map of multi value to class properties.

Definition at line 87 of file qgspalettedrasterrenderer.h.

Constructor & Destructor Documentation

◆ QgsPalettedRasterRenderer() [1/3]

QgsPalettedRasterRenderer::QgsPalettedRasterRenderer	(	QgsRasterInterface *	input,
		int	bandNumber,
		const ClassData &	classes
	)

Constructor for QgsPalettedRasterRenderer.

Definition at line 41 of file qgspalettedrasterrenderer.cpp.

◆ QgsPalettedRasterRenderer() [2/3]

QgsPalettedRasterRenderer::QgsPalettedRasterRenderer	(	QgsRasterInterface *	input,
		int	bandNumber,
		const MultiValueClassData &	classes
	)

Constructor for QgsPalettedRasterRenderer from multi value classes.

Since: QGIS 3.30

◆ QgsPalettedRasterRenderer() [3/3]

QgsPalettedRasterRenderer::QgsPalettedRasterRenderer ( const QgsPalettedRasterRenderer & )

delete

QgsPalettedRasterRenderer cannot be copied. Use clone() instead.

Member Function Documentation

◆ accept()

bool QgsPalettedRasterRenderer::accept ( QgsStyleEntityVisitorInterface * visitor ) const

overridevirtual

Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer.

Returns true if the visitor should continue visiting other objects, or false if visiting should be canceled.

Since: QGIS 3.10

Reimplemented from QgsRasterRenderer.

Definition at line 370 of file qgspalettedrasterrenderer.cpp.

◆ band()

int QgsPalettedRasterRenderer::band ( ) const

inline

Returns the raster band used for rendering the raster.

Definition at line 147 of file qgspalettedrasterrenderer.h.

◆ block()

QgsRasterBlock * QgsPalettedRasterRenderer::block	(	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. Added in QGIS 3.0.

Implements QgsRasterRenderer.

Definition at line 178 of file qgspalettedrasterrenderer.cpp.

◆ canCreateRasterAttributeTable()

bool QgsPalettedRasterRenderer::canCreateRasterAttributeTable ( ) const

overridevirtual

Returns true if the renderer is suitable for attribute table creation.

The default implementation returns false.

Since: QGIS 3.30

Reimplemented from QgsRasterRenderer.

Definition at line 825 of file qgspalettedrasterrenderer.cpp.

◆ classDataFromFile()

QgsPalettedRasterRenderer::ClassData QgsPalettedRasterRenderer::classDataFromFile ( const QString & path )

static

Opens a color table file and returns corresponding paletted renderer class data.

See also: classDataFromString()

Definition at line 595 of file qgspalettedrasterrenderer.cpp.

◆ classDataFromRaster()

QgsPalettedRasterRenderer::ClassData QgsPalettedRasterRenderer::classDataFromRaster	(	QgsRasterInterface *	raster,
		int	bandNumber,
		QgsColorRamp *	ramp = `nullptr`,
		QgsRasterBlockFeedback *	feedback = `nullptr`
	)

static

Generates class data from a raster, for the specified bandNumber.

An optional color ramp can be specified to automatically assign colors from the ramp.

Definition at line 627 of file qgspalettedrasterrenderer.cpp.

◆ classDataFromString()

QgsPalettedRasterRenderer::ClassData QgsPalettedRasterRenderer::classDataFromString ( const QString & string )

static

Converts a string containing a color table or class data to to paletted renderer class data.

See also: classDataFromFile(); classDataToString()

Definition at line 516 of file qgspalettedrasterrenderer.cpp.

◆ classDataToString()

QString QgsPalettedRasterRenderer::classDataToString ( const QgsPalettedRasterRenderer::ClassData & classes )

static

Converts classes to a string representation, using the .clr/gdal color table file format.

See also: classDataFromString()

Definition at line 608 of file qgspalettedrasterrenderer.cpp.

◆ classes()

QgsPalettedRasterRenderer::ClassData QgsPalettedRasterRenderer::classes ( ) const

Returns a map of value to classes (colors) used by the renderer.

Definition at line 134 of file qgspalettedrasterrenderer.cpp.

◆ clone()

QgsPalettedRasterRenderer * QgsPalettedRasterRenderer::clone ( ) const

overridevirtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 71 of file qgspalettedrasterrenderer.cpp.

◆ colorTableToClassData()

QgsPalettedRasterRenderer::ClassData QgsPalettedRasterRenderer::colorTableToClassData ( const QList< QgsColorRampShader::ColorRampItem > & table )

static

Converts a raster color table to paletted renderer class data.

Definition at line 454 of file qgspalettedrasterrenderer.cpp.

◆ create()

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

static

Definition at line 89 of file qgspalettedrasterrenderer.cpp.

◆ createLegendNodes()

QList< QgsLayerTreeModelLegendNode * > QgsPalettedRasterRenderer::createLegendNodes ( QgsLayerTreeLayer * nodeLayer )

overridevirtual

Creates a set of legend nodes representing the renderer.

The default implementation calls legendSymbologyItems() and creates corresponding legend nodes for each returned symbology item.

Subclasses can override this to return more legend nodes which better represent the renderer.

Since: QGIS 3.18

Reimplemented from QgsRasterRenderer.

Definition at line 413 of file qgspalettedrasterrenderer.cpp.

◆ flags()

Qgis::RasterRendererFlags QgsPalettedRasterRenderer::flags ( ) const

overridevirtual

Returns flags which dictate renderer behavior.

Since: QGIS 3.28

Reimplemented from QgsRasterRenderer.

Definition at line 84 of file qgspalettedrasterrenderer.cpp.

◆ label()

QString QgsPalettedRasterRenderer::label ( double idx ) const

Returns optional category label.

Definition at line 150 of file qgspalettedrasterrenderer.cpp.

◆ legendSymbologyItems()

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

overridevirtual

Returns symbology items if provided by renderer.

See also: createLegendNodes()

Reimplemented from QgsRasterRenderer.

Definition at line 382 of file qgspalettedrasterrenderer.cpp.

◆ multiValueClasses()

QgsPalettedRasterRenderer::MultiValueClassData QgsPalettedRasterRenderer::multiValueClasses ( ) const

Returns a map of multi value to classes (colors) used by the renderer.

Since: QGIS 3.30

Definition at line 139 of file qgspalettedrasterrenderer.cpp.

◆ nColors()

int QgsPalettedRasterRenderer::nColors ( ) const

Returns number of colors.

Definition at line 273 of file qgspalettedrasterrenderer.cpp.

◆ operator=()

const QgsPalettedRasterRenderer & QgsPalettedRasterRenderer::operator= ( const QgsPalettedRasterRenderer & )

delete

QgsPalettedRasterRenderer cannot be copied. Use clone() instead.

◆ rasterAttributeTableToClassData()

QgsPalettedRasterRenderer::MultiValueClassData QgsPalettedRasterRenderer::rasterAttributeTableToClassData	(	const QgsRasterAttributeTable *	attributeTable,
		int	classificationColumn = `-1`,
		QgsColorRamp *	ramp = `nullptr`
	)

static

Reads and returns classes from the Raster Attribute Table attributeTable, optionally classifying the attribute table by classificationColumn and setting the colors from ramp.

The default value of -1 for the classificationColumn uses the first available value column.

Note: The method will return an empty list of classes in case the Raster Attribute Table is not thematic.

Since: QGIS 3.30

Definition at line 465 of file qgspalettedrasterrenderer.cpp.

◆ setLabel()

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

Set category label.

Definition at line 165 of file qgspalettedrasterrenderer.cpp.

◆ setMultiValueClasses()

void QgsPalettedRasterRenderer::setMultiValueClasses ( const MultiValueClassData & classes )

Sets the multi value classes to setMultiValueClasses.

Since: QGIS 3.30

Definition at line 144 of file qgspalettedrasterrenderer.cpp.

◆ setSourceColorRamp()

void QgsPalettedRasterRenderer::setSourceColorRamp ( QgsColorRamp * ramp )

Set the source color ramp.

Ownership is transferred to the renderer.

See also: sourceColorRamp()

Definition at line 444 of file qgspalettedrasterrenderer.cpp.

◆ sourceColorRamp()

QgsColorRamp * QgsPalettedRasterRenderer::sourceColorRamp ( ) const

Gets the source color ramp.

See also: setSourceColorRamp()

Definition at line 449 of file qgspalettedrasterrenderer.cpp.

◆ toSld()

void QgsPalettedRasterRenderer::toSld	(	QDomDocument &	doc,
		QDomElement &	element,
		const QVariantMap &	props = `QVariantMap()`
	)		const

overridevirtual

Used from subclasses to create SLD Rule elements following SLD v1.0 specs.

Since: QGIS 3.6

Reimplemented from QgsRasterRenderer.

Definition at line 317 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 434 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 278 of file qgspalettedrasterrenderer.cpp.

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

/build/qgis-3.36.0+99sid/src/core/raster/qgspalettedrasterrenderer.h
/build/qgis-3.36.0+99sid/src/core/raster/qgspalettedrasterrenderer.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ClassData

◆ MultiValueClassData

Constructor & Destructor Documentation

◆ QgsPalettedRasterRenderer() [1/3]

◆ QgsPalettedRasterRenderer() [2/3]

◆ QgsPalettedRasterRenderer() [3/3]

Member Function Documentation

◆ accept()

◆ band()

◆ block()

◆ canCreateRasterAttributeTable()

◆ classDataFromFile()

◆ classDataFromRaster()

◆ classDataFromString()

◆ classDataToString()

◆ classes()

◆ clone()

◆ colorTableToClassData()

◆ create()

◆ createLegendNodes()

◆ flags()

◆ label()

◆ legendSymbologyItems()

◆ multiValueClasses()

◆ nColors()

◆ operator=()

◆ rasterAttributeTableToClassData()

◆ setLabel()

◆ setMultiValueClasses()

◆ setSourceColorRamp()

◆ sourceColorRamp()

◆ toSld()

◆ usesBands()

◆ writeXml()