mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-03 00:14:12 -05:00
379 lines
17 KiB
Python
379 lines
17 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
SagaAlgorithm.py
|
|
---------------------
|
|
Date : August 2012
|
|
Copyright : (C) 2012 by Victor Olaya
|
|
Email : volayaf at gmail dot com
|
|
***************************************************************************
|
|
* *
|
|
* 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. *
|
|
* *
|
|
***************************************************************************
|
|
"""
|
|
from future import standard_library
|
|
standard_library.install_aliases()
|
|
from builtins import str
|
|
from builtins import range
|
|
|
|
|
|
__author__ = 'Victor Olaya'
|
|
__date__ = 'August 2012'
|
|
__copyright__ = '(C) 2012, Victor Olaya'
|
|
|
|
# This will get replaced with a git SHA1 when you do a git archive
|
|
|
|
__revision__ = '$Format:%H$'
|
|
|
|
import os
|
|
import importlib
|
|
from qgis.PyQt.QtCore import QCoreApplication
|
|
from qgis.PyQt.QtGui import QIcon
|
|
from qgis.core import (QgsProcessingUtils,
|
|
QgsMessageLog)
|
|
from processing.core.GeoAlgorithm import GeoAlgorithm
|
|
from processing.core.ProcessingConfig import ProcessingConfig
|
|
from processing.core.GeoAlgorithmExecutionException import GeoAlgorithmExecutionException
|
|
from processing.core.parameters import (getParameterFromString,
|
|
ParameterExtent,
|
|
ParameterRaster,
|
|
ParameterVector,
|
|
ParameterTable,
|
|
ParameterMultipleInput,
|
|
ParameterBoolean,
|
|
ParameterFixedTable,
|
|
ParameterNumber,
|
|
ParameterSelection)
|
|
from processing.core.outputs import (getOutputFromString,
|
|
OutputVector,
|
|
OutputRaster)
|
|
from processing.tools import dataobjects
|
|
from processing.algs.help import shortHelp
|
|
from processing.tools.system import getTempFilename
|
|
from processing.algs.saga.SagaNameDecorator import decoratedAlgorithmName, decoratedGroupName
|
|
from . import SagaUtils
|
|
|
|
pluginPath = os.path.normpath(os.path.join(
|
|
os.path.split(os.path.dirname(__file__))[0], os.pardir))
|
|
|
|
sessionExportedLayers = {}
|
|
|
|
|
|
class SagaAlgorithm(GeoAlgorithm):
|
|
|
|
OUTPUT_EXTENT = 'OUTPUT_EXTENT'
|
|
|
|
def __init__(self, descriptionfile):
|
|
GeoAlgorithm.__init__(self)
|
|
self.hardcodedStrings = []
|
|
self.allowUnmatchingGridExtents = False
|
|
self.descriptionFile = descriptionfile
|
|
self.defineCharacteristicsFromFile()
|
|
self._icon = None
|
|
self._name = ''
|
|
self._display_name = ''
|
|
self._group = ''
|
|
|
|
def icon(self):
|
|
if self._icon is None:
|
|
self._icon = QIcon(os.path.join(pluginPath, 'images', 'saga.png'))
|
|
return self._icon
|
|
|
|
def name(self):
|
|
return self._name
|
|
|
|
def displayName(self):
|
|
return self._display_name
|
|
|
|
def group(self):
|
|
return self._group
|
|
|
|
def shortHelpString(self):
|
|
return shortHelp.get(self.id(), None)
|
|
|
|
def defineCharacteristicsFromFile(self):
|
|
with open(self.descriptionFile) as lines:
|
|
line = lines.readline().strip('\n').strip()
|
|
self._name = line
|
|
if '|' in self._name:
|
|
tokens = self._name.split('|')
|
|
self._name = tokens[0]
|
|
# cmdname is the name of the algorithm in SAGA, that is, the name to use to call it in the console
|
|
self.cmdname = tokens[1]
|
|
|
|
else:
|
|
self.cmdname = self._name
|
|
self._display_name = QCoreApplication.translate("SAGAAlgorithm", str(self._name))
|
|
self._name = decoratedAlgorithmName(self._name)
|
|
self._display_name = QCoreApplication.translate("SAGAAlgorithm", str(self._name))
|
|
|
|
self._name = self._name.lower()
|
|
validChars = \
|
|
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789:'
|
|
self._name = ''.join(c for c in self._name if c in validChars)
|
|
|
|
line = lines.readline().strip('\n').strip()
|
|
self.undecoratedGroup = line
|
|
self._group = QCoreApplication.translate("SAGAAlgorithm", decoratedGroupName(self.undecoratedGroup))
|
|
line = lines.readline().strip('\n').strip()
|
|
while line != '':
|
|
if line.startswith('Hardcoded'):
|
|
self.hardcodedStrings.append(line[len('Hardcoded|'):])
|
|
elif line.startswith('Parameter'):
|
|
self.addParameter(getParameterFromString(line))
|
|
elif line.startswith('AllowUnmatching'):
|
|
self.allowUnmatchingGridExtents = True
|
|
elif line.startswith('Extent'):
|
|
# An extent parameter that wraps 4 SAGA numerical parameters
|
|
self.extentParamNames = line[6:].strip().split(' ')
|
|
self.addParameter(ParameterExtent(self.OUTPUT_EXTENT,
|
|
'Output extent'))
|
|
else:
|
|
self.addOutput(getOutputFromString(line))
|
|
line = lines.readline().strip('\n').strip()
|
|
|
|
def processAlgorithm(self, parameters, context, feedback):
|
|
commands = list()
|
|
self.exportedLayers = {}
|
|
|
|
self.preProcessInputs()
|
|
|
|
# 1: Export rasters to sgrd and vectors to shp
|
|
# Tables must be in dbf format. We check that.
|
|
for param in self.parameterDefinitions():
|
|
if isinstance(param, ParameterRaster):
|
|
if param.name() not in parameters or parameters[param.name()] is None:
|
|
continue
|
|
if parameters[param.name()].endswith('sdat'):
|
|
parameters[param.name()] = parameters[param.name()][:-4] + "sgrd"
|
|
elif not parameters[param.name()].endswith('sgrd'):
|
|
exportCommand = self.exportRasterLayer(parameters[param.name()])
|
|
if exportCommand is not None:
|
|
commands.append(exportCommand)
|
|
if isinstance(param, ParameterVector):
|
|
if param.name() not in parameters or parameters[param.name()] is None:
|
|
continue
|
|
layer = QgsProcessingUtils.mapLayerFromString(parameters[param.name()], context, False)
|
|
if layer:
|
|
filename = dataobjects.exportVectorLayer(layer)
|
|
self.exportedLayers[param.value] = filename
|
|
elif not parameteres[param.name()].endswith('shp'):
|
|
raise GeoAlgorithmExecutionException(
|
|
self.tr('Unsupported file format'))
|
|
if isinstance(param, ParameterTable):
|
|
if param.name() not in parameters or parameters[param.name()] is None:
|
|
continue
|
|
table = QgsProcessingUtils.mapLayerFromString(parameters[param.name()], context, False)
|
|
if table:
|
|
filename = dataobjects.exportTable(table)
|
|
self.exportedLayers[parameters[param.name()]] = filename
|
|
elif not parameters[param.name()].endswith('shp'):
|
|
raise GeoAlgorithmExecutionException(
|
|
self.tr('Unsupported file format'))
|
|
if isinstance(param, ParameterMultipleInput):
|
|
if param.name() not in parameters or parameters[param.name()] is None:
|
|
continue
|
|
layers = param.value.split(';')
|
|
if layers is None or len(layers) == 0:
|
|
continue
|
|
if param.datatype == dataobjects.TYPE_RASTER:
|
|
for i, layerfile in enumerate(layers):
|
|
if layerfile.endswith('sdat'):
|
|
layerfile = param.value[:-4] + "sgrd"
|
|
layers[i] = layerfile
|
|
elif not layerfile.endswith('sgrd'):
|
|
exportCommand = self.exportRasterLayer(layerfile)
|
|
if exportCommand is not None:
|
|
commands.append(exportCommand)
|
|
param.value = ";".join(layers)
|
|
elif param.datatype in [dataobjects.TYPE_VECTOR_ANY,
|
|
dataobjects.TYPE_VECTOR_LINE,
|
|
dataobjects.TYPE_VECTOR_POLYGON,
|
|
dataobjects.TYPE_VECTOR_POINT]:
|
|
for layerfile in layers:
|
|
layer = QgsProcessingUtils.mapLayerFromString(layerfile, context, False)
|
|
if layer:
|
|
filename = dataobjects.exportVectorLayer(layer)
|
|
self.exportedLayers[layerfile] = filename
|
|
elif not layerfile.endswith('shp'):
|
|
raise GeoAlgorithmExecutionException(
|
|
self.tr('Unsupported file format'))
|
|
|
|
# TODO - set minimum extent
|
|
if not extent:
|
|
extent = QgsProcessingUtils.combineLayerExtents([layer])
|
|
|
|
# 2: Set parameters and outputs
|
|
command = self.undecoratedGroup + ' "' + self.cmdname + '"'
|
|
command += ' ' + ' '.join(self.hardcodedStrings)
|
|
|
|
for param in self.parameterDefinitions():
|
|
if not param.name() in parameters or parameters[param.name()] is None:
|
|
continue
|
|
if isinstance(param, (ParameterRaster, ParameterVector, ParameterTable)):
|
|
value = parameters[param.name()]
|
|
if value in list(self.exportedLayers.keys()):
|
|
command += ' -' + param.name() + ' "' \
|
|
+ self.exportedLayers[value] + '"'
|
|
else:
|
|
command += ' -' + param.name() + ' "' + value + '"'
|
|
elif isinstance(param, ParameterMultipleInput):
|
|
s = parameters[param.name()]
|
|
for layer in list(self.exportedLayers.keys()):
|
|
s = s.replace(layer, self.exportedLayers[layer])
|
|
command += ' -' + param.name() + ' "' + s + '"'
|
|
elif isinstance(param, ParameterBoolean):
|
|
if parameters[param.name()]:
|
|
command += ' -' + param.name().strip() + " true"
|
|
else:
|
|
command += ' -' + param.name().strip() + " false"
|
|
elif isinstance(param, ParameterFixedTable):
|
|
tempTableFile = getTempFilename('txt')
|
|
with open(tempTableFile, 'w') as f:
|
|
f.write('\t'.join([col for col in param.cols]) + '\n')
|
|
values = parameters[param.name()].split(',')
|
|
for i in range(0, len(values), 3):
|
|
s = values[i] + '\t' + values[i + 1] + '\t' + values[i + 2] + '\n'
|
|
f.write(s)
|
|
command += ' -' + param.name() + ' "' + tempTableFile + '"'
|
|
elif isinstance(param, ParameterExtent):
|
|
# 'We have to substract/add half cell size, since SAGA is
|
|
# center based, not corner based
|
|
halfcell = self.getOutputCellsize(parameters) / 2
|
|
offset = [halfcell, -halfcell, halfcell, -halfcell]
|
|
values = parameters[param.name()].split(',')
|
|
for i in range(4):
|
|
command += ' -' + self.extentParamNames[i] + ' ' \
|
|
+ str(float(values[i]) + offset[i])
|
|
elif isinstance(param, (ParameterNumber, ParameterSelection)):
|
|
command += ' -' + param.name() + ' ' + str(param.value)
|
|
else:
|
|
command += ' -' + param.name() + ' "' + str(param.value) + '"'
|
|
|
|
for out in self.outputs:
|
|
command += ' -' + out.name + ' "' + out.getCompatibleFileName(self) + '"'
|
|
|
|
commands.append(command)
|
|
|
|
# special treatment for RGB algorithm
|
|
# TODO: improve this and put this code somewhere else
|
|
for out in self.outputs:
|
|
if isinstance(out, OutputRaster):
|
|
filename = out.getCompatibleFileName(self)
|
|
filename2 = filename + '.sgrd'
|
|
if self.cmdname == 'RGB Composite':
|
|
commands.append('io_grid_image 0 -IS_RGB -GRID:"' + filename2 +
|
|
'" -FILE:"' + filename + '"')
|
|
|
|
# 3: Run SAGA
|
|
commands = self.editCommands(commands)
|
|
SagaUtils.createSagaBatchJobFileFromSagaCommands(commands)
|
|
loglines = []
|
|
loglines.append(self.tr('SAGA execution commands'))
|
|
for line in commands:
|
|
feedback.pushCommandInfo(line)
|
|
loglines.append(line)
|
|
if ProcessingConfig.getSetting(SagaUtils.SAGA_LOG_COMMANDS):
|
|
QgsMessageLog.logMessage('\n'.join(loglines), self.tr('Processing'), QgsMessageLog.INFO)
|
|
SagaUtils.executeSaga(feedback)
|
|
|
|
if self.crs is not None:
|
|
for out in self.outputs:
|
|
if isinstance(out, (OutputVector, OutputRaster)):
|
|
prjFile = os.path.splitext(out.getCompatibleFileName(self))[0] + ".prj"
|
|
with open(prjFile, "w") as f:
|
|
f.write(self.crs.toWkt())
|
|
|
|
def preProcessInputs(self):
|
|
name = self.name().replace('.', '_')
|
|
try:
|
|
module = importlib.import_module('processing.algs.saga.ext.' + name)
|
|
except ImportError:
|
|
return
|
|
if hasattr(module, 'preProcessInputs'):
|
|
func = getattr(module, 'preProcessInputs')
|
|
func(self)
|
|
|
|
def editCommands(self, commands):
|
|
try:
|
|
module = importlib.import_module('processing.algs.saga.ext.' + self.name())
|
|
except ImportError:
|
|
return commands
|
|
if hasattr(module, 'editCommands'):
|
|
func = getattr(module, 'editCommands')
|
|
return func(commands)
|
|
else:
|
|
return commands
|
|
|
|
def getOutputCellsize(self, parameters):
|
|
"""Tries to guess the cell size of the output, searching for
|
|
a parameter with an appropriate name for it.
|
|
:param parameters:
|
|
"""
|
|
|
|
cellsize = 0
|
|
for param in self.parameterDefinitions():
|
|
if param.name() in parameters and param.name() == 'USER_SIZE':
|
|
cellsize = float(parameters[param.name()])
|
|
break
|
|
return cellsize
|
|
|
|
def exportRasterLayer(self, source):
|
|
global sessionExportedLayers
|
|
context = dataobjects.createContext()
|
|
if source in sessionExportedLayers:
|
|
exportedLayer = sessionExportedLayers[source]
|
|
if os.path.exists(exportedLayer):
|
|
self.exportedLayers[source] = exportedLayer
|
|
return None
|
|
else:
|
|
del sessionExportedLayers[source]
|
|
layer = QgsProcessingUtils.mapLayerFromString(source, context, False)
|
|
if layer:
|
|
filename = str(layer.name())
|
|
else:
|
|
filename = os.path.basename(source)
|
|
validChars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789:'
|
|
filename = ''.join(c for c in filename if c in validChars)
|
|
if len(filename) == 0:
|
|
filename = 'layer'
|
|
destFilename = QgsProcessingUtils.generateTempFilename(filename + '.sgrd')
|
|
self.exportedLayers[source] = destFilename
|
|
sessionExportedLayers[source] = destFilename
|
|
return 'io_gdal 0 -TRANSFORM 1 -RESAMPLING 3 -GRIDS "' + destFilename + '" -FILES "' + source + '"'
|
|
|
|
def checkParameterValues(self, parameters, context):
|
|
"""
|
|
We check that there are no multiband layers, which are not
|
|
supported by SAGA, and that raster layers have the same grid extent
|
|
"""
|
|
extent = None
|
|
for param in self.parameterDefinitions():
|
|
files = []
|
|
if isinstance(param, ParameterRaster):
|
|
files = [parameters[param.name()]]
|
|
elif (isinstance(param, ParameterMultipleInput) and
|
|
param.datatype == dataobjects.TYPE_RASTER):
|
|
if param.value is not None:
|
|
files = param.value.split(";")
|
|
for f in files:
|
|
layer = QgsProcessingUtils.mapLayerFromString(f, context)
|
|
if layer is None:
|
|
continue
|
|
if layer.bandCount() > 1:
|
|
return False, self.tr('Input layer {0} has more than one band.\n'
|
|
'Multiband layers are not supported by SAGA').format(layer.name())
|
|
if not self.allowUnmatchingGridExtents:
|
|
if extent is None:
|
|
extent = (layer.extent(), layer.height(), layer.width())
|
|
else:
|
|
extent2 = (layer.extent(), layer.height(), layer.width())
|
|
if extent != extent2:
|
|
return False, self.tr("Input layers do not have the same grid extent.")
|
|
return super(SagaAlgorithm, self).checkParameterValues(parameters, context)
|