QGIS API Documentation  2.17.0-Master (0497e4a)
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 ()
 
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...
 
int processRaster (QProgressDialog *p)
 Starts the calculation, reads from mInputFile and stores the result in mOutputFile. More...
 
const QList< ReliefColor > & reliefColors () 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 34 of file qgsrelief.h.

Constructor & Destructor Documentation

§ QgsRelief()

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

Definition at line 37 of file qgsrelief.cpp.

§ ~QgsRelief()

QgsRelief::~QgsRelief ( )

Definition at line 57 of file qgsrelief.cpp.

Member Function Documentation

§ addReliefColorClass()

void QgsRelief::addReliefColorClass ( const ReliefColor color)

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

§ clearReliefColors()

void QgsRelief::clearReliefColors ( )

Definition at line 66 of file qgsrelief.cpp.

§ exportFrequencyDistributionToCsv()

bool QgsRelief::exportFrequencyDistributionToCsv ( const QString file)

Write frequency of elevation values to file for manual inspection.

Definition at line 506 of file qgsrelief.cpp.

§ 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 87 of file qgsrelief.cpp.

§ reliefColors()

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

Definition at line 58 of file qgsrelief.h.

§ setReliefColors()

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

Definition at line 59 of file qgsrelief.h.

§ setZFactor()

void QgsRelief::setZFactor ( double  factor)
inline

Definition at line 54 of file qgsrelief.h.

§ zFactor()

double QgsRelief::zFactor ( ) const
inline

Definition at line 53 of file qgsrelief.h.


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