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

#include <qgsmultibandcolorrenderer.h>

Inheritance diagram for QgsMultiBandColorRenderer:

[legend]

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

	QgsMultiBandColorRenderer (QgsRasterInterface input, int redBand, int greenBand, int blueBand, QgsContrastEnhancement redEnhancement=nullptr, QgsContrastEnhancement greenEnhancement=nullptr, QgsContrastEnhancement blueEnhancement=nullptr)
	Constructor for QgsMultiBandColorRenderer.

	~QgsMultiBandColorRenderer () override

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

int	blueBand () const
	Returns the band number for the blue channel.

const QgsContrastEnhancement *	blueContrastEnhancement () const
	Returns the contrast enhancement to use for the blue channel.

QgsMultiBandColorRenderer *	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.

int	greenBand () const
	Returns the band number for the green channel.

const QgsContrastEnhancement *	greenContrastEnhancement () const
	Returns the contrast enhancement to use for the green channel.

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

int	redBand () const
	Returns the band number for the red channel.

const QgsContrastEnhancement *	redContrastEnhancement () const
	Returns the contrast enhancement to use for the red channel.

bool	refresh (const QgsRectangle &extent, const QList< double > &min, const QList< double > &max, bool forceRefresh=false) override
	Refreshes the renderer according to the min and max values associated with the extent.

void	setBlueBand (int band)
	Sets the band number for the blue channel.

void	setBlueContrastEnhancement (QgsContrastEnhancement *ce)
	Sets the contrast enhancement to use for the blue channel.

void	setGreenBand (int band)
	Sets the band number for the green channel.

void	setGreenContrastEnhancement (QgsContrastEnhancement *ce)
	Sets the contrast enhancement to use for the green channel.

void	setRedBand (int band)
	Sets the band number for the red channel.

void	setRedContrastEnhancement (QgsContrastEnhancement *ce)
	Sets the contrast enhancement to use for the red channel.

Q_DECL_DEPRECATED 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.

bool	toSld (QDomDocument &doc, QDomElement &element, QgsSldExportContext &context) 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

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

int	alphaBand () const

int	bandCount () const override
	Gets number of bands.

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

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.

virtual int	inputBand () const
	Returns the input band for the renderer, or -1 if no input band is available.

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

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

bool	needsRefresh (const QgsRectangle &extent) const
	Checks if the renderer needs to be refreshed according to extent.

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.

virtual bool	setInputBand (int band)
	Attempts to set the input band for the renderer.

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 Qgis::RasterInterfaceCapabilities	capabilities () const
	Returns the capabilities supported by the interface.

Q_DECL_DEPRECATED 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 QgsRasterRenderer *	create (const QDomElement &elem, QgsRasterInterface *input)

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.

QgsRectangle	mLastRectangleUsedByRefreshContrastEnhancementIfNeeded
	To save computations and possible infinite cycle of notifications.

QgsRasterMinMaxOrigin	mMinMaxOrigin
	Origin of min/max values.

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

std::unique_ptr< QgsRasterTransparency >	mRasterTransparency
	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 multiband images with the color components.

Definition at line 32 of file qgsmultibandcolorrenderer.h.

Constructor & Destructor Documentation

◆ QgsMultiBandColorRenderer() [1/2]

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

Constructor for QgsMultiBandColorRenderer.

Parameters

input	input raster interface
redBand	band number for red channel
greenBand	band number for green channel
blueBand	band number for blue channel
redEnhancement	optional contrast enhancement for red channel. Ownership is transferred to the renderer.
greenEnhancement	optional contrast enhancement for green channel. Ownership is transferred to the renderer.
blueEnhancement	optional contrast enhancement for blue channel. Ownership is transferred to the renderer.

Definition at line 29 of file qgsmultibandcolorrenderer.cpp.

◆ ~QgsMultiBandColorRenderer()

QgsMultiBandColorRenderer::~QgsMultiBandColorRenderer ( )

overridedefault

◆ QgsMultiBandColorRenderer() [2/2]

QgsMultiBandColorRenderer::QgsMultiBandColorRenderer ( const QgsMultiBandColorRenderer & )

delete

QgsMultiBandColorRenderer cannot be copied. Use clone() instead.

Member Function Documentation

◆ block()

QgsRasterBlock * QgsMultiBandColorRenderer::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 151 of file qgsmultibandcolorrenderer.cpp.

◆ blueBand()

int QgsMultiBandColorRenderer::blueBand ( ) const

inline

Returns the band number for the blue channel.

See also: setRedBand()

Definition at line 97 of file qgsmultibandcolorrenderer.h.

◆ blueContrastEnhancement()

const QgsContrastEnhancement * QgsMultiBandColorRenderer::blueContrastEnhancement ( ) const

Returns the contrast enhancement to use for the blue channel.

See also: setBlueContrastEnhancement(); redContrastEnhancement(); greenContrastEnhancement()

Definition at line 92 of file qgsmultibandcolorrenderer.cpp.

◆ clone()

QgsMultiBandColorRenderer * QgsMultiBandColorRenderer::clone ( ) const

overridevirtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 45 of file qgsmultibandcolorrenderer.cpp.

◆ create()

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

static

Definition at line 105 of file qgsmultibandcolorrenderer.cpp.

◆ createLegendNodes()

QList< QgsLayerTreeModelLegendNode * > QgsMultiBandColorRenderer::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 473 of file qgsmultibandcolorrenderer.cpp.

◆ flags()

Qgis::RasterRendererFlags QgsMultiBandColorRenderer::flags ( ) const

overridevirtual

Returns flags which dictate renderer behavior.

Since: QGIS 3.28

Reimplemented from QgsRasterRenderer.

Definition at line 66 of file qgsmultibandcolorrenderer.cpp.

◆ greenBand()

int QgsMultiBandColorRenderer::greenBand ( ) const

inline

Returns the band number for the green channel.

See also: setRedBand()

Definition at line 83 of file qgsmultibandcolorrenderer.h.

◆ greenContrastEnhancement()

const QgsContrastEnhancement * QgsMultiBandColorRenderer::greenContrastEnhancement ( ) const

Returns the contrast enhancement to use for the green channel.

See also: setGreenContrastEnhancement(); redContrastEnhancement(); blueContrastEnhancement()

Definition at line 79 of file qgsmultibandcolorrenderer.cpp.

◆ operator=()

const QgsMultiBandColorRenderer & QgsMultiBandColorRenderer::operator= ( const QgsMultiBandColorRenderer & )

delete

QgsMultiBandColorRenderer cannot be copied. Use clone() instead.

◆ redBand()

int QgsMultiBandColorRenderer::redBand ( ) const

inline

Returns the band number for the red channel.

See also: setRedBand()

Definition at line 69 of file qgsmultibandcolorrenderer.h.

◆ redContrastEnhancement()

const QgsContrastEnhancement * QgsMultiBandColorRenderer::redContrastEnhancement ( ) const

Returns the contrast enhancement to use for the red channel.

See also: setRedContrastEnhancement(); greenContrastEnhancement(); blueContrastEnhancement()

Definition at line 415 of file qgsmultibandcolorrenderer.cpp.

◆ refresh()

bool QgsMultiBandColorRenderer::refresh	(	const QgsRectangle &	extent,
		const QList< double > &	min,
		const QList< double > &	max,
		bool	forceRefresh = `false`
	)

overridevirtual

Refreshes the renderer according to the min and max values associated with the extent.

min and max size need to be at least 3. If min or max size is greater than 3, the last values are ignored. The first value is associated with the red contrast. The second value is associated with the green contrast. The third value is associated with the blue contrast. NaN values are ignored. If forceRefresh is true, this will force the refresh even if needsRefresh() returns false.

Returns: true if the renderer has been refreshed

Note: not available in Python bindings

Since: QGIS 3.42

Reimplemented from QgsRasterRenderer.

Definition at line 618 of file qgsmultibandcolorrenderer.cpp.

◆ setBlueBand()

void QgsMultiBandColorRenderer::setBlueBand ( int band )

inline

Sets the band number for the blue channel.

See also: blueBand()

Definition at line 104 of file qgsmultibandcolorrenderer.h.

◆ setBlueContrastEnhancement()

void QgsMultiBandColorRenderer::setBlueContrastEnhancement ( QgsContrastEnhancement * ce )

Sets the contrast enhancement to use for the blue channel.

Ownership of the enhancement is transferred.

See also: blueContrastEnhancement(); setRedContrastEnhancement(); setGreenContrastEnhancement()

Definition at line 97 of file qgsmultibandcolorrenderer.cpp.

◆ setGreenBand()

void QgsMultiBandColorRenderer::setGreenBand ( int band )

inline

Sets the band number for the green channel.

See also: greenBand()

Definition at line 90 of file qgsmultibandcolorrenderer.h.

◆ setGreenContrastEnhancement()

void QgsMultiBandColorRenderer::setGreenContrastEnhancement ( QgsContrastEnhancement * ce )

Sets the contrast enhancement to use for the green channel.

Ownership of the enhancement is transferred.

See also: greenContrastEnhancement(); setRedContrastEnhancement(); setBlueContrastEnhancement()

Definition at line 84 of file qgsmultibandcolorrenderer.cpp.

◆ setRedBand()

void QgsMultiBandColorRenderer::setRedBand ( int band )

inline

Sets the band number for the red channel.

See also: redBand()

Definition at line 76 of file qgsmultibandcolorrenderer.h.

◆ setRedContrastEnhancement()

void QgsMultiBandColorRenderer::setRedContrastEnhancement ( QgsContrastEnhancement * ce )

Sets the contrast enhancement to use for the red channel.

Ownership of the enhancement is transferred.

See also: redContrastEnhancement(); setGreenContrastEnhancement(); setBlueContrastEnhancement()

Definition at line 71 of file qgsmultibandcolorrenderer.cpp.

◆ toSld() [1/2]

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

overridevirtual

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

Deprecated:: QGIS 3.44. Use the version with QgsSldExportContext instead.

Reimplemented from QgsRasterRenderer.

Definition at line 492 of file qgsmultibandcolorrenderer.cpp.

◆ toSld() [2/2]

bool QgsMultiBandColorRenderer::toSld	(	QDomDocument &	doc,
		QDomElement &	element,
		QgsSldExportContext &	context
	)		const

overridevirtual

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

Since: QGIS 3.44

Reimplemented from QgsRasterRenderer.

Definition at line 499 of file qgsmultibandcolorrenderer.cpp.

◆ usesBands()

QList< int > QgsMultiBandColorRenderer::usesBands ( ) const

overridevirtual

Returns a list of band numbers used by the renderer.

See also: setInputBand()

Reimplemented from QgsRasterRenderer.

Definition at line 455 of file qgsmultibandcolorrenderer.cpp.

◆ writeXml()

void QgsMultiBandColorRenderer::writeXml	(	QDomDocument &	doc,
		QDomElement &	parentElem
	)		const

overridevirtual

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 420 of file qgsmultibandcolorrenderer.cpp.

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

/build/qgis-3.43.0+git20250516+ac9f54ad1f7+99sid/src/core/raster/qgsmultibandcolorrenderer.h
/build/qgis-3.43.0+git20250516+ac9f54ad1f7+99sid/src/core/raster/qgsmultibandcolorrenderer.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsMultiBandColorRenderer() [1/2]

◆ ~QgsMultiBandColorRenderer()

◆ QgsMultiBandColorRenderer() [2/2]

Member Function Documentation

◆ block()

◆ blueBand()

◆ blueContrastEnhancement()

◆ clone()

◆ create()

◆ createLegendNodes()

◆ flags()

◆ greenBand()

◆ greenContrastEnhancement()

◆ operator=()

◆ redBand()

◆ redContrastEnhancement()

◆ refresh()

◆ setBlueBand()

◆ setBlueContrastEnhancement()

◆ setGreenBand()

◆ setGreenContrastEnhancement()

◆ setRedBand()

◆ setRedContrastEnhancement()

◆ toSld() [1/2]

◆ toSld() [2/2]

◆ usesBands()

◆ writeXml()