QGIS API Documentation  2.3.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
QgsRuggednessFilter Class Reference

Calculates the ruggedness index based on a 3x3 moving window. More...

#include <qgsruggednessfilter.h>

Inheritance diagram for QgsRuggednessFilter:
Inheritance graph
[legend]
Collaboration diagram for QgsRuggednessFilter:
Collaboration graph
[legend]

Public Member Functions

 QgsRuggednessFilter (const QString &inputFile, const QString &outputFile, const QString &outputFormat)
 
 ~QgsRuggednessFilter ()
 
- Public Member Functions inherited from QgsNineCellFilter
 QgsNineCellFilter (const QString &inputFile, const QString &outputFile, const QString &outputFormat)
 Constructor that takes input file, output file and output format (GDAL string) More...
 
virtual ~QgsNineCellFilter ()
 
int processRaster (QProgressDialog *p)
 Starts the calculation, reads from mInputFile and stores the result in mOutputFile. More...
 
double cellSizeX () const
 
void setCellSizeX (double size)
 
double cellSizeY () const
 
void setCellSizeY (double size)
 
double zFactor () const
 
void setZFactor (double factor)
 
double inputNodataValue () const
 
void setInputNodataValue (double value)
 
double outputNodataValue () const
 
void setOutputNodataValue (double value)
 

Protected Member Functions

float processNineCellWindow (float *x11, float *x21, float *x31, float *x12, float *x22, float *x32, float *x13, float *x23, float *x33)
 Calculates output value from nine input values. More...
 

Private Member Functions

 QgsRuggednessFilter ()
 

Additional Inherited Members

- Protected Attributes inherited from QgsNineCellFilter
QString mInputFile
 
QString mOutputFile
 
QString mOutputFormat
 
double mCellSizeX
 
double mCellSizeY
 
float mInputNodataValue
 The nodata value of the input layer. More...
 
float mOutputNodataValue
 The nodata value of the output layer. More...
 
double mZFactor
 Scale factor for z-value if x-/y- units are different to z-units (111120 for degree->meters and 370400 for degree->feet) More...
 

Detailed Description

Calculates the ruggedness index based on a 3x3 moving window.

Algorithm from Riley et al. 1999: A terrain ruggedness index that quantifies topographic heterogeneity

Definition at line 25 of file qgsruggednessfilter.h.

Constructor & Destructor Documentation

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

Definition at line 20 of file qgsruggednessfilter.cpp.

QgsRuggednessFilter::~QgsRuggednessFilter ( )

Definition at line 31 of file qgsruggednessfilter.cpp.

QgsRuggednessFilter::QgsRuggednessFilter ( )
private

Definition at line 25 of file qgsruggednessfilter.cpp.

Member Function Documentation

float QgsRuggednessFilter::processNineCellWindow ( float *  x11,
float *  x21,
float *  x31,
float *  x12,
float *  x22,
float *  x32,
float *  x13,
float *  x23,
float *  x33 
)
protectedvirtual

Calculates output value from nine input values.

The input values and the output value can be equal to the nodata value if not present or outside of the border. Must be implemented by subclasses

Implements QgsNineCellFilter.

Definition at line 36 of file qgsruggednessfilter.cpp.

References QgsNineCellFilter::mInputNodataValue, and QgsNineCellFilter::mOutputNodataValue.


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