Class: QgsHueSaturationFilter¶
-
class
qgis.core.
QgsHueSaturationFilter
¶ Bases:
QgsRasterInterface
Color and saturation filter pipe for rasters.
Methods
- rtype
int
- param bandNo
- rtype
QgsHueSaturationFilter
- rtype
QColor
- rtype
bool
- rtype
int
- param bandNo
- rtype
QgsHueSaturationFilter.GrayscaleMode
Sets base class members from xml.
- rtype
int
- param colorizeColor
- param colorizeOn
- param colorizeStrength
- param grayscaleMode
- param input
- param saturation
- param doc
Attributes
-
GrayscaleAverage
= 3¶
-
GrayscaleLightness
= 1¶
-
GrayscaleLuminosity
= 2¶
-
class
GrayscaleMode
¶ Bases:
int
-
GrayscaleOff
= 0¶
-
bandCount
(self) → int¶ - Return type
int
-
block
(self, bandNo: int, extent: QgsRectangle, width: int, height: int, feedback: QgsRasterBlockFeedback = None) → QgsRasterBlock¶ - Parameters
bandNo (int) –
extent (QgsRectangle) –
width (int) –
height (int) –
feedback (
QgsRasterBlockFeedback
= None) –
- Return type
-
clone
(self) → QgsHueSaturationFilter¶ - Return type
-
colorizeColor
(self) → QColor¶ - Return type
QColor
-
colorizeOn
(self) → bool¶ - Return type
bool
-
colorizeStrength
(self) → int¶ - Return type
int
-
dataType
(self, bandNo: int) → Qgis.DataType¶ - Parameters
bandNo (int) –
- Return type
-
grayscaleMode
(self) → QgsHueSaturationFilter.GrayscaleMode¶ - Return type
-
initHistogram
()¶
-
initStatistics
()¶
-
readXml
(self, filterElem: QDomElement)¶ Sets base class members from xml. Usually called from create() methods of subclasses
- Parameters
filterElem (QDomElement) –
-
saturation
(self) → int¶ - Return type
int
-
setColorizeColor
(self, colorizeColor: Union[QColor, Qt.GlobalColor, QGradient])¶ - Parameters
colorizeColor (Union[QColor) –
-
setColorizeOn
(self, colorizeOn: bool)¶ - Parameters
colorizeOn (bool) –
-
setColorizeStrength
(self, colorizeStrength: int)¶ - Parameters
colorizeStrength (int) –
-
setGrayscaleMode
(self, grayscaleMode: QgsHueSaturationFilter.GrayscaleMode)¶ - Parameters
grayscaleMode (QgsHueSaturationFilter.GrayscaleMode) –
-
setInput
(self, input: QgsRasterInterface) → bool¶ - Parameters
input (QgsRasterInterface) –
- Return type
bool
-
setSaturation
(self, saturation: int)¶ - Parameters
saturation (int) –
-
writeXml
(self, doc: QDomDocument, parentElem: QDomElement)¶ - Parameters
doc (QDomDocument) –
parentElem (QDomElement) –