mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-11 00:04:09 -04:00
451 lines
16 KiB
Python
451 lines
16 KiB
Python
"""
|
|
***************************************************************************
|
|
ClipRasterByMask.py
|
|
---------------------
|
|
Date : September 2013
|
|
Copyright : (C) 2013 by Alexander Bruy
|
|
Email : alexander bruy 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__ = "Alexander Bruy"
|
|
__date__ = "September 2013"
|
|
__copyright__ = "(C) 2013, Alexander Bruy"
|
|
|
|
import os
|
|
import tempfile
|
|
|
|
from qgis.PyQt.QtGui import QIcon
|
|
|
|
from qgis.core import (
|
|
QgsDistanceArea,
|
|
QgsRasterFileWriter,
|
|
QgsProcessing,
|
|
QgsProcessingException,
|
|
QgsProcessingParameterDefinition,
|
|
QgsProcessingParameterFeatureSource,
|
|
QgsProcessingParameterRasterLayer,
|
|
QgsProcessingParameterCrs,
|
|
QgsProcessingParameterEnum,
|
|
QgsProcessingParameterExtent,
|
|
QgsProcessingParameterString,
|
|
QgsProcessingParameterNumber,
|
|
QgsProcessingParameterBoolean,
|
|
QgsProcessingParameterRasterDestination,
|
|
QgsProcessingRasterLayerDefinition,
|
|
)
|
|
from processing.algs.gdal.GdalAlgorithm import GdalAlgorithm
|
|
from processing.algs.gdal.GdalUtils import GdalConnectionDetails, GdalUtils
|
|
|
|
pluginPath = os.path.split(os.path.split(os.path.dirname(__file__))[0])[0]
|
|
|
|
|
|
class ClipRasterByMask(GdalAlgorithm):
|
|
INPUT = "INPUT"
|
|
MASK = "MASK"
|
|
SOURCE_CRS = "SOURCE_CRS"
|
|
TARGET_CRS = "TARGET_CRS"
|
|
EXTENT = "TARGET_EXTENT"
|
|
NODATA = "NODATA"
|
|
ALPHA_BAND = "ALPHA_BAND"
|
|
CROP_TO_CUTLINE = "CROP_TO_CUTLINE"
|
|
KEEP_RESOLUTION = "KEEP_RESOLUTION"
|
|
SET_RESOLUTION = "SET_RESOLUTION"
|
|
X_RESOLUTION = "X_RESOLUTION"
|
|
Y_RESOLUTION = "Y_RESOLUTION"
|
|
OPTIONS = "OPTIONS"
|
|
CREATION_OPTIONS = "CREATION_OPTIONS"
|
|
DATA_TYPE = "DATA_TYPE"
|
|
MULTITHREADING = "MULTITHREADING"
|
|
EXTRA = "EXTRA"
|
|
OUTPUT = "OUTPUT"
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
def initAlgorithm(self, config=None):
|
|
|
|
self.TYPES = [
|
|
self.tr("Use Input Layer Data Type"),
|
|
"Byte",
|
|
"Int16",
|
|
"UInt16",
|
|
"UInt32",
|
|
"Int32",
|
|
"Float32",
|
|
"Float64",
|
|
"CInt16",
|
|
"CInt32",
|
|
"CFloat32",
|
|
"CFloat64",
|
|
"Int8",
|
|
]
|
|
|
|
self.addParameter(
|
|
QgsProcessingParameterRasterLayer(self.INPUT, self.tr("Input layer"))
|
|
)
|
|
self.addParameter(
|
|
QgsProcessingParameterFeatureSource(
|
|
self.MASK,
|
|
self.tr("Mask layer"),
|
|
[QgsProcessing.SourceType.TypeVectorPolygon],
|
|
)
|
|
)
|
|
self.addParameter(
|
|
QgsProcessingParameterCrs(
|
|
self.SOURCE_CRS, self.tr("Source CRS"), optional=True
|
|
)
|
|
)
|
|
self.addParameter(
|
|
QgsProcessingParameterCrs(
|
|
self.TARGET_CRS, self.tr("Target CRS"), optional=True
|
|
)
|
|
)
|
|
self.addParameter(
|
|
QgsProcessingParameterExtent(
|
|
self.EXTENT, self.tr("Target extent"), optional=True
|
|
)
|
|
)
|
|
self.addParameter(
|
|
QgsProcessingParameterNumber(
|
|
self.NODATA,
|
|
self.tr("Assign a specified NoData value to output bands"),
|
|
type=QgsProcessingParameterNumber.Type.Double,
|
|
defaultValue=None,
|
|
optional=True,
|
|
)
|
|
)
|
|
self.addParameter(
|
|
QgsProcessingParameterBoolean(
|
|
self.ALPHA_BAND,
|
|
self.tr("Create an output alpha band"),
|
|
defaultValue=False,
|
|
)
|
|
)
|
|
self.addParameter(
|
|
QgsProcessingParameterBoolean(
|
|
self.CROP_TO_CUTLINE,
|
|
self.tr(
|
|
"Match the extent of the clipped raster to the extent of the mask layer"
|
|
),
|
|
defaultValue=True,
|
|
)
|
|
)
|
|
self.addParameter(
|
|
QgsProcessingParameterBoolean(
|
|
self.KEEP_RESOLUTION,
|
|
self.tr("Keep resolution of input raster"),
|
|
defaultValue=False,
|
|
)
|
|
)
|
|
self.addParameter(
|
|
QgsProcessingParameterBoolean(
|
|
self.SET_RESOLUTION,
|
|
self.tr("Set output file resolution"),
|
|
defaultValue=False,
|
|
)
|
|
)
|
|
self.addParameter(
|
|
QgsProcessingParameterNumber(
|
|
self.X_RESOLUTION,
|
|
self.tr("X Resolution to output bands"),
|
|
type=QgsProcessingParameterNumber.Type.Double,
|
|
defaultValue=None,
|
|
optional=True,
|
|
)
|
|
)
|
|
self.addParameter(
|
|
QgsProcessingParameterNumber(
|
|
self.Y_RESOLUTION,
|
|
self.tr("Y Resolution to output bands"),
|
|
type=QgsProcessingParameterNumber.Type.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.Flag.FlagAdvanced
|
|
)
|
|
self.addParameter(multithreading_param)
|
|
|
|
# backwards compatibility parameter
|
|
# TODO QGIS 4: remove parameter and related logic
|
|
options_param = QgsProcessingParameterString(
|
|
self.OPTIONS,
|
|
self.tr("Additional creation options"),
|
|
defaultValue="",
|
|
optional=True,
|
|
)
|
|
options_param.setFlags(
|
|
options_param.flags() | QgsProcessingParameterDefinition.Flag.Hidden
|
|
)
|
|
options_param.setMetadata({"widget_wrapper": {"widget_type": "rasteroptions"}})
|
|
self.addParameter(options_param)
|
|
|
|
creation_options_param = QgsProcessingParameterString(
|
|
self.CREATION_OPTIONS,
|
|
self.tr("Additional creation options"),
|
|
defaultValue="",
|
|
optional=True,
|
|
)
|
|
creation_options_param.setFlags(
|
|
creation_options_param.flags()
|
|
| QgsProcessingParameterDefinition.Flag.FlagAdvanced
|
|
)
|
|
creation_options_param.setMetadata(
|
|
{"widget_wrapper": {"widget_type": "rasteroptions"}}
|
|
)
|
|
self.addParameter(creation_options_param)
|
|
|
|
dataType_param = QgsProcessingParameterEnum(
|
|
self.DATA_TYPE,
|
|
self.tr("Output data type"),
|
|
self.TYPES,
|
|
allowMultiple=False,
|
|
defaultValue=0,
|
|
)
|
|
dataType_param.setFlags(
|
|
dataType_param.flags() | QgsProcessingParameterDefinition.Flag.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.Flag.FlagAdvanced
|
|
)
|
|
self.addParameter(extra_param)
|
|
|
|
self.addParameter(
|
|
QgsProcessingParameterRasterDestination(
|
|
self.OUTPUT, self.tr("Clipped (mask)")
|
|
)
|
|
)
|
|
|
|
def name(self):
|
|
return "cliprasterbymasklayer"
|
|
|
|
def displayName(self):
|
|
return self.tr("Clip raster by mask layer")
|
|
|
|
def icon(self):
|
|
return QIcon(os.path.join(pluginPath, "images", "gdaltools", "raster-clip.png"))
|
|
|
|
def group(self):
|
|
return self.tr("Raster extraction")
|
|
|
|
def groupId(self):
|
|
return "rasterextraction"
|
|
|
|
def commandName(self):
|
|
return "gdalwarp"
|
|
|
|
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)
|
|
)
|
|
|
|
mask_details = self.getOgrCompatibleSource(
|
|
self.MASK, parameters, context, feedback, executing
|
|
)
|
|
|
|
sourceCrs = self.parameterAsCrs(parameters, self.SOURCE_CRS, context)
|
|
targetCrs = self.parameterAsCrs(parameters, self.TARGET_CRS, context)
|
|
|
|
bbox = self.parameterAsExtent(parameters, self.EXTENT, context)
|
|
bboxCrs = self.parameterAsExtentCrs(parameters, self.EXTENT, context)
|
|
|
|
if self.NODATA in parameters and parameters[self.NODATA] is not None:
|
|
nodata = self.parameterAsDouble(parameters, self.NODATA, context)
|
|
else:
|
|
nodata = None
|
|
options = self.parameterAsString(parameters, self.OPTIONS, context)
|
|
out = self.parameterAsOutputLayer(parameters, self.OUTPUT, context)
|
|
self.setOutputValue(self.OUTPUT, out)
|
|
|
|
# If it's a WMS layer and scale/DPI were given, craft a XML description file
|
|
if inLayer.providerType() == "wms" and isinstance(
|
|
parameters[self.INPUT], QgsProcessingRasterLayerDefinition
|
|
):
|
|
# If the scale is greater than 0, we'll have a QgsProcessingRasterLayerDefinition
|
|
param_def = parameters[self.INPUT]
|
|
scale = param_def.referenceScale
|
|
dpi = param_def.dpi
|
|
|
|
# For the input WMS's BBOX, if -te is given, then use -te, projected to input's
|
|
# crs. Otherwise, use mask layer's extent, projected to input's crs.
|
|
_bbox = None
|
|
if not bbox.isNull() and not bbox.isEmpty():
|
|
if bboxCrs != inLayer.crs():
|
|
_bbox = self.parameterAsExtent(
|
|
parameters, self.EXTENT, context, inLayer.crs()
|
|
)
|
|
else:
|
|
_bbox = bbox
|
|
else:
|
|
_bbox = self.parameterAsExtent(
|
|
parameters, self.MASK, context, inLayer.crs()
|
|
)
|
|
|
|
if _bbox.isNull() or _bbox.isEmpty():
|
|
raise QgsProcessingException(
|
|
"Invalid extent in mask layer ({}) and in target extent ({}).".format(
|
|
parameters[self.INPUT],
|
|
(
|
|
parameters[self.EXTENT]
|
|
if self.EXTENT in parameters
|
|
else "EXTENT"
|
|
),
|
|
)
|
|
)
|
|
|
|
distanceArea = None
|
|
if inLayer.crs().isGeographic():
|
|
distanceArea = QgsDistanceArea()
|
|
distanceArea.setSourceCrs(inLayer.crs(), context.transformContext())
|
|
distanceArea.setEllipsoid(inLayer.crs().ellipsoidAcronym())
|
|
|
|
width, height = GdalUtils._wms_dimensions_for_scale(
|
|
_bbox, inLayer.crs(), scale, dpi, distanceArea
|
|
)
|
|
wms_description_file_path = tempfile.mktemp("_wms_description_file.xml")
|
|
res_xml_wms, xml_wms_error = GdalUtils.gdal_wms_xml_description_file(
|
|
inLayer.publicSource(),
|
|
GdalUtils._get_wms_version(inLayer),
|
|
_bbox,
|
|
width,
|
|
height,
|
|
wms_description_file_path,
|
|
)
|
|
if not res_xml_wms:
|
|
raise QgsProcessingException(
|
|
"Cannot create XML description file for WMS layer. Details: {}".format(
|
|
xml_wms_error
|
|
)
|
|
)
|
|
input_details = GdalConnectionDetails(
|
|
connection_string=wms_description_file_path
|
|
)
|
|
else:
|
|
input_details = GdalUtils.gdal_connection_details_from_layer(inLayer)
|
|
|
|
arguments = ["-overwrite"]
|
|
|
|
if sourceCrs.isValid():
|
|
arguments.append("-s_srs")
|
|
arguments.append(GdalUtils.gdal_crs_string(sourceCrs))
|
|
|
|
if targetCrs.isValid():
|
|
arguments.append("-t_srs")
|
|
arguments.append(GdalUtils.gdal_crs_string(targetCrs))
|
|
|
|
if not bbox.isNull() and not bbox.isEmpty():
|
|
arguments.append("-te")
|
|
arguments.append(str(bbox.xMinimum()))
|
|
arguments.append(str(bbox.yMinimum()))
|
|
arguments.append(str(bbox.xMaximum()))
|
|
arguments.append(str(bbox.yMaximum()))
|
|
arguments.append("-te_srs")
|
|
arguments.append(GdalUtils.gdal_crs_string(bboxCrs))
|
|
|
|
data_type = self.parameterAsEnum(parameters, self.DATA_TYPE, context)
|
|
if data_type:
|
|
if self.TYPES[data_type] == "Int8" and GdalUtils.version() < 3070000:
|
|
raise QgsProcessingException(
|
|
self.tr("Int8 data type requires GDAL version 3.7 or later")
|
|
)
|
|
|
|
arguments.append("-ot " + self.TYPES[data_type])
|
|
|
|
output_format = QgsRasterFileWriter.driverForExtension(os.path.splitext(out)[1])
|
|
if not output_format:
|
|
raise QgsProcessingException(self.tr("Output format is invalid"))
|
|
|
|
arguments.append("-of")
|
|
arguments.append(output_format)
|
|
|
|
if self.parameterAsBoolean(parameters, self.KEEP_RESOLUTION, context):
|
|
arguments.append("-tr")
|
|
arguments.append(str(inLayer.rasterUnitsPerPixelX()))
|
|
arguments.append(str(-inLayer.rasterUnitsPerPixelY()))
|
|
arguments.append("-tap")
|
|
|
|
if self.parameterAsBoolean(parameters, self.SET_RESOLUTION, context):
|
|
arguments.append("-tr")
|
|
if (
|
|
self.X_RESOLUTION in parameters
|
|
and parameters[self.X_RESOLUTION] is not None
|
|
):
|
|
xres = self.parameterAsDouble(parameters, self.X_RESOLUTION, context)
|
|
arguments.append(f"{xres}")
|
|
else:
|
|
arguments.append(str(inLayer.rasterUnitsPerPixelX()))
|
|
if (
|
|
self.Y_RESOLUTION in parameters
|
|
and parameters[self.Y_RESOLUTION] is not None
|
|
):
|
|
yres = self.parameterAsDouble(parameters, self.Y_RESOLUTION, context)
|
|
arguments.append(f"{yres}")
|
|
else:
|
|
arguments.append(str(-inLayer.rasterUnitsPerPixelY()))
|
|
arguments.append("-tap")
|
|
|
|
arguments.append("-cutline")
|
|
arguments.append(mask_details.connection_string)
|
|
arguments.append("-cl")
|
|
arguments.append(mask_details.layer_name)
|
|
|
|
if self.parameterAsBoolean(parameters, self.CROP_TO_CUTLINE, context):
|
|
arguments.append("-crop_to_cutline")
|
|
|
|
if self.parameterAsBoolean(parameters, self.ALPHA_BAND, context):
|
|
arguments.append("-dstalpha")
|
|
|
|
if nodata is not None:
|
|
arguments.append(f"-dstnodata {nodata}")
|
|
|
|
if self.parameterAsBoolean(parameters, self.MULTITHREADING, context):
|
|
arguments.append("-multi")
|
|
|
|
options = self.parameterAsString(parameters, self.CREATION_OPTIONS, context)
|
|
# handle backwards compatibility parameter OPTIONS
|
|
if self.OPTIONS in parameters and parameters[self.OPTIONS] not in (None, ""):
|
|
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)
|
|
|
|
arguments.append(input_details.connection_string)
|
|
arguments.append(out)
|
|
|
|
if input_details.open_options:
|
|
arguments.extend(input_details.open_options_as_arguments())
|
|
|
|
if input_details.credential_options:
|
|
arguments.extend(input_details.credential_options_as_arguments())
|
|
|
|
return [self.commandName(), GdalUtils.escapeAndJoin(arguments)]
|