Subgroup: other

Class: QgsHueSaturationFilter

class qgis.core.QgsHueSaturationFilter

Bases: qgis._core.QgsRasterInterface

Color and saturation filter pipe for rasters.

Methods

bandCount
bandStatistics	Get band statistics.
block
capabilities	Returns a bitmask containing the supported capabilities
capabilitiesString	Returns the above in friendly format.
clone
colorizeColor
colorizeOn
colorizeStrength
cumulativeCut	Find values for cumulative pixel count cut.
dataType
dataTypeSize
extent	Get the extent of the interface.
generateBandName	helper function to create zero padded band names
grayscaleMode
hasHistogram	Returns true if histogram is available (cached, already calculated)
hasStatistics	Returns true if histogram is available (cached, already calculated).
histogram	Get histogram.
initHistogram
initStatistics
input	Current input
on	Is on/off
readXml	Sets base class members from xml.
saturation
setColorizeColor
setColorizeOn
setColorizeStrength
setGrayscaleMode
setInput
setOn	Set on/off
setSaturation
sourceDataType	Returns source data type for the band specified by number,
sourceInput	Get source / raw input, the first in pipe, usually provider.
writeXml
xBlockSize	Get block size
xSize	Get raster size
yBlockSize
ySize

Attributes

BuildPyramids
Create
GrayscaleAverage
GrayscaleLightness
GrayscaleLuminosity
GrayscaleOff
Identify
IdentifyFeature
IdentifyHtml
IdentifyText
IdentifyValue
NoCapabilities
Remove
Size

GrayscaleAverage = 3

GrayscaleLightness = 1

GrayscaleLuminosity = 2

class GrayscaleMode

Bases: int

GrayscaleOff = 0

bandCount(self) → int

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

clone(self) → QgsHueSaturationFilter

colorizeColor(self) → QColor

colorizeOn(self) → bool

colorizeStrength(self) → int

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

grayscaleMode(self) → QgsHueSaturationFilter.GrayscaleMode

initHistogram()

initStatistics()

readXml(self, filterElem: QDomElement)

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

saturation(self) → int

setColorizeColor(self, colorizeColor: Union[QColor, Qt.GlobalColor, QGradient])

setColorizeOn(self, colorizeOn: bool)

setColorizeStrength(self, colorizeStrength: int)

setGrayscaleMode(self, grayscaleMode: QgsHueSaturationFilter.GrayscaleMode)

setInput(self, input: QgsRasterInterface) → bool

setSaturation(self, saturation: int)

writeXml(self, doc: QDomDocument, parentElem: QDomElement)