Class: QgsMultiBandColorRenderer¶
- class qgis.core.QgsMultiBandColorRenderer¶
Bases:
QgsRasterRenderer
Renderer for multiband images with the color components
Methods
- param bandNo:
- rtype:
int
Returns the contrast enhancement to use for the blue channel.
QgsMultiBandColorRenderer
cannot be copied.- param elem:
- param nodeLayer:
- rtype:
int
Returns the contrast enhancement to use for the green channel.
Fill in histogram defaults if not specified
Fill in statistics defaults if not specified
- rtype:
int
Returns the contrast enhancement to use for the red channel.
Returns the color for the renderer to use to represent nodata pixels.
- param band:
Sets the contrast enhancement to use for the blue channel.
- param band:
Sets the contrast enhancement to use for the green channel.
- param band:
Sets the contrast enhancement to use for the red channel.
- param doc:
- rtype:
List[int]
- param doc:
- block(self, bandNo: int, extent: QgsRectangle, width: int, height: int, feedback: QgsRasterBlockFeedback = None) QgsRasterBlock ¶
- Parameters:
bandNo (int) –
extent (QgsRectangle) –
width (int) –
height (int) –
feedback (
QgsRasterBlockFeedback
= None) –
- Return type:
- blueBand(self) int ¶
- Return type:
int
- blueContrastEnhancement(self) QgsContrastEnhancement ¶
Returns the contrast enhancement to use for the blue channel.
See also
See also
See also
- Return type:
- clone(self) QgsMultiBandColorRenderer ¶
QgsMultiBandColorRenderer
cannot be copied. Useclone()
instead.- Return type:
- create(elem: QDomElement, input: QgsRasterInterface) QgsRasterRenderer ¶
- Parameters:
elem (QDomElement) –
input (QgsRasterInterface) –
- Return type:
- createLegendNodes(self, nodeLayer: QgsLayerTreeLayer) List[QgsLayerTreeModelLegendNode] ¶
- Parameters:
nodeLayer (QgsLayerTreeLayer) –
- Return type:
- greenBand(self) int ¶
- Return type:
int
- greenContrastEnhancement(self) QgsContrastEnhancement ¶
Returns the contrast enhancement to use for the green channel.
See also
See also
See also
- Return type:
- 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.
See also
See also
See also
- Return type:
- 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.
See also
See also
See also
- 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.
See also
See also
See also
- 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.
See also
See also
See also
- Parameters:
ce (QgsContrastEnhancement) –
- toSld(self, doc: QDomDocument, element: QDomElement, props: Dict[str, Any] = {})¶
- 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) –