Subgroup: other
Class: QgsNineCellFilter¶
-
class
qgis.analysis.
QgsNineCellFilter
¶ Bases:
sip.wrapper
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*
Methods
cellSizeX
cellSizeY
inputNodataValue
outputNodataValue
processNineCellWindow
Calculates output value from nine input values. processRaster
Starts the calculation, reads from mInputFile and stores the result in mOutputFile setCellSizeX
setCellSizeY
setInputNodataValue
setOutputNodataValue
setZFactor
zFactor
Attributes
-
cellSizeX
(self) → float¶
-
cellSizeY
(self) → float¶
-
inputNodataValue
(self) → float¶
-
outputNodataValue
(self) → float¶
-
processNineCellWindow
(self) → Tuple[float, float, float, float, float, float, float, float, float, float]¶ 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*
-
processRaster
(self, feedback: QgsFeedback = None) → int¶ Starts the calculation, reads from mInputFile and stores the result in mOutputFile
Parameters: feedback – feedback object that receives update and that is checked for cancelation. Returns: 0 in case of success*
-
setCellSizeX
(self, size: float)¶
-
setCellSizeY
(self, size: float)¶
-
setInputNodataValue
(self, value: float)¶
-
setOutputNodataValue
(self, value: float)¶
-
setZFactor
(self, factor: float)¶
-
zFactor
(self) → float¶
-