mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-11 00:04:09 -04:00
e38849d750
Correctly generate commands when run on eg /vsis3/ layer sources, and translate credential options to "--config KEY VALUE" arguments for GDAL commands
136 lines
5.6 KiB
Python
136 lines
5.6 KiB
Python
"""
|
|
***************************************************************************
|
|
nearblack.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. *
|
|
* *
|
|
***************************************************************************
|
|
"""
|
|
|
|
__author__ = 'Victor Olaya'
|
|
__date__ = 'August 2012'
|
|
__copyright__ = '(C) 2012, Victor Olaya'
|
|
|
|
import os
|
|
|
|
from qgis.PyQt.QtGui import QIcon
|
|
|
|
from qgis.core import (QgsRasterFileWriter,
|
|
QgsProcessingException,
|
|
QgsProcessingParameterDefinition,
|
|
QgsProcessingParameterRasterLayer,
|
|
QgsProcessingParameterBoolean,
|
|
QgsProcessingParameterNumber,
|
|
QgsProcessingParameterString,
|
|
QgsProcessingParameterRasterDestination)
|
|
|
|
from processing.algs.gdal.GdalAlgorithm import GdalAlgorithm
|
|
from processing.algs.gdal.GdalUtils import GdalUtils
|
|
|
|
pluginPath = os.path.split(os.path.split(os.path.dirname(__file__))[0])[0]
|
|
|
|
|
|
class nearblack(GdalAlgorithm):
|
|
INPUT = 'INPUT'
|
|
NEAR = 'NEAR'
|
|
WHITE = 'WHITE'
|
|
OPTIONS = 'OPTIONS'
|
|
EXTRA = 'EXTRA'
|
|
OUTPUT = 'OUTPUT'
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
def initAlgorithm(self, config=None):
|
|
self.addParameter(QgsProcessingParameterRasterLayer(self.INPUT, self.tr('Input layer')))
|
|
self.addParameter(QgsProcessingParameterNumber(self.NEAR,
|
|
self.tr('How far from black (white)'),
|
|
type=QgsProcessingParameterNumber.Type.Integer,
|
|
minValue=0,
|
|
defaultValue=15))
|
|
self.addParameter(QgsProcessingParameterBoolean(self.WHITE,
|
|
self.tr('Search for nearly white pixels instead of nearly black'),
|
|
defaultValue=False))
|
|
|
|
options_param = QgsProcessingParameterString(self.OPTIONS,
|
|
self.tr('Additional creation options'),
|
|
defaultValue='',
|
|
optional=True)
|
|
options_param.setFlags(options_param.flags() | QgsProcessingParameterDefinition.Flag.FlagAdvanced)
|
|
options_param.setMetadata({'widget_wrapper': {'widget_type': 'rasteroptions'}})
|
|
self.addParameter(options_param)
|
|
|
|
extra_param = QgsProcessingParameterString(self.EXTRA,
|
|
self.tr('Additional command-line parameters'),
|
|
defaultValue=None,
|
|
optional=True)
|
|
extra_param.setFlags(extra_param.flags() | QgsProcessingParameterDefinition.Flag.FlagAdvanced)
|
|
self.addParameter(extra_param)
|
|
|
|
self.addParameter(QgsProcessingParameterRasterDestination(self.OUTPUT, self.tr('Nearblack')))
|
|
|
|
def name(self):
|
|
return 'nearblack'
|
|
|
|
def displayName(self):
|
|
return self.tr('Near black')
|
|
|
|
def group(self):
|
|
return self.tr('Raster analysis')
|
|
|
|
def groupId(self):
|
|
return 'rasteranalysis'
|
|
|
|
def icon(self):
|
|
return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'nearblack.png'))
|
|
|
|
def commandName(self):
|
|
return 'nearblack'
|
|
|
|
def getConsoleCommands(self, parameters, context, feedback, executing=True):
|
|
inLayer = self.parameterAsRasterLayer(parameters, self.INPUT, context)
|
|
if inLayer is None:
|
|
raise QgsProcessingException(self.invalidRasterError(parameters, self.INPUT))
|
|
input_details = GdalUtils.gdal_connection_details_from_layer(inLayer)
|
|
|
|
out = self.parameterAsOutputLayer(parameters, self.OUTPUT, context)
|
|
self.setOutputValue(self.OUTPUT, out)
|
|
|
|
output_format = QgsRasterFileWriter.driverForExtension(os.path.splitext(out)[1])
|
|
if not output_format:
|
|
raise QgsProcessingException(self.tr('Output format is invalid'))
|
|
|
|
arguments = [
|
|
input_details.connection_string,
|
|
'-of',
|
|
output_format,
|
|
'-o',
|
|
out,
|
|
'-near',
|
|
str(self.parameterAsInt(parameters, self.NEAR, context))
|
|
]
|
|
|
|
if self.parameterAsBoolean(parameters, self.WHITE, context):
|
|
arguments.append('-white')
|
|
|
|
if input_details.credential_options:
|
|
arguments.extend(input_details.credential_options_as_arguments())
|
|
|
|
options = self.parameterAsString(parameters, self.OPTIONS, context)
|
|
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)
|
|
|
|
return [self.commandName(), GdalUtils.escapeAndJoin(arguments)]
|