Class: QgsBrightnessContrastFilter

Brightness/contrast and gamma correction filter pipe for rasters.

Class Hierarchy

Base classes

QgsRasterInterface

Base class for processing filters like renderers, reprojector, resampler etc.

Abstract Methods

clone

Clone itself, create deep copy

Methods

brightness	Returns current brightness level.
contrast	Returns current contrast level.
gamma	Returns current gamma value.
setBrightness	Set brightness level.
setContrast	Set contrast level.
setGamma	Set gamma value.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsBrightnessContrastFilter. See the FAQ for more details.

readXml

Sets base class members from xml.

class qgis.core.QgsBrightnessContrastFilter

Bases: QgsRasterInterface

brightness(self) → int

Returns current brightness level.

See also

setBrightness()

Return type:

int

abstract clone(self) → QgsBrightnessContrastFilter | None

Clone itself, create deep copy

Return type:

Optional[QgsBrightnessContrastFilter]

contrast(self) → int

Returns current contrast level.

See also

setContrast()

Return type:

int

gamma(self) → float

Returns current gamma value.

See also

setGamma()

Added in version 3.16.

Return type:

float

virtual readXml(self, filterElem: QDomElement)

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

Parameters:

filterElem (QDomElement)

setBrightness(self, brightness: int)

Set brightness level. Acceptable value range is -255…255

See also

brightness()

Parameters:

brightness (int)

setContrast(self, contrast: int)

Set contrast level. Acceptable value range is -100…100

See also

contrast()

Parameters:

contrast (int)

setGamma(self, gamma: float)

Set gamma value. Acceptable value range is -0.1…10

See also

gamma()

Added in version 3.16.

Parameters:

gamma (float)