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>

Inheritance diagram for QgsNineCellFilter:

[legend]

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)
virtual	~QgsNineCellFilter ()
int	processRaster (QProgressDialog *p)
	Starts the calculation, reads from mInputFile and stores the result in mOutputFile.
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)
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.

Protected Attributes
QString	mInputFile
QString	mOutputFile
QString	mOutputFormat
double	mCellSizeX
double	mCellSizeY
float	mInputNodataValue
	The nodata value of the input layer.
float	mOutputNodataValue
	The nodata value of the output layer.
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)

Private Member Functions
	QgsNineCellFilter ()
GDALDatasetH	openInputFile (int &nCellsX, int &nCellsY)
	Opens the input file and returns the dataset handle and the number of pixels in x-/y- direction.
GDALDriverH	openOutputDriver ()
	Opens the output driver and tests if it supports the creation of a new dataset.
GDALDatasetH	openOutputFile (GDALDatasetH inputDataset, GDALDriverH outputDriver)
	Opens the output file and sets the same geotransform and CRS as the input data.

Detailed Description

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 30 of file qgsninecellfilter.h.

Constructor & Destructor Documentation

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 29 of file qgsninecellfilter.cpp.

QgsNineCellFilter::~QgsNineCellFilter ( )

virtual

Definition at line 41 of file qgsninecellfilter.cpp.

QgsNineCellFilter::QgsNineCellFilter ( )

private

Definition at line 36 of file qgsninecellfilter.cpp.

Member Function Documentation

double QgsNineCellFilter::cellSizeX ( ) const

inline

Definition at line 41 of file qgsninecellfilter.h.

double QgsNineCellFilter::cellSizeY ( ) const

inline

Definition at line 43 of file qgsninecellfilter.h.

double QgsNineCellFilter::inputNodataValue ( ) const

inline

Definition at line 49 of file qgsninecellfilter.h.

GDALDatasetH QgsNineCellFilter::openInputFile	(	int &	nCellsX,
		int &	nCellsY
	)

private

Opens the input file and returns the dataset handle and the number of pixels in x-/y- direction.

Definition at line 199 of file qgsninecellfilter.cpp.

References mInputFile, and TO8F.

Referenced by processRaster().

GDALDriverH QgsNineCellFilter::openOutputDriver ( )

private

Opens the output driver and tests if it supports the creation of a new dataset.

Returns: NULL on error and the driver handle on success

Definition at line 217 of file qgsninecellfilter.cpp.

References mOutputFormat.

Referenced by processRaster().

GDALDatasetH QgsNineCellFilter::openOutputFile	(	GDALDatasetH	inputDataset,
		GDALDriverH	outputDriver
	)

private

Opens the output file and sets the same geotransform and CRS as the input data.

Returns: the output dataset or NULL in case of error

Definition at line 238 of file qgsninecellfilter.cpp.

References mCellSizeX, mCellSizeY, mOutputFile, and TO8F.

Referenced by processRaster().

double QgsNineCellFilter::outputNodataValue ( ) const

inline

Definition at line 51 of file qgsninecellfilter.h.

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