Class: QgsSingleBandGrayRenderer¶
- class qgis.core.QgsSingleBandGrayRenderer¶
Bases:
QgsRasterRenderer
Raster renderer pipe for single band gray.
Methods
- param bandNo:
QgsSingleBandGrayRenderer
cannot be copied.- rtype:
QgsContrastEnhancement
- param elem:
- param nodeLayer:
- rtype:
Qgis.RasterRendererFlags
- rtype:
QgsSingleBandGrayRenderer.Gradient
Deprecated since version QGIS: 3.38
Fill in histogram defaults if not specified
Fill in statistics defaults if not specified
- rtype:
int
Returns the color ramp shader legend settings.
- rtype:
List[Tuple[str, QColor]]
Returns the color for the renderer to use to represent nodata pixels.
Takes ownership
- param gradient:
Deprecated since version QGIS: 3.38
- param band:
Sets the color ramp shader legend
settings
.- param doc:
- rtype:
List[int]
- param doc:
Attributes
- BlackToWhite = 0¶
- class Gradient¶
Bases:
int
- WhiteToBlack = 1¶
- 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) QgsSingleBandGrayRenderer ¶
QgsSingleBandGrayRenderer
cannot be copied. Useclone()
instead.- Return type:
- contrastEnhancement(self) QgsContrastEnhancement ¶
- Return type:
- create(elem: QDomElement, input: QgsRasterInterface) QgsRasterRenderer ¶
- Parameters:
elem (QDomElement) –
input (QgsRasterInterface) –
- Return type:
- createLegendNodes(self, nodeLayer: QgsLayerTreeLayer) List[QgsLayerTreeModelLegendNode] ¶
- Parameters:
nodeLayer (QgsLayerTreeLayer) –
- Return type:
- flags(self) Qgis.RasterRendererFlags ¶
- Return type:
- gradient(self) QgsSingleBandGrayRenderer.Gradient ¶
- Return type:
- grayBand(self) int ¶
Deprecated since version QGIS: 3.38 use
inputBand()
instead- Return type:
int
- 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, boundingBox: QgsRectangle = QgsRectangle(), binCount: int = 0)¶
Fill in statistics defaults if not specified
Deprecated since version Use:
Qgis
.RasterBandStatistic instead of int forstats
argumentinitStatistics(self, statistics:
QgsRasterBandStats
, bandNo: int, stats: Union[Qgis.RasterBandStatistics, Qgis.RasterBandStatistic] = Qgis.RasterBandStatistic.All, boundingBox:QgsRectangle
= QgsRectangle(), binCount: int = 0) Fill in statistics defaults if not specified
- inputBand(self) int ¶
- Return type:
int
- legendSettings(self) QgsColorRampLegendNodeSettings ¶
Returns the color ramp shader legend settings.
See also
New in version 3.18.
- Return type:
- legendSymbologyItems(self) List[Tuple[str, QColor]] ¶
- Return type:
List[Tuple[str, QColor]]
- renderColorForNodataPixel(self) int ¶
Returns the color for the renderer to use to represent nodata pixels.
Subclasses should use this rather then
nodataColor()
to determine the color to use for nodata pixels during an actual rendering operation.New in version 3.10.
- setContrastEnhancement(self, ce: QgsContrastEnhancement)¶
Takes ownership
- Parameters:
ce (QgsContrastEnhancement) –
- setGradient(self, gradient: QgsSingleBandGrayRenderer.Gradient)¶
- Parameters:
gradient (QgsSingleBandGrayRenderer.Gradient) –
- setGrayBand(self, band: int)¶
Deprecated since version QGIS: 3.38 use
setInputBand()
instead- Parameters:
band (int) –
- setInputBand(self, band: int) bool ¶
- Parameters:
band (int) –
- Return type:
bool
- setLegendSettings(self, settings: QgsColorRampLegendNodeSettings)¶
Sets the color ramp shader legend
settings
.Ownership of
settings
is transferred.See also
New in version 3.18.
- Parameters:
settings (QgsColorRampLegendNodeSettings) –
- toSld(self, doc: QDomDocument, element: QDomElement, props: Dict[str, Any] = {})¶
- Parameters:
doc (QDomDocument) –
element (QDomElement) –
props (Dict[str) –
- usesBands(self) List[int] ¶
- Return type:
List[int]
- writeXml(self, doc: QDomDocument, parentElem: QDomElement)¶
- Parameters:
doc (QDomDocument) –
parentElem (QDomElement) –