Subgroup: Contrast
Class: QgsContrastEnhancement¶
-
class
qgis.core.
QgsContrastEnhancement
¶ Bases:
sip.wrapper
Manipulates raster pixel values so that they enhanceContrast or clip into a specified numerical range according to the specified ContrastEnhancementAlgorithm.
Methods
contrastEnhancementAlgorithm
contrastEnhancementAlgorithmFromString
Deserialize ContrastEnhancementAlgorithm contrastEnhancementAlgorithmString
Return a string to serialize ContrastEnhancementAlgorithm enhanceContrast
Apply the contrast enhancement to a value. isValueInDisplayableRange
Return true if pixel is in stretable range, false if pixel is outside of range (i. maximumValue
Return the maximum value for the contrast enhancement range. maximumValuePossible
Helper function that returns the maximum possible value for a GDAL data type minimumValue
Return the minimum value for the contrast enhancement range. minimumValuePossible
Helper function that returns the minimum possible value for a GDAL data type readXml
setContrastEnhancementAlgorithm
Set the contrast enhancement algorithm setContrastEnhancementFunction
A public method that allows the user to set their own custom contrast enhancement function setMaximumValue
Set the maximum value for the contrast enhancement range. setMinimumValue
Return the minimum value for the contrast enhancement range. writeXml
Signals
Attributes
ClipToMinimumMaximum
NoEnhancement
StretchAndClipToMinimumMaximum
StretchToMinimumMaximum
UserDefinedEnhancement
-
ClipToMinimumMaximum
= 3¶
-
class
ContrastEnhancementAlgorithm
¶ Bases:
int
-
NoEnhancement
= 0¶
-
StretchAndClipToMinimumMaximum
= 2¶
-
StretchToMinimumMaximum
= 1¶
-
UserDefinedEnhancement
= 4¶
-
contrastEnhancementAlgorithm
(self) → QgsContrastEnhancement.ContrastEnhancementAlgorithm¶
-
contrastEnhancementAlgorithmFromString
(contrastEnhancementString: str) → QgsContrastEnhancement.ContrastEnhancementAlgorithm¶ Deserialize ContrastEnhancementAlgorithm
-
contrastEnhancementAlgorithmString
(algorithm: QgsContrastEnhancement.ContrastEnhancementAlgorithm) → str¶ Return a string to serialize ContrastEnhancementAlgorithm
-
enhanceContrast
(self, float) → int¶ Apply the contrast enhancement to a value. Return values are 0 - 254, -1 means the pixel was clipped and should not be displayed
-
isValueInDisplayableRange
(self, float) → bool¶ Return true if pixel is in stretable range, false if pixel is outside of range (i.e., clipped)
-
maximumValue
(self) → float¶ Return the maximum value for the contrast enhancement range.
-
maximumValuePossible
(Qgis.DataType) → float¶ Helper function that returns the maximum possible value for a GDAL data type
-
minimumValue
(self) → float¶ Return the minimum value for the contrast enhancement range.
-
minimumValuePossible
(Qgis.DataType) → float¶ Helper function that returns the minimum possible value for a GDAL data type
-
readXml
(self, elem: QDomElement)¶
-
setContrastEnhancementAlgorithm
(self, a0: QgsContrastEnhancement.ContrastEnhancementAlgorithm, generateTable: bool = True)¶ Set the contrast enhancement algorithm
-
setContrastEnhancementFunction
(self, QgsContrastEnhancementFunction)¶ A public method that allows the user to set their own custom contrast enhancement function
-
setMaximumValue
(self, a0: float, generateTable: bool = True)¶ Set the maximum value for the contrast enhancement range.
-
setMinimumValue
(self, a0: float, generateTable: bool = True)¶ Return the minimum value for the contrast enhancement range.
-
writeXml
(self, doc: QDomDocument, parentElem: QDomElement)¶
-