Class: QgsMultiBandColorRenderer

class qgis.core.QgsMultiBandColorRenderer

Bases: QgsRasterRenderer

Renderer for multiband images with the color components

Methods

block

param bandNo

blueBand

rtype

int

blueContrastEnhancement

Returns the contrast enhancement to use for the blue channel.

clone

QgsMultiBandColorRenderer cannot be copied.

create

param elem

greenBand

rtype

int

greenContrastEnhancement

Returns the contrast enhancement to use for the green channel.

initHistogram

Fill in histogram defaults if not specified

initStatistics

Fill in statistics defaults if not specified

redBand

rtype

int

redContrastEnhancement

Returns the contrast enhancement to use for the red channel.

renderColorForNodataPixel

Returns the color for the renderer to use to represent nodata pixels.

setBlueBand

param band

setBlueContrastEnhancement

Sets the contrast enhancement to use for the blue channel.

setGreenBand

param band

setGreenContrastEnhancement

Sets the contrast enhancement to use for the green channel.

setRedBand

param band

setRedContrastEnhancement

Sets the contrast enhancement to use for the red channel.

toSld

param doc

usesBands

rtype

List[int]

writeXml

param doc

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

QgsRasterBlock

blueBand(self) → int
Return type

int

blueContrastEnhancement(self)QgsContrastEnhancement

Returns the contrast enhancement to use for the blue channel.

Return type

QgsContrastEnhancement

clone(self)QgsMultiBandColorRenderer

QgsMultiBandColorRenderer cannot be copied. Use clone() instead.

Return type

QgsMultiBandColorRenderer

create(elem: QDomElement, input: QgsRasterInterface)QgsRasterRenderer
Parameters
Return type

QgsRasterRenderer

greenBand(self) → int
Return type

int

greenContrastEnhancement(self)QgsContrastEnhancement

Returns the contrast enhancement to use for the green channel.

Return type

QgsContrastEnhancement

initHistogram(self, histogram: QgsRasterHistogram, bandNo: int, binCount: int, minimum: object = Py_None, maximum: object = Py_None, boundingBox: QgsRectangle = QgsRectangle(), sampleSize: int = 0, includeOutOfRange: bool = False)

Fill in histogram defaults if not specified

Note

the parameters are the same as in histogram()

initStatistics(self, statistics: QgsRasterBandStats, bandNo: int, stats: int = QgsRasterBandStats.All, boundingBox: QgsRectangle = QgsRectangle(), binCount: int = 0)

Fill in statistics defaults if not specified

redBand(self) → int
Return type

int

redContrastEnhancement(self)QgsContrastEnhancement

Returns the contrast enhancement to use for the red channel.

Return type

QgsContrastEnhancement

renderColorForNodataPixel(self) → int

Returns the color for the renderer to use to represent nodata pixels.

Subclasses should use this rather then nodataColor() to determine the color to use for nodata pixels during an actual rendering operation.

New in version 3.10.

setBlueBand(self, band: int)
Parameters

band (int) –

setBlueContrastEnhancement(self, ce: QgsContrastEnhancement)

Sets the contrast enhancement to use for the blue channel.

Ownership of the enhancement is transferred.

Parameters

ce (QgsContrastEnhancement) –

setGreenBand(self, band: int)
Parameters

band (int) –

setGreenContrastEnhancement(self, ce: QgsContrastEnhancement)

Sets the contrast enhancement to use for the green channel.

Ownership of the enhancement is transferred.

Parameters

ce (QgsContrastEnhancement) –

setRedBand(self, band: int)
Parameters

band (int) –

setRedContrastEnhancement(self, ce: QgsContrastEnhancement)

Sets the contrast enhancement to use for the red channel.

Ownership of the enhancement is transferred.

Parameters

ce (QgsContrastEnhancement) –

toSld(self, doc: QDomDocument, element: QDomElement, props: Dict[str, str] = {})
Parameters
  • doc (QDomDocument) –

  • element (QDomElement) –

  • props (Dict[str) –

usesBands(self) → List[int]
Return type

List[int]

writeXml(self, doc: QDomDocument, parentElem: QDomElement)
Parameters
  • doc (QDomDocument) –

  • parentElem (QDomElement) –