QGIS API Documentation
3.0.2-Girona (307d082)
|
Base class for raster analysis methods that work with a 3x3 cell filter and calculate the value of each cell based on the cell value and the eight neighbour cells. More...
#include <qgsninecellfilter.h>
Public Member Functions | |
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 ()=default |
double | cellSizeX () const |
double | cellSizeY () const |
double | inputNodataValue () const |
double | outputNodataValue () const |
virtual float | processNineCellWindow (float *x11, float *x21, float *x31, float *x12, float *x22, float *x32, float *x13, float *x23, float *x33)=0 |
Calculates output value from nine input values. More... | |
int | processRaster (QgsFeedback *feedback=nullptr) |
Starts the calculation, reads from mInputFile and stores the result in mOutputFile. More... | |
void | setCellSizeX (double size) |
void | setCellSizeY (double size) |
void | setInputNodataValue (double value) |
void | setOutputNodataValue (double value) |
void | setZFactor (double factor) |
double | zFactor () const |
Protected Attributes | |
double | mCellSizeX = -1.0 |
double | mCellSizeY = -1.0 |
QString | mInputFile |
float | mInputNodataValue = -1.0 |
The nodata value of the input layer. More... | |
QString | mOutputFile |
QString | mOutputFormat |
float | mOutputNodataValue = -1.0 |
The nodata value of the output layer. More... | |
double | mZFactor = 1.0 |
Scale factor for z-value if x-/y- units are different to z-units (111120 for degree->meters and 370400 for degree->feet) More... | |
Base class for raster analysis methods that work with a 3x3 cell filter and calculate the value of each cell based on the cell value and the eight neighbour cells.
Common examples are slope and aspect calculation in DEMs. Subclasses only implement the method that calculates the new value from the nine values. Everything else (reading file, writing file) is done by this subclass
Definition at line 33 of file qgsninecellfilter.h.
QgsNineCellFilter::QgsNineCellFilter | ( | const QString & | inputFile, |
const QString & | outputFile, | ||
const QString & | outputFormat | ||
) |
Constructor that takes input file, output file and output format (GDAL string)
Definition at line 25 of file qgsninecellfilter.cpp.
|
virtualdefault |
|
inline |
Definition at line 46 of file qgsninecellfilter.h.
|
inline |
Definition at line 48 of file qgsninecellfilter.h.
|
inline |
Definition at line 54 of file qgsninecellfilter.h.
|
inline |
Definition at line 56 of file qgsninecellfilter.h.
|
pure virtual |
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
Implemented in QgsRuggednessFilter, QgsHillshadeFilter, QgsTotalCurvatureFilter, QgsAspectFilter, QgsSlopeFilter, and QgsDerivativeFilter.
int QgsNineCellFilter::processRaster | ( | QgsFeedback * | feedback = nullptr | ) |
Starts the calculation, reads from mInputFile and stores the result in mOutputFile.
feedback | feedback object that receives update and that is checked for cancelation. |
Definition at line 33 of file qgsninecellfilter.cpp.
|
inline |
Definition at line 47 of file qgsninecellfilter.h.
|
inline |
Definition at line 49 of file qgsninecellfilter.h.
|
inline |
Definition at line 55 of file qgsninecellfilter.h.
|
inline |
Definition at line 57 of file qgsninecellfilter.h.
|
inline |
Definition at line 52 of file qgsninecellfilter.h.
|
inline |
Definition at line 51 of file qgsninecellfilter.h.
|
protected |
Definition at line 89 of file qgsninecellfilter.h.
|
protected |
Definition at line 90 of file qgsninecellfilter.h.
|
protected |
Definition at line 85 of file qgsninecellfilter.h.
|
protected |
The nodata value of the input layer.
Definition at line 92 of file qgsninecellfilter.h.
|
protected |
Definition at line 86 of file qgsninecellfilter.h.
|
protected |
Definition at line 87 of file qgsninecellfilter.h.
|
protected |
The nodata value of the output layer.
Definition at line 94 of file qgsninecellfilter.h.
|
protected |
Scale factor for z-value if x-/y- units are different to z-units (111120 for degree->meters and 370400 for degree->feet)
Definition at line 96 of file qgsninecellfilter.h.