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

#include <qgsmultibandcolorrenderer.h>

Inheritance diagram for QgsMultiBandColorRenderer:

Public Member Functions
	QgsMultiBandColorRenderer (QgsRasterInterface input, int redBand, int greenBand, int blueBand, QgsContrastEnhancement redEnhancement=0, QgsContrastEnhancement greenEnhancement=0, QgsContrastEnhancement blueEnhancement=0)
	~QgsMultiBandColorRenderer ()
QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height) override
	Read block of data using given extent and size.
int	blueBand () const
const QgsContrastEnhancement *	blueContrastEnhancement () const
QgsRasterInterface *	clone () const override
	Clone itself, create deep copy.
int	greenBand () const
const QgsContrastEnhancement *	greenContrastEnhancement () const
int	redBand () const
const QgsContrastEnhancement *	redContrastEnhancement () const
void	setBlueBand (int band)
void	setBlueContrastEnhancement (QgsContrastEnhancement *ce)
	Takes ownership.
void	setGreenBand (int band)
void	setGreenContrastEnhancement (QgsContrastEnhancement *ce)
	Takes ownership.
void	setRedBand (int band)
void	setRedContrastEnhancement (QgsContrastEnhancement *ce)
	Takes ownership.
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 (QgsRasterInterface *input=0, const QString &type="")
virtual	~QgsRasterRenderer ()
int	alphaBand () const
virtual int	bandCount () const override
	Get number of bands.
virtual QGis::DataType	dataType (int bandNo) const override
	Returns data type for the band specified by number.
virtual void	legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const
	Get symbology items if provided by renderer.
double	opacity () const
const QgsRasterTransparency *	rasterTransparency () const
void	readXML (const QDomElement &rendererElem) override
	Sets base class members from xml.
void	setAlphaBand (int band)
virtual bool	setInput (QgsRasterInterface *input) override
	Set input.
void	setOpacity (double opacity)
void	setRasterTransparency (QgsRasterTransparency *t)
virtual QString	type () const
bool	usesTransparency () const
Public Member Functions inherited from QgsRasterInterface
	QgsRasterInterface (QgsRasterInterface *input=0)
virtual	~QgsRasterInterface ()
virtual QgsRasterBandStats	bandStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
	Get band statistics.
virtual int	capabilities () const
	Returns a bitmask containing the supported capabilities.
QString	capabilitiesString () const
	Returns the above in friendly format.
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.
int	dataTypeSize (int bandNo)
virtual QgsRectangle	extent ()
	Get the extent of the interface.
virtual QString	generateBandName (int theBandNumber) const
	helper function to create zero padded band names
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()
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).
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.
virtual QgsRasterInterface *	input () const
	Current input.
virtual bool	on () const
	Is on/off.
virtual void	setOn (bool on)
	Set on/off.
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.
virtual const QgsRasterInterface *	srcInput () const
	Get source / raw input, the first in pipe, usually provider.
virtual QgsRasterInterface *	srcInput ()
virtual int	xBlockSize () const
	Get block size.
virtual int	xSize () const
	Get raster size.
virtual int	yBlockSize () const
virtual int	ySize () const

Static Public Member Functions
static QgsRasterRenderer *	create (const QDomElement &elem, QgsRasterInterface *input)
Static Public Member Functions inherited from QgsRasterRenderer
static int	minMaxOriginFromName (QString theName)
static QString	minMaxOriginLabel (int theOrigin)
static QString	minMaxOriginName (int theOrigin)

Additional Inherited Members
Public Types inherited from QgsRasterRenderer
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 }
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)
Protected Attributes inherited from QgsRasterRenderer
int	mAlphaBand
	Read alpha value from band.
double	mOpacity
	Global alpha value (0-1)
QgsRasterTransparency *	mRasterTransparency
	Raster transparency per color or value.
QString	mType

Detailed Description

Renderer for multiband images with the color components.

Definition at line 29 of file qgsmultibandcolorrenderer.h.

Constructor & Destructor Documentation

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