Class: QgsHillshadeRenderer

class qgis.core.QgsHillshadeRenderer

Bases: QgsRasterRenderer

A renderer for generating live hillshade models.

New in version 2.16.

QgsHillshadeRenderer(input: QgsRasterInterface, band: int, lightAzimuth: float, lightAltitude: float) A renderer for generating live hillshade models.

Parameters:
  • input – The input raster interface

  • band – The band in the raster to use

  • lightAzimuth – The azimuth of the light source

  • lightAltitude

    The altitude of the light source

    Methods

    altitude

    Returns the angle of the light source over the raster.

    azimuth

    Returns the direction of the light over the raster between 0-360.

    band

    Returns the band used by the renderer

    block

    param bandNo:

    clone

    rtype:

    QgsHillshadeRenderer

    create

    Factory method to create a new renderer

    flags

    rtype:

    Qgis.RasterRendererFlags

    initHistogram

    Fill in histogram defaults if not specified

    initStatistics

    Fill in statistics defaults if not specified

    multiDirectional

    Returns True if the renderer is using multi-directional hillshading.

    renderColorForNodataPixel

    Returns the color for the renderer to use to represent nodata pixels.

    setAltitude

    Set the altitude of the light source

    setAzimuth

    Set the azimuth of the light source.

    setBand

    Sets the band used by the renderer.

    setMultiDirectional

    Sets whether to render using a multi-directional hillshade algorithm.

    setZFactor

    Set the Z scaling factor of the result image.

    toSld

    param doc:

    usesBands

    rtype:

    List[int]

    writeXml

    param doc:

    zFactor

    Returns the Z scaling factor.

altitude(self) float

Returns the angle of the light source over the raster.

See also

setAltitude()

Return type:

float

azimuth(self) float

Returns the direction of the light over the raster between 0-360.

See also

setAzimuth()

Return type:

float

band(self) int

Returns the band used by the renderer

Return type:

int

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

QgsRasterBlock

clone(self) QgsHillshadeRenderer
Return type:

QgsHillshadeRenderer

create(elem: QDomElement, input: QgsRasterInterface) QgsRasterRenderer

Factory method to create a new renderer

Parameters:
  • elem (QDomElement) – A DOM element to create the renderer from.

  • input (QgsRasterInterface) – The raster input interface.

Return type:

QgsRasterRenderer

Returns:

A new QgsHillshadeRenderer.

flags(self) Qgis.RasterRendererFlags
Return type:

Qgis.RasterRendererFlags

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

multiDirectional(self) bool

Returns True if the renderer is using multi-directional hillshading.

Return type:

bool

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.

setAltitude(self, altitude: float)

Set the altitude of the light source

Parameters:

altitude (float) – the altitude

See also

altitude()

setAzimuth(self, azimuth: float)

Set the azimuth of the light source.

Parameters:

azimuth (float) – The azimuth of the light source, between 0 and 360.0

See also

azimuth()

setBand(self, bandNo: int)

Sets the band used by the renderer.

See also

band()

Parameters:

bandNo (int) –

setMultiDirectional(self, isMultiDirectional: bool)

Sets whether to render using a multi-directional hillshade algorithm.

Parameters:

isMultiDirectional (bool) – set to True to use multi directional rendering

setZFactor(self, zfactor: float)

Set the Z scaling factor of the result image.

Parameters:

zfactor (float) – The z factor

See also

zFactor()

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) –

zFactor(self) float

Returns the Z scaling factor.

See also

setZFactor()

Return type:

float