mirror of
https://github.com/qgis/QGIS.git
synced 2025-03-08 00:02:35 -05:00
5339d62715
Include descriptive text with the specified parameter value in error, and always check that sources were loaded to avoid raw Python exceptions when they are not
112 lines
4.3 KiB
Python
112 lines
4.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
ClipVectorByExtent.py
|
|
---------------------
|
|
Date : November 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__ = 'November 2012'
|
|
__copyright__ = '(C) 2012, Victor Olaya'
|
|
|
|
# This will get replaced with a git SHA1 when you do a git archive
|
|
|
|
__revision__ = '$Format:%H$'
|
|
|
|
from qgis.core import (QgsVectorLayer,
|
|
QgsProcessing,
|
|
QgsProcessingException,
|
|
QgsProcessingParameterDefinition,
|
|
QgsProcessingParameterFeatureSource,
|
|
QgsProcessingParameterExtent,
|
|
QgsProcessingParameterString,
|
|
QgsProcessingParameterVectorDestination)
|
|
from processing.algs.gdal.GdalAlgorithm import GdalAlgorithm
|
|
from processing.algs.gdal.GdalUtils import GdalUtils
|
|
|
|
|
|
class ClipVectorByExtent(GdalAlgorithm):
|
|
|
|
INPUT = 'INPUT'
|
|
EXTENT = 'EXTENT'
|
|
OPTIONS = 'OPTIONS'
|
|
OUTPUT = 'OUTPUT'
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
def initAlgorithm(self, config=None):
|
|
self.addParameter(QgsProcessingParameterFeatureSource(self.INPUT,
|
|
self.tr('Input layer')))
|
|
self.addParameter(QgsProcessingParameterExtent(self.EXTENT,
|
|
self.tr('Clipping extent')))
|
|
|
|
options_param = QgsProcessingParameterString(self.OPTIONS,
|
|
self.tr('Additional creation options'),
|
|
defaultValue='',
|
|
optional=True)
|
|
options_param.setFlags(options_param.flags() | QgsProcessingParameterDefinition.FlagAdvanced)
|
|
self.addParameter(options_param)
|
|
|
|
self.addParameter(QgsProcessingParameterVectorDestination(self.OUTPUT,
|
|
self.tr('Clipped (extent)')))
|
|
|
|
def name(self):
|
|
return 'clipvectorbyextent'
|
|
|
|
def displayName(self):
|
|
return self.tr('Clip vector by extent')
|
|
|
|
def group(self):
|
|
return self.tr('Vector geoprocessing')
|
|
|
|
def groupId(self):
|
|
return 'vectorgeoprocessing'
|
|
|
|
def commandName(self):
|
|
return 'ogr2ogr'
|
|
|
|
def getConsoleCommands(self, parameters, context, feedback, executing=True):
|
|
ogrLayer, layerName = self.getOgrCompatibleSource(self.INPUT, parameters, context, feedback, executing)
|
|
source = self.parameterAsSource(parameters, self.INPUT, context)
|
|
if source is None:
|
|
raise QgsProcessingException(self.invalidSourceError(parameters, self.INPUT))
|
|
|
|
extent = self.parameterAsExtent(parameters, self.EXTENT, context, source.sourceCrs())
|
|
options = self.parameterAsString(parameters, self.OPTIONS, context)
|
|
outFile = self.parameterAsOutputLayer(parameters, self.OUTPUT, context)
|
|
|
|
output, outputFormat = GdalUtils.ogrConnectionStringAndFormat(outFile, context)
|
|
|
|
arguments = []
|
|
arguments.append('-spat')
|
|
arguments.append(str(extent.xMinimum()))
|
|
arguments.append(str(extent.yMaximum()))
|
|
arguments.append(str(extent.xMaximum()))
|
|
arguments.append(str(extent.yMinimum()))
|
|
arguments.append('-clipsrc spat_extent')
|
|
|
|
arguments.append(output)
|
|
arguments.append(ogrLayer)
|
|
arguments.append(layerName)
|
|
|
|
if options:
|
|
arguments.append(options)
|
|
|
|
if outputFormat:
|
|
arguments.append('-f {}'.format(outputFormat))
|
|
|
|
return ['ogr2ogr', GdalUtils.escapeAndJoin(arguments)]
|