Class: QgsMultiBandColorRenderer

Renderer for multiband images with the color components.

Class Hierarchy

Base classes

QgsRasterRenderer	Raster renderer pipe that applies colors to a raster.
QgsRasterInterface	Base class for processing filters like renderers, reprojector, resampler etc.

Methods

blueBand	Returns the band number for the blue channel.
blueContrastEnhancement	Returns the contrast enhancement to use for the blue channel.
greenBand	Returns the band number for the green channel.
greenContrastEnhancement	Returns the contrast enhancement to use for the green channel.
redBand	Returns the band number for the red channel.
redContrastEnhancement	Returns the contrast enhancement to use for the red channel.
setBlueBand	Sets the band number for the blue channel.
setBlueContrastEnhancement	Sets the contrast enhancement to use for the blue channel.
setGreenBand	Sets the band number for the green channel.
setGreenContrastEnhancement	Sets the contrast enhancement to use for the green channel.
setRedBand	Sets the band number for the red channel.
setRedContrastEnhancement	Sets the contrast enhancement to use for the red channel.

Static Methods

create

class qgis.core.QgsMultiBandColorRenderer

Bases: QgsRasterRenderer

__init__(input: QgsRasterInterface | None, redBand: int, greenBand: int, blueBand: int, redEnhancement: QgsContrastEnhancement | None = None, greenEnhancement: QgsContrastEnhancement | None = None, blueEnhancement: QgsContrastEnhancement | None = None)

Constructor for QgsMultiBandColorRenderer.

Parameters:

• input (Optional[QgsRasterInterface]) – input raster interface

• redBand (int) – band number for red channel

• greenBand (int) – band number for green channel

• blueBand (int) – band number for blue channel

• redEnhancement (Optional[QgsContrastEnhancement] = None) – optional contrast enhancement for red channel. Ownership is transferred to the renderer.

• greenEnhancement (Optional[QgsContrastEnhancement] = None) – optional contrast enhancement for green channel. Ownership is transferred to the renderer.

• blueEnhancement (Optional[QgsContrastEnhancement] = None) – optional contrast enhancement for blue channel. Ownership is transferred to the renderer.

blueBand(self) → int

Returns the band number for the blue channel.

See also

setRedBand()

Return type:

int

blueContrastEnhancement(self) → QgsContrastEnhancement | None

Returns the contrast enhancement to use for the blue channel.

See also

setBlueContrastEnhancement()

See also

redContrastEnhancement()

See also

greenContrastEnhancement()

Return type:

Optional[QgsContrastEnhancement]

static create(elem: QDomElement, input: QgsRasterInterface | None) → QgsRasterRenderer | None

Parameters:

• elem (QDomElement)

• input (Optional[QgsRasterInterface])

Return type:

Optional[QgsRasterRenderer]

greenBand(self) → int

Returns the band number for the green channel.

See also

setRedBand()

Return type:

int

greenContrastEnhancement(self) → QgsContrastEnhancement | None

Returns the contrast enhancement to use for the green channel.

See also

setGreenContrastEnhancement()

See also

redContrastEnhancement()

See also

blueContrastEnhancement()

Return type:

Optional[QgsContrastEnhancement]

redBand(self) → int

Returns the band number for the red channel.

See also

setRedBand()

Return type:

int

redContrastEnhancement(self) → QgsContrastEnhancement | None

Returns the contrast enhancement to use for the red channel.

See also

setRedContrastEnhancement()

See also

greenContrastEnhancement()

See also

blueContrastEnhancement()

Return type:

Optional[QgsContrastEnhancement]

setBlueBand(self, band: int)

Sets the band number for the blue channel.

See also

blueBand()

Parameters:

band (int)

setBlueContrastEnhancement(self, ce: QgsContrastEnhancement | None)

Sets the contrast enhancement to use for the blue channel.

Ownership of the enhancement is transferred.

See also

blueContrastEnhancement()

See also

setRedContrastEnhancement()

See also

setGreenContrastEnhancement()

Parameters:

ce (Optional[QgsContrastEnhancement])

setGreenBand(self, band: int)

Sets the band number for the green channel.

See also

greenBand()

Parameters:

band (int)

setGreenContrastEnhancement(self, ce: QgsContrastEnhancement | None)

Sets the contrast enhancement to use for the green channel.

Ownership of the enhancement is transferred.

See also

greenContrastEnhancement()

See also

setRedContrastEnhancement()

See also

setBlueContrastEnhancement()

Parameters:

ce (Optional[QgsContrastEnhancement])

setRedBand(self, band: int)

Sets the band number for the red channel.

See also

redBand()

Parameters:

band (int)

setRedContrastEnhancement(self, ce: QgsContrastEnhancement | None)

Sets the contrast enhancement to use for the red channel.

Ownership of the enhancement is transferred.

See also

redContrastEnhancement()

See also

setGreenContrastEnhancement()

See also

setBlueContrastEnhancement()

Parameters:

ce (Optional[QgsContrastEnhancement])