Class: QgsBrightnessContrastFilter

class qgis.core.QgsBrightnessContrastFilter

Bases: QgsRasterInterface

Brightness/contrast filter pipe for rasters.

Methods

bandCount

rtype

int

block

param bandNo

brightness

rtype

int

clone

rtype

QgsBrightnessContrastFilter

contrast

rtype

int

dataType

param bandNo

initHistogram

Fill in histogram defaults if not specified

initStatistics

Fill in statistics defaults if not specified

readXml

Sets base class members from xml.

setBrightness

param brightness

setContrast

param contrast

setInput

param input

writeXml

param doc

bandCount(self) → int
Return type

int

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

QgsRasterBlock

brightness(self) → int
Return type

int

clone(self)QgsBrightnessContrastFilter
Return type

QgsBrightnessContrastFilter

contrast(self) → int
Return type

int

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

bandNo (int) –

Return type

Qgis.DataType

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

readXml(self, filterElem: QDomElement)

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

Parameters

filterElem (QDomElement) –

setBrightness(self, brightness: int)
Parameters

brightness (int) –

setContrast(self, contrast: int)
Parameters

contrast (int) –

setInput(self, input: QgsRasterInterface) → bool
Parameters

input (QgsRasterInterface) –

Return type

bool

writeXml(self, doc: QDomDocument, parentElem: QDomElement)
Parameters
  • doc (QDomDocument) –

  • parentElem (QDomElement) –