Raster renderer pipe that applies colors to a raster. More...

#include <qgsrasterrenderer.h>

Inheritance diagram for QgsRasterRenderer:

[legend]

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

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

virtual	~QgsRasterRenderer ()

int	alphaBand () const

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

QgsRasterRenderer *	clone () const override=0
	Clone itself, create deep copy. 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...

virtual void	legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const
	Get symbology items if provided by renderer. 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

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

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 QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height)=0
	Read block of data using given extent and size. More...

virtual QgsRasterBlock *	block2 (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr)
	Read block of data using given extent and size. 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 void	writeXML (QDomDocument &doc, QDomElement &parentElem) const
	Write base class members to xml. More...

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 int	minMaxOriginFromName (const QString &theName)

static QString	minMaxOriginLabel (int theOrigin)

static QString	minMaxOriginName (int theOrigin)

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

Protected Member Functions
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
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

Raster renderer pipe that applies colors to a raster.

Definition at line 34 of file qgsrasterrenderer.h.

Member Enumeration Documentation

◆ MinMaxOrigin

enum QgsRasterRenderer::MinMaxOrigin

Enumerator
MinMaxUnknown
MinMaxUser
MinMaxMinMax
MinMaxCumulativeCut
MinMaxStdDev
MinMaxFullExtent
MinMaxSubExtent
MinMaxEstimated
MinMaxExact

Definition at line 41 of file qgsrasterrenderer.h.

Constructor & Destructor Documentation

◆ QgsRasterRenderer()

QgsRasterRenderer::QgsRasterRenderer	(	QgsRasterInterface *	input = `nullptr`,
		const QString &	type = `""`
	)

Definition at line 30 of file qgsrasterrenderer.cpp.

◆ ~QgsRasterRenderer()

QgsRasterRenderer::~QgsRasterRenderer ( )

virtual

Definition at line 37 of file qgsrasterrenderer.cpp.

Member Function Documentation

◆ _writeXML()

void QgsRasterRenderer::_writeXML	(	QDomDocument &	doc,
		QDomElement &	rasterRendererElem
	)		const

protected

Write upper class info into rasterrenderer element (called by writeXML method of subclasses)

Definition at line 100 of file qgsrasterrenderer.cpp.

◆ alphaBand()

int QgsRasterRenderer::alphaBand ( ) const

inline

Definition at line 81 of file qgsrasterrenderer.h.

◆ bandCount()

int QgsRasterRenderer::bandCount ( ) const

overridevirtual

Get number of bands.

Implements QgsRasterInterface.

Definition at line 42 of file qgsrasterrenderer.cpp.

◆ clone()

QgsRasterRenderer* QgsRasterRenderer::clone ( ) const

overridepure virtual

Clone itself, create deep copy.

Implements QgsRasterInterface.

Implemented in QgsHillshadeRenderer, QgsSingleBandGrayRenderer, QgsPalettedRasterRenderer, QgsMultiBandColorRenderer, QgsSingleBandPseudoColorRenderer, and QgsSingleBandColorDataRenderer.

◆ copyCommonProperties()

void QgsRasterRenderer::copyCommonProperties ( const QgsRasterRenderer * other )

Copies common properties like opacity / transparency data from other renderer.

Useful when cloning renderers.

Note: added in 2.16

Definition at line 137 of file qgsrasterrenderer.cpp.

◆ dataType()

QGis::DataType QgsRasterRenderer::dataType ( int bandNo ) const

overridevirtual

Returns data type for the band specified by number.

Implements QgsRasterInterface.

Definition at line 51 of file qgsrasterrenderer.cpp.

◆ legendSymbologyItems()

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

inlinevirtual

Get symbology items if provided by renderer.

Reimplemented in QgsPalettedRasterRenderer, QgsSingleBandGrayRenderer, and QgsSingleBandPseudoColorRenderer.

Definition at line 84 of file qgsrasterrenderer.h.

◆ minMaxOriginFromName()

int QgsRasterRenderer::minMaxOriginFromName ( const QString & theName )

static

Definition at line 247 of file qgsrasterrenderer.cpp.

◆ minMaxOriginLabel()

QString QgsRasterRenderer::minMaxOriginLabel ( int theOrigin )

static

Definition at line 192 of file qgsrasterrenderer.cpp.

◆ minMaxOriginName()

QString QgsRasterRenderer::minMaxOriginName ( int theOrigin )

static

Definition at line 147 of file qgsrasterrenderer.cpp.

◆ opacity()

double QgsRasterRenderer::opacity ( ) const

inline

Definition at line 75 of file qgsrasterrenderer.h.

◆ rasterTransparency()

const QgsRasterTransparency* QgsRasterRenderer::rasterTransparency ( ) const

inline

Definition at line 78 of file qgsrasterrenderer.h.

◆ readXML()

void QgsRasterRenderer::readXML ( const QDomElement & rendererElem )

overridevirtual

Sets base class members from xml.

Usually called from create() methods of subclasses

Reimplemented from QgsRasterInterface.

Definition at line 117 of file qgsrasterrenderer.cpp.

◆ setAlphaBand()

void QgsRasterRenderer::setAlphaBand ( int band )

inline

Definition at line 80 of file qgsrasterrenderer.h.

◆ setInput()

bool QgsRasterRenderer::setInput ( QgsRasterInterface * input )

overridevirtual

Set input.

Returns true if set correctly, false if cannot use that input

Reimplemented from QgsRasterInterface.

Reimplemented in QgsSingleBandColorDataRenderer.

Definition at line 62 of file qgsrasterrenderer.cpp.

◆ setOpacity()

void QgsRasterRenderer::setOpacity ( double opacity )

inline

Definition at line 74 of file qgsrasterrenderer.h.

◆ setRasterTransparency()

void QgsRasterRenderer::setRasterTransparency ( QgsRasterTransparency * t )

Definition at line 94 of file qgsrasterrenderer.cpp.

◆ type()

virtual QString QgsRasterRenderer::type ( ) const

inlinevirtual

Definition at line 68 of file qgsrasterrenderer.h.

◆ usesBands()

virtual QList<int> QgsRasterRenderer::usesBands ( ) const

inlinevirtual

Returns a list of band numbers used by the renderer.

Reimplemented in QgsPalettedRasterRenderer, QgsMultiBandColorRenderer, QgsHillshadeRenderer, QgsSingleBandGrayRenderer, QgsSingleBandPseudoColorRenderer, and QgsSingleBandColorDataRenderer.

Definition at line 95 of file qgsrasterrenderer.h.

◆ usesTransparency()

bool QgsRasterRenderer::usesTransparency ( ) const

Definition at line 85 of file qgsrasterrenderer.cpp.

Member Data Documentation

◆ mAlphaBand

int QgsRasterRenderer::mAlphaBand

protected

Read alpha value from band.

Is combined with value from raster transparency / global alpha value. Default: -1 (not set)

Definition at line 114 of file qgsrasterrenderer.h.

◆ mOpacity

double QgsRasterRenderer::mOpacity

protected

Global alpha value (0-1)

Definition at line 109 of file qgsrasterrenderer.h.

◆ mRasterTransparency

QgsRasterTransparency* QgsRasterRenderer::mRasterTransparency

protected

Raster transparency per color or value.

Overwrites global alpha value

Definition at line 111 of file qgsrasterrenderer.h.

◆ mType

QString QgsRasterRenderer::mType

protected

Definition at line 106 of file qgsrasterrenderer.h.

◆ NODATA_COLOR

const QRgb QgsRasterRenderer::NODATA_COLOR = qRgba( 0, 0, 0, 0 )

static

Definition at line 57 of file qgsrasterrenderer.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ MinMaxOrigin

Constructor & Destructor Documentation

◆ QgsRasterRenderer()

◆ ~QgsRasterRenderer()

Member Function Documentation

◆ _writeXML()

◆ alphaBand()

◆ bandCount()

◆ clone()

◆ copyCommonProperties()

◆ dataType()

◆ legendSymbologyItems()

◆ minMaxOriginFromName()

◆ minMaxOriginLabel()

◆ minMaxOriginName()

◆ opacity()

◆ rasterTransparency()

◆ readXML()

◆ setAlphaBand()

◆ setInput()

◆ setOpacity()

◆ setRasterTransparency()

◆ type()

◆ usesBands()

◆ usesTransparency()

Member Data Documentation

◆ mAlphaBand

◆ mOpacity

◆ mRasterTransparency

◆ mType

◆ NODATA_COLOR