Subgroup: Multi

Class: QgsMultiBandColorRenderer

class qgis.core.QgsMultiBandColorRenderer

Bases: qgis._core.QgsRasterRenderer

Renderer for multiband images with the color components

Methods

alphaBand
bandCount
bandStatistics	Get band statistics.
block
blueBand
blueContrastEnhancement
capabilities	Returns a bitmask containing the supported capabilities
capabilitiesString	Returns the above in friendly format.
clone	QgsMultiBandColorRenderer cannot be copied.
copyCommonProperties	Copies common properties like opacity / transparency data from other renderer.
create
cumulativeCut	Find values for cumulative pixel count cut.
dataType
dataTypeSize
extent	Get the extent of the interface.
generateBandName	helper function to create zero padded band names
greenBand
greenContrastEnhancement
hasHistogram	Returns true if histogram is available (cached, already calculated)
hasStatistics	Returns true if histogram is available (cached, already calculated).
histogram	Get histogram.
initHistogram
initStatistics
input	Current input
legendSymbologyItems	Get symbology items if provided by renderer
minMaxOrigin	Returns const reference to origin of min/max values
on	Is on/off
opacity	Returns the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).
rasterTransparency
readXml	Sets base class members from xml.
redBand
redContrastEnhancement
setAlphaBand
setBlueBand
setBlueContrastEnhancement	Takes ownership
setGreenBand
setGreenContrastEnhancement	Takes ownership
setInput
setMinMaxOrigin	Sets origin of min/max values
setOn	Set on/off
setOpacity	Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).
setRasterTransparency
setRedBand
setRedContrastEnhancement	Takes ownership
sourceDataType	Returns source data type for the band specified by number,
sourceInput	Get source / raw input, the first in pipe, usually provider.
type
usesBands
usesTransparency
writeXml
xBlockSize	Get block size
xSize	Get raster size
yBlockSize
ySize

Attributes

BuildPyramids
Create
Identify
IdentifyFeature
IdentifyHtml
IdentifyText
IdentifyValue
NODATA_COLOR
NoCapabilities
Remove
Size

block(self, bandNo: int, extent: QgsRectangle, width: int, height: int, feedback: QgsRasterBlockFeedback = None) → QgsRasterBlock

blueBand(self) → int

blueContrastEnhancement(self) → QgsContrastEnhancement

clone(self) → QgsMultiBandColorRenderer

QgsMultiBandColorRenderer cannot be copied. Use clone() instead.

create(elem: QDomElement, input: QgsRasterInterface) → QgsRasterRenderer

greenBand(self) → int

greenContrastEnhancement(self) → QgsContrastEnhancement

initHistogram()

initStatistics()

redBand(self) → int

redContrastEnhancement(self) → QgsContrastEnhancement

setBlueBand(self, band: int)

setBlueContrastEnhancement(self, ce: QgsContrastEnhancement)

Takes ownership

setGreenBand(self, band: int)

setGreenContrastEnhancement(self, ce: QgsContrastEnhancement)

Takes ownership

setRedBand(self, band: int)

setRedContrastEnhancement(self, ce: QgsContrastEnhancement)

Takes ownership

usesBands(self) → List[int]

writeXml(self, doc: QDomDocument, parentElem: QDomElement)