Class: QgsRelief

Produces colored relief rasters from DEM.

Methods

addReliefColorClass

calculateOptimizedReliefClasses

Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression

clearReliefColors

exportFrequencyDistributionToCsv

Write frequency of elevation values to file for manual inspection

processRaster

Starts the calculation, reads from mInputFile and stores the result in mOutputFile

reliefColors

setReliefColors

setZFactor

zFactor

class qgis.analysis.QgsRelief[source]

Bases: object

class ReliefColor(c: QColor | Qt.GlobalColor, min: float, max: float)
class ReliefColor(a0: QgsRelief.ReliefColor)

Bases: object

maxElevation
minElevation
addReliefColorClass(self, color: QgsRelief.ReliefColor)[source]
Parameters:

color (QgsRelief.ReliefColor)

calculateOptimizedReliefClasses(self) List[QgsRelief.ReliefColor]

Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression

Return type:

List[QgsRelief.ReliefColor]

Returns:

True in case of success

clearReliefColors(self)[source]
exportFrequencyDistributionToCsv(self, file: str | None) bool[source]

Write frequency of elevation values to file for manual inspection

Parameters:

file (Optional[str])

Return type:

bool

processRaster(self, feedback: QgsFeedback | None = None) int[source]

Starts the calculation, reads from mInputFile and stores the result in mOutputFile

Parameters:

feedback (Optional[QgsFeedback] = None) – feedback object that receives update and that is checked for cancellation.

Return type:

int

Returns:

0 in case of success

reliefColors(self) List[QgsRelief.ReliefColor]
Return type:

List[QgsRelief.ReliefColor]

setReliefColors(self, c: Iterable[QgsRelief.ReliefColor])[source]
Parameters:

c (Iterable[QgsRelief.ReliefColor])

setZFactor(self, factor: float)[source]
Parameters:

factor (float)

zFactor(self) float[source]
Return type:

float