QGIS API Documentation  2.5.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 ()
 
int processRaster (QProgressDialog *p)
 Starts the calculation, reads from mInputFile and stores the result in mOutputFile. More...
 
double zFactor () const
 
void setZFactor (double factor)
 
void clearReliefColors ()
 
void addReliefColorClass (const ReliefColor &color)
 
const QList< ReliefColor > & reliefColors () const
 
void setReliefColors (const QList< ReliefColor > &c)
 
QList< ReliefColorcalculateOptimizedReliefClasses ()
 Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression. More...
 
bool exportFrequencyDistributionToCsv (const QString &file)
 Write frequency of elevation values to file for manual inspection. More...
 

Detailed Description

Produces coloured relief rasters from DEM.

Constructor & Destructor Documentation

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

Member Function Documentation

void QgsRelief::addReliefColorClass ( const ReliefColor color)
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
void QgsRelief::clearReliefColors ( )
bool QgsRelief::exportFrequencyDistributionToCsv ( const QString &  file)

Write frequency of elevation values to file for manual inspection.

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
const QList< ReliefColor >& QgsRelief::reliefColors ( ) const
inline
void QgsRelief::setReliefColors ( const QList< ReliefColor > &  c)
inline
void QgsRelief::setZFactor ( double  factor)
inline
double QgsRelief::zFactor ( ) const
inline

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