QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Member Functions | List of all members
QgsRelief Class Reference

Produces coloured 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 coloured relief rasters from DEM.

Definition at line 33 of file qgsrelief.h.

Constructor & Destructor Documentation

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

Definition at line 36 of file qgsrelief.cpp.

QgsRelief::~QgsRelief ( )

Definition at line 49 of file qgsrelief.cpp.

Member Function Documentation

void QgsRelief::addReliefColorClass ( const ReliefColor color)

Definition at line 63 of file qgsrelief.cpp.

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

void QgsRelief::clearReliefColors ( )

Definition at line 58 of file qgsrelief.cpp.

bool QgsRelief::exportFrequencyDistributionToCsv ( const QString &  file)

Write frequency of elevation values to file for manual inspection.

Definition at line 481 of file qgsrelief.cpp.

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

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

Definition at line 57 of file qgsrelief.h.

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

Definition at line 58 of file qgsrelief.h.

void QgsRelief::setZFactor ( double  factor)
inline

Definition at line 53 of file qgsrelief.h.

double QgsRelief::zFactor ( ) const
inline

Definition at line 52 of file qgsrelief.h.


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