Class: QgsRasterShaderFunction

class qgis.core.QgsRasterShaderFunction

Bases: sip.wrapper

The raster shade function applies a shader to a pixel at render time - typically used to render grayscale images as false color.

Enums

Methods

legendSymbologyItems

Returns legend symbology items if provided by renderer.

maximumValue

Returns the minimum value for the raster shader.

minimumMaximumRange

minimumValue

Returns the maximum value for the raster shader.

setMaximumValue

Sets the maximum value for the raster shader.

setMinimumValue

Sets the minimum value for the raster shader.

shade

Generates an new RGBA value based on one input value.

Signals

Attributes

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

Returns legend symbology items if provided by renderer.

maximumValue(self) → float

Returns the minimum value for the raster shader.

See also

setMinimumValue()

See also

maximumValue()

minimumMaximumRange(self) → float
minimumValue(self) → float

Returns the maximum value for the raster shader.

See also

setMaximumValue()

See also

minimumValue()

setMaximumValue(self, value: float)

Sets the maximum value for the raster shader.

See also

setMinimumValue()

See also

maximumValue()

setMinimumValue(self, value: float)

Sets the minimum value for the raster shader.

See also

setMaximumValue()

See also

minimumValue()

shade(self, value: float) → Tuple[bool, int, int, int, int]

Generates an new RGBA value based on one input value.

Parameters

  • value – The original value to base a new RGBA value on

  • returnRedValue – The red component of the new RGBA value

  • returnGreenValue – The green component of the new RGBA value

  • returnBlueValue – The blue component of the new RGBA value

Returns

  • True if the return values are valid otherwise False

  • returnAlpha: The alpha component of the new RGBA value

shade(self, redValue: float, greenValue: float, blueValue: float, alphaValue: float) -> Tuple[bool, int, int, int, int] Generates an new RGBA value based on an original RGBA value.

Parameters

  • redValue – The red component of the original value to base a new RGBA value on

  • greenValue – The green component of the original value to base a new RGBA value on

  • blueValue – The blue component of the original value to base a new RGBA value on

  • alphaValue – The alpha component of the original value to base a new RGBA value on

  • returnRedValue – The red component of the new RGBA value

  • returnGreenValue – The green component of the new RGBA value

  • returnBlueValue – The blue component of the new RGBA value

Returns

  • True if the return values are valid otherwise False

  • returnAlpha: The alpha component of the new RGBA value