QGIS API Documentation  2.99.0-Master (ba079d8)
Classes | Public Member Functions | List of all members
QgsRelief Class Reference

Produces colored relief rasters from DEM. More...

#include <qgsrelief.h>

Classes

struct  ReliefColor
 

Public Member Functions

 QgsRelief (const QString &inputFile, const QString &outputFile, const QString &outputFormat)
 
 QgsRelief (const QgsRelief &rh)=delete
 QgsRelief cannot be copied. More...
 
 ~QgsRelief ()
 
void addReliefColorClass (const ReliefColor &color)
 
QList< ReliefColorcalculateOptimizedReliefClasses ()
 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...
 
QgsReliefoperator= (const QgsRelief &rh)=delete
 QgsRelief cannot be copied. More...
 
int processRaster (QProgressDialog *p)
 Starts the calculation, reads from mInputFile and stores the result in mOutputFile. More...
 
QList< ReliefColorreliefColors () const
 
void setReliefColors (const QList< ReliefColor > &c)
 
void setZFactor (double factor)
 
double zFactor () const
 

Detailed Description

Produces colored relief rasters from DEM.

Definition at line 35 of file qgsrelief.h.

Constructor & Destructor Documentation

◆ QgsRelief() [1/2]

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

Definition at line 31 of file qgsrelief.cpp.

◆ ~QgsRelief()

QgsRelief::~QgsRelief ( )

Definition at line 51 of file qgsrelief.cpp.

◆ QgsRelief() [2/2]

QgsRelief::QgsRelief ( const QgsRelief rh)
delete

QgsRelief cannot be copied.

Member Function Documentation

◆ addReliefColorClass()

void QgsRelief::addReliefColorClass ( const ReliefColor color)

Definition at line 65 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 585 of file qgsrelief.cpp.

◆ clearReliefColors()

void QgsRelief::clearReliefColors ( )

Definition at line 60 of file qgsrelief.cpp.

◆ exportFrequencyDistributionToCsv()

bool QgsRelief::exportFrequencyDistributionToCsv ( const QString &  file)

Write frequency of elevation values to file for manual inspection.

Definition at line 500 of file qgsrelief.cpp.

◆ operator=()

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

QgsRelief cannot be copied.

◆ processRaster()

int QgsRelief::processRaster ( QProgressDialog *  p)

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

Parameters
pprogress dialog that receives update and that is checked for abort. 0 if no progress bar is needed.
Returns
0 in case of success

Definition at line 81 of file qgsrelief.cpp.

◆ reliefColors()

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

Definition at line 64 of file qgsrelief.h.

◆ setReliefColors()

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

Definition at line 65 of file qgsrelief.h.

◆ setZFactor()

void QgsRelief::setZFactor ( double  factor)
inline

Definition at line 60 of file qgsrelief.h.

◆ zFactor()

double QgsRelief::zFactor ( ) const
inline

Definition at line 59 of file qgsrelief.h.


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