Merge pull request #2781 from medspx/processing_grass7_rnull

[processing] add r.null GRASS7 algorithm (fix #6893)
qgis · Mar 2, 2016 · 91e222e · 91e222e
2 parents b2189f2 + 4772837
commit 91e222e
Show file tree

Hide file tree

Showing 2 changed files with 104 additions and 0 deletions.
diff --git a/python/plugins/processing/algs/grass7/description/r.null.txt b/python/plugins/processing/algs/grass7/description/r.null.txt
@@ -0,0 +1,12 @@
+r.null
+Manages NULL-values of given raster map.
+Raster (r.*)
+ParameterRaster|map|Name of raster map for which to edit null values|False
+ParameterString|setnull|List of cell values to be set to NULL|None|False|True
+ParameterString|null|The value to replace the null value by|None|False|True
+*ParameterBoolean|-f|Only do the work if the map is floating-point|False|True
+*ParameterBoolean|-i|Only do the work if the map is integer|False|True
+*ParameterBoolean|-n|Only do the work if the map doesn't have a NULL-value bitmap file|False|True
+*ParameterBoolean|-c|Create NULL-value bitmap file validating all data cells|False|True
+*ParameterBoolean|-r|Remove NULL-value bitmap file|False|True
+OutputRaster|output|NullRaster
diff --git a/python/plugins/processing/algs/grass7/ext/r_null.py b/python/plugins/processing/algs/grass7/ext/r_null.py
@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*-
+
+"""
+***************************************************************************
+    r_null.py
+    ---------------------
+    Date                 : February 2016
+    Copyright            : (C) 2016 by Médéric Ribreux
+    Email                : medspx at medspx dot fr
+***************************************************************************
+*                                                                         *
+*   This program is free software; you can redistribute it and/or modify  *
+*   it under the terms of the GNU General Public License as published by  *
+*   the Free Software Foundation; either version 2 of the License, or     *
+*   (at your option) any later version.                                   *
+*                                                                         *
+***************************************************************************
+"""
+
+__author__ = 'Médéric Ribreux'
+__date__ = 'February 2016'
+__copyright__ = '(C) 2016, Médéric Ribreux'
+
+# This will get replaced with a git SHA1 when you do a git archive
+
+__revision__ = '$Format:%H$'
+
+import os
+
+
+def checkParameterValuesBeforeExecuting(alg):
+    """ Verify if we have the right parameters """
+    if alg.getParameterValue(u'setnull') or alg.getParameterValue(u'null'):
+        return None
+
+    return alg.tr("You need to set at least 'setnull' or 'null' parameters for this algorithm !")
+
+
+def processInputs(alg):
+    """Prepare the GRASS import commands"""
+    inputRaster = alg.getParameterValue(u'map')
+    if inputRaster in alg.exportedLayers.keys():
+        return
+    else:
+        alg.setSessionProjectionFromLayer(inputRaster, alg.commands)
+
+    destFilename = alg.getTempFilename()
+    alg.exportedLayers[inputRaster] = destFilename
+    command = 'r.in.gdal input={} output={} band=1 --overwrite -o'.format(inputRaster, destFilename)
+    alg.commands.append(command)
+
+    alg.setSessionProjectionFromProject(alg.commands)
+
+    region = unicode(alg.getParameterValue(alg.GRASS_REGION_EXTENT_PARAMETER))
+    regionCoords = region.split(',')
+    command = 'g.region'
+    command += ' -a'
+    command += ' n=' + unicode(regionCoords[3])
+    command += ' s=' + unicode(regionCoords[2])
+    command += ' e=' + unicode(regionCoords[1])
+    command += ' w=' + unicode(regionCoords[0])
+    cellsize = alg.getParameterValue(alg.GRASS_REGION_CELLSIZE_PARAMETER)
+    if cellsize:
+        command += ' res=' + unicode(cellsize)
+    else:
+        command += ' res=' + unicode(alg.getDefaultCellsize())
+    alignToResolution = alg.getParameterValue(alg.GRASS_REGION_ALIGN_TO_RESOLUTION)
+    if alignToResolution:
+        command += ' -a'
+    alg.commands.append(command)
+
+
+def processCommand(alg):
+    # We temporary remove the output 'sequence'
+    output = alg.getOutputFromName(u'output')
+    alg.removeOutputFromName(u'output')
+
+    # Launch the algorithm
+    alg.processCommand()
+
+    # We re-add the previous output
+    alg.addOutput(output)
+
+
+def processOutputs(alg):
+    output = alg.getOutputValue(u'output')
+    command = u"r.out.gdal -c createopt=\"TFW=YES,COMPRESS=LZW\" input={} output=\"{}\" --overwrite".format(
+        alg.exportedLayers[alg.getParameterValue(u'map')],
+        output
+    )
+    alg.commands.append(command)
+    alg.outputCommands.append(command)