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

#include <qgssinglebandpseudocolorrenderer.h>

Inheritance diagram for QgsSingleBandPseudoColorRenderer:

[legend]

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

	QgsSingleBandPseudoColorRenderer (QgsRasterInterface input, int band=-1, QgsRasterShader shader=nullptr)
	Note: takes ownership of QgsRasterShader.

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

Q_DECL_DEPRECATED int	band () const
	Returns the band used by the renderer.

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.

double	classificationMax () const

double	classificationMin () const

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

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

void	createShader (QgsColorRamp *colorRamp=nullptr, Qgis::ShaderInterpolationMethod colorRampType=Qgis::ShaderInterpolationMethod::Linear, Qgis::ShaderClassificationMethod classificationMode=Qgis::ShaderClassificationMethod::Continuous, int classes=0, bool clip=false, const QgsRectangle &extent=QgsRectangle())
	Creates a color ramp shader.

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

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

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

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

Q_DECL_DEPRECATED void	setBand (int bandNo)
	Sets the band used by the renderer.

void	setClassificationMax (double max)

void	setClassificationMin (double min)

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

void	setShader (QgsRasterShader *shader)
	Takes ownership of the shader.

QgsRasterShader *	shader ()
	Returns the raster shader.

const QgsRasterShader *	shader () const

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

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

Raster renderer pipe for single band pseudocolor.

Definition at line 34 of file qgssinglebandpseudocolorrenderer.h.

Constructor & Destructor Documentation

◆ QgsSingleBandPseudoColorRenderer() [1/2]

QgsSingleBandPseudoColorRenderer::QgsSingleBandPseudoColorRenderer	(	QgsRasterInterface *	input,
		int	band = `-1`,
		QgsRasterShader *	shader = `nullptr`
	)

Note: takes ownership of QgsRasterShader.

Definition at line 30 of file qgssinglebandpseudocolorrenderer.cpp.

◆ QgsSingleBandPseudoColorRenderer() [2/2]

QgsSingleBandPseudoColorRenderer::QgsSingleBandPseudoColorRenderer ( const QgsSingleBandPseudoColorRenderer & )

delete

QgsSingleBandPseudoColorRenderer cannot be copied. Use clone() instead.

Member Function Documentation

◆ accept()

bool QgsSingleBandPseudoColorRenderer::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 430 of file qgssinglebandpseudocolorrenderer.cpp.

◆ band()

Q_DECL_DEPRECATED int QgsSingleBandPseudoColorRenderer::band ( ) const

inline

Returns the band used by the renderer.

Deprecated:: QGIS 3.38. Use inputBand() instead.

Definition at line 92 of file qgssinglebandpseudocolorrenderer.h.

◆ block()

QgsRasterBlock * QgsSingleBandPseudoColorRenderer::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 209 of file qgssinglebandpseudocolorrenderer.cpp.

◆ canCreateRasterAttributeTable()

bool QgsSingleBandPseudoColorRenderer::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 491 of file qgssinglebandpseudocolorrenderer.cpp.

◆ classificationMax()

double QgsSingleBandPseudoColorRenderer::classificationMax ( ) const

inline

Definition at line 106 of file qgssinglebandpseudocolorrenderer.h.

◆ classificationMin()

double QgsSingleBandPseudoColorRenderer::classificationMin ( ) const

inline

Definition at line 105 of file qgssinglebandpseudocolorrenderer.h.

◆ clone()

QgsSingleBandPseudoColorRenderer * QgsSingleBandPseudoColorRenderer::clone ( ) const

overridevirtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 90 of file qgssinglebandpseudocolorrenderer.cpp.

◆ create()

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

static

Definition at line 139 of file qgssinglebandpseudocolorrenderer.cpp.

◆ createLegendNodes()

QList< QgsLayerTreeModelLegendNode * > QgsSingleBandPseudoColorRenderer::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 442 of file qgssinglebandpseudocolorrenderer.cpp.

◆ createShader()

void QgsSingleBandPseudoColorRenderer::createShader	(	QgsColorRamp *	colorRamp = `nullptr`,
		Qgis::ShaderInterpolationMethod	colorRampType = `Qgis::ShaderInterpolationMethod::Linear`,
		Qgis::ShaderClassificationMethod	classificationMode = `Qgis::ShaderClassificationMethod::Continuous`,
		int	classes = `0`,
		bool	clip = `false`,
		const QgsRectangle &	extent = `QgsRectangle()`
	)

Creates a color ramp shader.

Parameters

colorRamp	vector color ramp. Ownership is transferred to the shader.
colorRampType	type of color ramp shader
classificationMode	classification mode
classes	number of classes
clip	clip out of range values
extent	extent used in classification (only used in quantile mode)

Definition at line 123 of file qgssinglebandpseudocolorrenderer.cpp.

◆ flags()

Qgis::RasterRendererFlags QgsSingleBandPseudoColorRenderer::flags ( ) const

overridevirtual

Returns flags which dictate renderer behavior.

Since: QGIS 3.28

Reimplemented from QgsRasterRenderer.

Definition at line 113 of file qgssinglebandpseudocolorrenderer.cpp.

◆ inputBand()

int QgsSingleBandPseudoColorRenderer::inputBand ( ) const

overridevirtual

Returns the input band for the renderer, or -1 if no input band is available.

For renderers which utilize multiple input bands -1 will be returned. In these cases usesBands() will return a list of all utilized bands (including alpha bands).

See also: setInputBand(); usesBands()

Since: QGIS 3.38

Reimplemented from QgsRasterRenderer.

Definition at line 44 of file qgssinglebandpseudocolorrenderer.cpp.

◆ legendSymbologyItems()

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

overridevirtual

Returns symbology items if provided by renderer.

See also: createLegendNodes()

Reimplemented from QgsRasterRenderer.

Definition at line 332 of file qgssinglebandpseudocolorrenderer.cpp.

◆ operator=()

const QgsSingleBandPseudoColorRenderer & QgsSingleBandPseudoColorRenderer::operator= ( const QgsSingleBandPseudoColorRenderer & )

delete

QgsSingleBandPseudoColorRenderer cannot be copied. Use clone() instead.

◆ setBand()

void QgsSingleBandPseudoColorRenderer::setBand ( int bandNo )

Sets the band used by the renderer.

See also: band

Deprecated:: QGIS 3.38. Use setInputBand() instead.

Definition at line 39 of file qgssinglebandpseudocolorrenderer.cpp.

◆ setClassificationMax()

void QgsSingleBandPseudoColorRenderer::setClassificationMax ( double max )

Definition at line 77 of file qgssinglebandpseudocolorrenderer.cpp.

◆ setClassificationMin()

void QgsSingleBandPseudoColorRenderer::setClassificationMin ( double min )

Definition at line 64 of file qgssinglebandpseudocolorrenderer.cpp.

◆ setInputBand()

bool QgsSingleBandPseudoColorRenderer::setInputBand ( int band )

overridevirtual

Attempts to set the input band for the renderer.

Returns true if the band was successfully set, or false if the band could not be set.

Note: Not all renderers support setting the input band.

See also: inputBand(); usesBands()

Since: QGIS 3.38

Reimplemented from QgsRasterRenderer.

Definition at line 49 of file qgssinglebandpseudocolorrenderer.cpp.

◆ setShader()

void QgsSingleBandPseudoColorRenderer::setShader ( QgsRasterShader * shader )

Takes ownership of the shader.

Definition at line 118 of file qgssinglebandpseudocolorrenderer.cpp.

◆ shader() [1/2]

QgsRasterShader * QgsSingleBandPseudoColorRenderer::shader ( )

inline

Returns the raster shader.

Definition at line 57 of file qgssinglebandpseudocolorrenderer.h.

◆ shader() [2/2]

const QgsRasterShader * QgsSingleBandPseudoColorRenderer::shader ( ) const

inline

Note: available in Python as constShader

Definition at line 60 of file qgssinglebandpseudocolorrenderer.h.

◆ toSld()

void QgsSingleBandPseudoColorRenderer::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 356 of file qgssinglebandpseudocolorrenderer.cpp.

◆ usesBands()

QList< int > QgsSingleBandPseudoColorRenderer::usesBands ( ) const

overridevirtual

Returns a list of band numbers used by the renderer.

See also: setInputBand()

Reimplemented from QgsRasterRenderer.

Definition at line 346 of file qgssinglebandpseudocolorrenderer.cpp.

◆ writeXml()

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

overridevirtual

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 312 of file qgssinglebandpseudocolorrenderer.cpp.

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

/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/raster/qgssinglebandpseudocolorrenderer.h
/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/raster/qgssinglebandpseudocolorrenderer.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSingleBandPseudoColorRenderer() [1/2]

◆ QgsSingleBandPseudoColorRenderer() [2/2]

Member Function Documentation

◆ accept()

◆ band()

◆ block()

◆ canCreateRasterAttributeTable()

◆ classificationMax()

◆ classificationMin()

◆ clone()

◆ create()

◆ createLegendNodes()

◆ createShader()

◆ flags()

◆ inputBand()

◆ legendSymbologyItems()

◆ operator=()

◆ setBand()

◆ setClassificationMax()

◆ setClassificationMin()

◆ setInputBand()

◆ setShader()

◆ shader() [1/2]

◆ shader() [2/2]

◆ toSld()

◆ usesBands()

◆ writeXml()