Class: QgsHueSaturationFilter

Color and saturation filter pipe for rasters.

Class Hierarchy

Inheritance diagram of qgis.core.QgsHueSaturationFilter

Base classes

QgsRasterInterface

Base class for processing filters like renderers, reprojector, resampler etc.
class qgis.core.QgsHueSaturationFilter[source]

Bases: QgsRasterInterface

GrayscaleAverage = 3
GrayscaleLightness = 1
GrayscaleLuminosity = 2
class GrayscaleMode

Bases: int

GrayscaleOff = 0
colorizeColor(self) → QColor[source]
Return type:

QColor

colorizeOn(self) → bool[source]
Return type:

bool

colorizeStrength(self) → int[source]
Return type:

int

grayscaleMode(self) → QgsHueSaturationFilter.GrayscaleMode[source]
Return type:

QgsHueSaturationFilter.GrayscaleMode

invertColors(self) → bool[source]

Returns True if the filter inverts colors.

Added in version 3.22.

Return type:

bool

virtual readXml(self, filterElem: QDomElement)[source]

Sets base class members from xml. Usually called from create() methods of subclasses

Parameters:

filterElem (QDomElement)

saturation(self) → int[source]
Return type:

int

setColorizeColor(self, colorizeColor: QColor | Qt.GlobalColor)[source]
Parameters:

colorizeColor (Union[QColor, Qt.GlobalColor])

setColorizeOn(self, colorizeOn: bool)[source]
Parameters:

colorizeOn (bool)

setColorizeStrength(self, colorizeStrength: int)[source]
Parameters:

colorizeStrength (int)

setGrayscaleMode(self, grayscaleMode: QgsHueSaturationFilter.GrayscaleMode)[source]
Parameters:

grayscaleMode (QgsHueSaturationFilter.GrayscaleMode)

setInvertColors(self, invertColors: bool)[source]

Sets whether the filter will invert colors.

Parameters:

invertColors (bool) – Set to True to invert colors.

Added in version 3.22.

setSaturation(self, saturation: int)[source]
Parameters:

saturation (int)