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

#include <qgssinglebandpseudocolorrenderer.h>

Inheritance diagram for QgsSingleBandPseudoColorRenderer:

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

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

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

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

double	classificationMax () const

double	classificationMin () const

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

void	createShader (QgsColorRamp *colorRamp=nullptr, QgsColorRampShader::Type colorRampType=QgsColorRampShader::Interpolated, QgsColorRampShader::ClassificationMode classificationMode=QgsColorRampShader::Continuous, int classes=0, bool clip=false, const QgsRectangle &extent=QgsRectangle())
	Creates a color ramp shader. More...

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

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

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

void	setClassificationMax (double max)

void	setClassificationMin (double min)

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

QgsRasterShader *	shader ()
	Returns the raster shader. More...

const QgsRasterShader *	shader () const

void	toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props=QgsStringMap()) const override
	Used from subclasses to create SLD Rule elements following SLD v1.0 specs. 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=QString())
	Constructor for QgsRasterRenderer. More...

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

	~QgsRasterRenderer () override

int	alphaBand () const

int	bandCount () const override
	Gets number of bands. More...

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

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

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

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

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

const QgsRasterTransparency *	rasterTransparency () const

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

void	setAlphaBand (int band)

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

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

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

void	setRasterTransparency (QgsRasterTransparency *t)

virtual QString	type () const

bool	usesTransparency () const

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

virtual	~QgsRasterInterface ()=default

virtual QgsRasterBandStats	bandStatistics (int bandNo, int stats=QgsRasterBandStats::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
	Returns the 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 bandNo, double lowerCount, double upperCount, double &lowerValue, double &upperValue, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
	Find values for cumulative pixel count cut. More...

int	dataTypeSize (int bandNo)

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual int	yBlockSize () const

virtual int	ySize () const

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

Additional Inherited Members
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 &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. More...

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

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

QgsRasterMinMaxOrigin	mMinMaxOrigin
	Origin of min/max values. More...

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

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

QString	mType

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

QgsRasterInterface *	mInput = nullptr

bool	mOn = true

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

Detailed Description

Raster renderer pipe for single band pseudocolor.

Definition at line 35 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 29 of file qgssinglebandpseudocolorrenderer.cpp.

◆ QgsSingleBandPseudoColorRenderer() [2/2]

QgsSingleBandPseudoColorRenderer::QgsSingleBandPseudoColorRenderer ( const QgsSingleBandPseudoColorRenderer & )

delete

QgsSingleBandPseudoColorRenderer cannot be copied. Use clone() instead.

Member Function Documentation

◆ band()

int QgsSingleBandPseudoColorRenderer::band ( ) const

inline

Returns the band used by the renderer.

Since: QGIS 2.7

Definition at line 91 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 cancelation/preview. Added in QGIS 3.0.

Implements QgsRasterRenderer.

Definition at line 196 of file qgssinglebandpseudocolorrenderer.cpp.

◆ classificationMax()

double QgsSingleBandPseudoColorRenderer::classificationMax ( ) const

inline

Definition at line 101 of file qgssinglebandpseudocolorrenderer.h.

◆ classificationMin()

double QgsSingleBandPseudoColorRenderer::classificationMin ( ) const

inline

Definition at line 100 of file qgssinglebandpseudocolorrenderer.h.

◆ clone()

QgsSingleBandPseudoColorRenderer * QgsSingleBandPseudoColorRenderer::clone ( ) const

overridevirtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 73 of file qgssinglebandpseudocolorrenderer.cpp.

◆ create()

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

static

Definition at line 126 of file qgssinglebandpseudocolorrenderer.cpp.

◆ createShader()

void QgsSingleBandPseudoColorRenderer::createShader	(	QgsColorRamp *	colorRamp = `nullptr`,
		QgsColorRampShader::Type	colorRampType = `QgsColorRampShader::Interpolated`,
		QgsColorRampShader::ClassificationMode	classificationMode = `QgsColorRampShader::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)