Class: QgsHillshadeRenderer

A renderer for generating live hillshade models.

Class Hierarchy

Base classes

QgsRasterRenderer	Raster renderer pipe that applies colors to a raster.
QgsRasterInterface	Base class for processing filters like renderers, reprojector, resampler etc.

class qgis.core.QgsHillshadeRenderer

Bases: QgsRasterRenderer

__init__(input: QgsRasterInterface | None, band: int, lightAzimuth: float, lightAltitude: float)

A renderer for generating live hillshade models.

Parameters:

• input (Optional[QgsRasterInterface]) – The input raster interface

• band (int) – The band in the raster to use

• lightAzimuth (float) – The azimuth of the light source

• lightAltitude (float) – The altitude of the light source

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

Deprecated since version 3.38: Use inputBand() instead.

Return type:

int

static create(elem: QDomElement, input: QgsRasterInterface | None) → QgsRasterRenderer | None

Factory method to create a new renderer

Parameters:

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

• input (Optional[QgsRasterInterface]) – The raster input interface.

Return type:

Optional[QgsRasterRenderer]

Returns:

A new QgsHillshadeRenderer.

multiDirectional(self) → bool

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

See also

setMultiDirectional()

Return type:

bool

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

Deprecated since version 3.38: Use setInputBand() instead.

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

See also

multiDirectional()

setZFactor(self, zfactor: float)

Set the Z scaling factor of the result image.

Parameters:

zfactor (float) – The z factor

See also

zFactor()

zFactor(self) → float

Returns the Z scaling factor.

See also

setZFactor()

Return type:

float