QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
Public Member Functions | List of all members
QgsHillshadeFilter Class Reference

#include <qgshillshadefilter.h>

Inheritance diagram for QgsHillshadeFilter:
Inheritance graph
[legend]

Public Member Functions

 QgsHillshadeFilter (const QString &inputFile, const QString &outputFile, const QString &outputFormat, double lightAzimuth=300, double lightAngle=40)
 
 ~QgsHillshadeFilter ()
 
float lightAngle () const
 
float lightAzimuth () const
 
float processNineCellWindow (float *x11, float *x21, float *x31, float *x12, float *x22, float *x32, float *x13, float *x23, float *x33) override
 Calculates output value from nine input values. More...
 
void setLightAngle (float angle)
 
void setLightAzimuth (float azimuth)
 
- Public Member Functions inherited from QgsDerivativeFilter
 QgsDerivativeFilter (const QString &inputFile, const QString &outputFile, const QString &outputFormat)
 
virtual ~QgsDerivativeFilter ()
 
- 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 ()
 
double cellSizeX () const
 
double cellSizeY () const
 
double inputNodataValue () const
 
double outputNodataValue () const
 
int processRaster (QProgressDialog *p)
 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
 

Additional Inherited Members

- Protected Member Functions inherited from QgsDerivativeFilter
float calcFirstDerX (float *x11, float *x21, float *x31, float *x12, float *x22, float *x32, float *x13, float *x23, float *x33)
 Calculates the first order derivative in x-direction according to Horn (1981) More...
 
float calcFirstDerY (float *x11, float *x21, float *x31, float *x12, float *x22, float *x32, float *x13, float *x23, float *x33)
 Calculates the first order derivative in y-direction according to Horn (1981) More...
 
- Protected Attributes inherited from QgsNineCellFilter
double mCellSizeX
 
double mCellSizeY
 
QString mInputFile
 
float mInputNodataValue
 The nodata value of the input layer. More...
 
QString mOutputFile
 
QString mOutputFormat
 
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

Definition at line 26 of file qgshillshadefilter.h.

Constructor & Destructor Documentation

◆ QgsHillshadeFilter()

QgsHillshadeFilter::QgsHillshadeFilter ( const QString inputFile,
const QString outputFile,
const QString outputFormat,
double  lightAzimuth = 300,
double  lightAngle = 40 
)

Definition at line 20 of file qgshillshadefilter.cpp.

◆ ~QgsHillshadeFilter()

QgsHillshadeFilter::~QgsHillshadeFilter ( )

Definition at line 28 of file qgshillshadefilter.cpp.

Member Function Documentation

◆ lightAngle()

float QgsHillshadeFilter::lightAngle ( ) const
inline

Definition at line 41 of file qgshillshadefilter.h.

◆ lightAzimuth()

float QgsHillshadeFilter::lightAzimuth ( ) const
inline

Definition at line 39 of file qgshillshadefilter.h.

◆ processNineCellWindow()

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

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 QgsDerivativeFilter.

Definition at line 32 of file qgshillshadefilter.cpp.

◆ setLightAngle()

void QgsHillshadeFilter::setLightAngle ( float  angle)
inline

Definition at line 42 of file qgshillshadefilter.h.

◆ setLightAzimuth()

void QgsHillshadeFilter::setLightAzimuth ( float  azimuth)
inline

Definition at line 40 of file qgshillshadefilter.h.


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