allow to pass additional parameters to the clip raster by mask algorithm

qgis · Jun 25, 2019 · 0128135 · 0128135
1 parent d40d040
commit 0128135
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 0 deletions.
diff --git a/python/plugins/processing/algs/gdal/ClipRasterByMask.py b/python/plugins/processing/algs/gdal/ClipRasterByMask.py
@@ -59,6 +59,7 @@ class ClipRasterByMask(GdalAlgorithm):
     OPTIONS = 'OPTIONS'
     DATA_TYPE = 'DATA_TYPE'
     MULTITHREADING = 'MULTITHREADING'
+    EXTRA = 'EXTRA'
     OUTPUT = 'OUTPUT'
 
     def __init__(self):
@@ -106,11 +107,13 @@ def initAlgorithm(self, config=None):
                                                        type=QgsProcessingParameterNumber.Double,
                                                        defaultValue=None,
                                                        optional=True))
+
         multithreading_param = QgsProcessingParameterBoolean(self.MULTITHREADING,
                                                              self.tr('Use multithreaded warping implementation'),
                                                              defaultValue=False)
         multithreading_param.setFlags(multithreading_param.flags() | QgsProcessingParameterDefinition.FlagAdvanced)
         self.addParameter(multithreading_param)
+
         options_param = QgsProcessingParameterString(self.OPTIONS,
                                                      self.tr('Additional creation options'),
                                                      defaultValue='',
@@ -129,6 +132,13 @@ def initAlgorithm(self, config=None):
         dataType_param.setFlags(dataType_param.flags() | QgsProcessingParameterDefinition.FlagAdvanced)
         self.addParameter(dataType_param)
 
+        extra_param = QgsProcessingParameterString(self.EXTRA,
+                                                   self.tr('Additional command-line parameters'),
+                                                   defaultValue=None,
+                                                   optional=True)
+        extra_param.setFlags(extra_param.flags() | QgsProcessingParameterDefinition.FlagAdvanced)
+        self.addParameter(extra_param)
+
         self.addParameter(QgsProcessingParameterRasterDestination(self.OUTPUT,
                                                                   self.tr('Clipped (mask)')))
 
@@ -223,6 +233,10 @@ def getConsoleCommands(self, parameters, context, feedback, executing=True):
         if options:
             arguments.extend(GdalUtils.parseCreationOptions(options))
 
+        if self.EXTRA in parameters and parameters[self.EXTRA] not in (None, ''):
+            extra = self.parameterAsString(parameters, self.EXTRA, context)
+            arguments.append(extra)
+
         arguments.append(inLayer.source())
         arguments.append(out)
 

diff --git a/python/plugins/processing/tests/GdalAlgorithmsTest.py b/python/plugins/processing/tests/GdalAlgorithmsTest.py
@@ -649,6 +649,29 @@ def testClipRasterByMask(self):
                  '-ot Float32 -of JPEG -cutline ' +
                  mask + ' -crop_to_cutline -dstnodata 0.0 ' + source + ' ' +
                  outdir + '/check.jpg'])
+            # with creation options
+            self.assertEqual(
+                alg.getConsoleCommands({'INPUT': source,
+                                        'MASK': mask,
+                                        'OPTIONS': 'COMPRESS=DEFLATE|PREDICTOR=2|ZLEVEL=9',
+                                        'OUTPUT': outdir + '/check.jpg'}, context, feedback),
+                ['gdalwarp',
+                 '-of JPEG -cutline ' +
+                 mask + ' -crop_to_cutline -co COMPRESS=DEFLATE -co PREDICTOR=2 -co ZLEVEL=9 ' +
+                 source + ' ' +
+                 outdir + '/check.jpg'])
+            # with multothreading and additional parameters
+            self.assertEqual(
+                alg.getConsoleCommands({'INPUT': source,
+                                        'MASK': mask,
+                                        'MULTITHREADING': True,
+                                        'EXTRA': '-nosrcalpha -wm 2048 -nomd',
+                                        'OUTPUT': outdir + '/check.jpg'}, context, feedback),
+                ['gdalwarp',
+                 '-of JPEG -cutline ' +
+                 mask + ' -crop_to_cutline -multi -nosrcalpha -wm 2048 -nomd ' +
+                 source + ' ' +
+                 outdir + '/check.jpg'])
 
     def testContour(self):
         context = QgsProcessingContext()