Subgroup: Raster

Class: QgsRasterRenderer¶

class qgis.core.QgsRasterRenderer¶

Bases: qgis._core.QgsRasterInterface

Raster renderer pipe that applies colors to a raster.

Methods

alphaBand

bandCount

bandStatistics Get band statistics.

block

capabilities Returns a bitmask containing the supported capabilities

capabilitiesString Returns the above in friendly format.

clone QgsRasterRenderer cannot be copied.

copyCommonProperties Copies common properties like opacity / transparency data from other renderer.

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

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.

setAlphaBand

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

sourceDataType Returns source data type for the band specified by number,

sourceInput Get source / raw input, the first in pipe, usually provider.

type

usesBands Returns a list of band numbers used by the renderer

usesTransparency

writeXml Write base class members to xml.

xBlockSize Get block size

xSize Get raster size

yBlockSize

ySize

Attributes

BuildPyramids

Create

Identify

IdentifyFeature

IdentifyHtml

IdentifyText

IdentifyValue

NODATA_COLOR

NoCapabilities

Remove

Size

NODATA_COLOR = 0¶

alphaBand(self) → int¶

bandCount(self) → int¶

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

clone(self) → QgsRasterRenderer¶: QgsRasterRenderer cannot be copied. Use clone() instead.

copyCommonProperties(self, other: QgsRasterRenderer, copyMinMaxOrigin: bool = True)¶: Copies common properties like opacity / transparency data from other renderer. Useful when cloning renderers.

New in version 2.16.

dataType(self, bandNo: int) → Qgis.DataType¶

initHistogram()¶

initStatistics()¶

legendSymbologyItems(self) → List[Tuple[str, QColor]]¶: Get symbology items if provided by renderer

minMaxOrigin(self) → QgsRasterMinMaxOrigin¶: Returns const reference to origin of min/max values

opacity(self) → float¶: Returns the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).

See also

setOpacity()

rasterTransparency(self) → QgsRasterTransparency¶

readXml(self, rendererElem: QDomElement)¶: Sets base class members from xml. Usually called from create() methods of subclasses

setAlphaBand(self, band: int)¶

setInput(self, input: QgsRasterInterface) → bool¶

setMinMaxOrigin(self, origin: QgsRasterMinMaxOrigin)¶: Sets origin of min/max values

setOpacity(self, opacity: float)¶: Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).

See also

opacity()

setRasterTransparency(self, t: QgsRasterTransparency)¶

type(self) → str¶

usesBands(self) → List[int]¶: Returns a list of band numbers used by the renderer

usesTransparency(self) → bool¶