Class: QgsSingleBandGrayRenderer

class qgis.core.QgsSingleBandGrayRenderer

Bases: QgsRasterRenderer

Raster renderer pipe for single band gray.

Methods

block

param bandNo

clone

QgsSingleBandGrayRenderer cannot be copied.

contrastEnhancement

rtype

QgsContrastEnhancement

create

param elem

createLegendNodes

param nodeLayer

gradient

rtype

QgsSingleBandGrayRenderer.Gradient

grayBand

rtype

int

initHistogram

Fill in histogram defaults if not specified

initStatistics

Fill in statistics defaults if not specified

legendSettings

Returns the color ramp shader legend settings.

legendSymbologyItems

rtype

List[Tuple[str, QColor]]

renderColorForNodataPixel

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

setContrastEnhancement

Takes ownership

setGradient

param gradient

setGrayBand

param band

setLegendSettings

Sets the color ramp shader legend settings.

toSld

param doc

usesBands

rtype

List[int]

writeXml

param doc

Attributes

BlackToWhite

WhiteToBlack

BlackToWhite = 0
class Gradient

Bases: int

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

QgsRasterBlock

clone(self)QgsSingleBandGrayRenderer

QgsSingleBandGrayRenderer cannot be copied. Use clone() instead.

Return type

QgsSingleBandGrayRenderer

contrastEnhancement(self)QgsContrastEnhancement
Return type

QgsContrastEnhancement

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

QgsRasterRenderer

createLegendNodes(self, nodeLayer: QgsLayerTreeLayer) → List[QgsLayerTreeModelLegendNode]
Parameters

nodeLayer (QgsLayerTreeLayer) –

Return type

List[QgsLayerTreeModelLegendNode]

gradient(self)QgsSingleBandGrayRenderer.Gradient
Return type

QgsSingleBandGrayRenderer.Gradient

grayBand(self) → int
Return type

int

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

legendSettings(self)QgsColorRampLegendNodeSettings

Returns the color ramp shader legend settings.

New in version 3.18.

Return type

QgsColorRampLegendNodeSettings

legendSymbologyItems(self) → List[Tuple[str, QColor]]
Return type

List[Tuple[str, QColor]]

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.

setContrastEnhancement(self, ce: QgsContrastEnhancement)

Takes ownership

Parameters

ce (QgsContrastEnhancement) –

setGradient(self, gradient: QgsSingleBandGrayRenderer.Gradient)
Parameters

gradient (QgsSingleBandGrayRenderer.Gradient) –

setGrayBand(self, band: int)
Parameters

band (int) –

setLegendSettings(self, settings: QgsColorRampLegendNodeSettings)

Sets the color ramp shader legend settings.

Ownership of settings is transferred.

See also

legendSettings()

New in version 3.18.

Parameters

settings (QgsColorRampLegendNodeSettings) –

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) –