QgsRelief Class Reference

Produces colored relief rasters from DEM. More...

#include <qgsrelief.h>

Classes
struct	ReliefColor

Public Member Functions
	QgsRelief (const QgsRelief &rh)=delete
	QgsRelief cannot be copied. More...
	QgsRelief (const QString &inputFile, const QString &outputFile, const QString &outputFormat)
	~QgsRelief ()
void	addReliefColorClass (const QgsRelief::ReliefColor &color)
QList< QgsRelief::ReliefColor >	calculateOptimizedReliefClasses ()
	Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression. More...
void	clearReliefColors ()
bool	exportFrequencyDistributionToCsv (const QString &file)
	Write frequency of elevation values to file for manual inspection. More...
QgsRelief &	operator= (const QgsRelief &rh)=delete
	QgsRelief cannot be copied. More...
int	processRaster (QgsFeedback *feedback=nullptr)
	Starts the calculation, reads from mInputFile and stores the result in mOutputFile. More...
QList< QgsRelief::ReliefColor >	reliefColors () const
void	setReliefColors (const QList< QgsRelief::ReliefColor > &c)
void	setZFactor (double factor)
double	zFactor () const

Detailed Description

Produces colored relief rasters from DEM.

Definition at line 38 of file qgsrelief.h.

Constructor & Destructor Documentation

QgsRelief() [1/2]

QgsRelief::QgsRelief	(	const QString &	inputFile,
		const QString &	outputFile,
		const QString &	outputFormat
	)

Definition at line 35 of file qgsrelief.cpp.

~QgsRelief()

QgsRelief::~QgsRelief ( )

default

QgsRelief() [2/2]

QgsRelief::QgsRelief ( const QgsRelief &  rh )

delete

QgsRelief cannot be copied.

Member Function Documentation

addReliefColorClass()

void QgsRelief::addReliefColorClass

(

const QgsRelief::ReliefColor &

color

)

Definition at line 56 of file qgsrelief.cpp.

calculateOptimizedReliefClasses()

QList< QgsRelief::ReliefColor > QgsRelief::calculateOptimizedReliefClasses

(

)

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

Returns

true in case of success

Definition at line 554 of file qgsrelief.cpp.

clearReliefColors()

void QgsRelief::clearReliefColors

(

)

Definition at line 51 of file qgsrelief.cpp.

exportFrequencyDistributionToCsv()

bool QgsRelief::exportFrequencyDistributionToCsv

(

const QString &

file

)

Write frequency of elevation values to file for manual inspection.

Definition at line 475 of file qgsrelief.cpp.

operator=()

QgsRelief& QgsRelief::operator= ( const QgsRelief &  rh )

delete

QgsRelief cannot be copied.

processRaster()

int QgsRelief::processRaster

(

QgsFeedback *

feedback = nullptr

)

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

Parameters

feedback

feedback object that receives update and that is checked for cancellation.

Returns

0 in case of success

Definition at line 72 of file qgsrelief.cpp.

reliefColors()

QList< QgsRelief::ReliefColor > QgsRelief::reliefColors ( ) const

inline

Definition at line 69 of file qgsrelief.h.

setReliefColors()

void QgsRelief::setReliefColors ( const QList< QgsRelief::ReliefColor > &  c )

inline

Definition at line 70 of file qgsrelief.h.

setZFactor()

void QgsRelief::setZFactor ( double  factor )

inline

Definition at line 65 of file qgsrelief.h.

zFactor()

double QgsRelief::zFactor ( ) const

inline

Definition at line 64 of file qgsrelief.h.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.16.0+99unstable/src/analysis/raster/qgsrelief.h
• /build/qgis-3.16.0+99unstable/src/analysis/raster/qgsrelief.cpp