dataobjects.py 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
  1. """
  2. ***************************************************************************
  3. dataobject.py
  4. ---------------------
  5. Date : August 2012
  6. Copyright : (C) 2012 by Victor Olaya
  7. Email : volayaf at gmail dot com
  8. ***************************************************************************
  9. * *
  10. * This program is free software; you can redistribute it and/or modify *
  11. * it under the terms of the GNU General Public License as published by *
  12. * the Free Software Foundation; either version 2 of the License, or *
  13. * (at your option) any later version. *
  14. * *
  15. ***************************************************************************
  16. """
  17. __author__ = 'Victor Olaya'
  18. __date__ = 'August 2012'
  19. __copyright__ = '(C) 2012, Victor Olaya'
  20. import os
  21. import re
  22. from qgis.core import (QgsDataProvider,
  23. QgsRasterLayer,
  24. QgsWkbTypes,
  25. QgsVectorLayer,
  26. QgsProject,
  27. QgsSettings,
  28. QgsProcessingContext,
  29. QgsProcessingUtils,
  30. QgsFeatureRequest,
  31. QgsExpressionContext,
  32. QgsExpressionContextUtils,
  33. QgsExpressionContextScope)
  34. from qgis.gui import QgsSublayersDialog
  35. from qgis.PyQt.QtCore import QCoreApplication
  36. from qgis.utils import iface
  37. from processing.core.ProcessingConfig import ProcessingConfig
  38. ALL_TYPES = [-1]
  39. TYPE_VECTOR_ANY = -1
  40. TYPE_VECTOR_POINT = 0
  41. TYPE_VECTOR_LINE = 1
  42. TYPE_VECTOR_POLYGON = 2
  43. TYPE_RASTER = 3
  44. TYPE_FILE = 4
  45. TYPE_TABLE = 5
  46. def createContext(feedback=None):
  47. """
  48. Creates a default processing context
  49. :param feedback: Optional existing QgsProcessingFeedback object, or None to use a default feedback object
  50. :type feedback: Optional[QgsProcessingFeedback]
  51. :returns: New QgsProcessingContext object
  52. :rtype: QgsProcessingContext
  53. """
  54. context = QgsProcessingContext()
  55. context.setProject(QgsProject.instance())
  56. context.setFeedback(feedback)
  57. invalid_features_method = ProcessingConfig.getSetting(ProcessingConfig.FILTER_INVALID_GEOMETRIES)
  58. if invalid_features_method is None:
  59. invalid_features_method = QgsFeatureRequest.GeometryAbortOnInvalid
  60. context.setInvalidGeometryCheck(invalid_features_method)
  61. settings = QgsSettings()
  62. context.setDefaultEncoding(QgsProcessingUtils.resolveDefaultEncoding(settings.value("/Processing/encoding")))
  63. context.setExpressionContext(createExpressionContext())
  64. if iface and iface.mapCanvas() and iface.mapCanvas().mapSettings().isTemporal():
  65. context.setCurrentTimeRange(iface.mapCanvas().mapSettings().temporalRange())
  66. return context
  67. def createExpressionContext():
  68. context = QgsExpressionContext()
  69. context.appendScope(QgsExpressionContextUtils.globalScope())
  70. context.appendScope(QgsExpressionContextUtils.projectScope(QgsProject.instance()))
  71. if iface and iface.mapCanvas():
  72. context.appendScope(QgsExpressionContextUtils.mapSettingsScope(iface.mapCanvas().mapSettings()))
  73. processingScope = QgsExpressionContextScope()
  74. if iface and iface.mapCanvas():
  75. extent = iface.mapCanvas().fullExtent()
  76. processingScope.setVariable('fullextent_minx', extent.xMinimum())
  77. processingScope.setVariable('fullextent_miny', extent.yMinimum())
  78. processingScope.setVariable('fullextent_maxx', extent.xMaximum())
  79. processingScope.setVariable('fullextent_maxy', extent.yMaximum())
  80. context.appendScope(processingScope)
  81. return context
  82. def load(fileName, name=None, crs=None, style=None, isRaster=False):
  83. """
  84. Loads a layer/table into the current project, given its file.
  85. .. deprecated:: 3.0
  86. Do not use, will be removed in QGIS 4.0
  87. """
  88. from warnings import warn
  89. warn("processing.load is deprecated and will be removed in QGIS 4.0", DeprecationWarning)
  90. if fileName is None:
  91. return
  92. if name is None:
  93. name = os.path.split(fileName)[1]
  94. if isRaster:
  95. options = QgsRasterLayer.LayerOptions()
  96. options.skipCrsValidation = True
  97. qgslayer = QgsRasterLayer(fileName, name, 'gdal', options)
  98. if qgslayer.isValid():
  99. if crs is not None and qgslayer.crs() is None:
  100. qgslayer.setCrs(crs, False)
  101. if style is None:
  102. style = ProcessingConfig.getSetting(ProcessingConfig.RASTER_STYLE)
  103. qgslayer.loadNamedStyle(style)
  104. QgsProject.instance().addMapLayers([qgslayer])
  105. else:
  106. raise RuntimeError(QCoreApplication.translate('dataobject',
  107. 'Could not load layer: {0}\nCheck the processing framework log to look for errors.').format(
  108. fileName))
  109. else:
  110. options = QgsVectorLayer.LayerOptions()
  111. options.skipCrsValidation = True
  112. qgslayer = QgsVectorLayer(fileName, name, 'ogr', options)
  113. if qgslayer.isValid():
  114. if crs is not None and qgslayer.crs() is None:
  115. qgslayer.setCrs(crs, False)
  116. if style is None:
  117. if qgslayer.geometryType() == QgsWkbTypes.PointGeometry:
  118. style = ProcessingConfig.getSetting(ProcessingConfig.VECTOR_POINT_STYLE)
  119. elif qgslayer.geometryType() == QgsWkbTypes.LineGeometry:
  120. style = ProcessingConfig.getSetting(ProcessingConfig.VECTOR_LINE_STYLE)
  121. else:
  122. style = ProcessingConfig.getSetting(ProcessingConfig.VECTOR_POLYGON_STYLE)
  123. qgslayer.loadNamedStyle(style)
  124. QgsProject.instance().addMapLayers([qgslayer])
  125. return qgslayer
  126. def getRasterSublayer(path, param):
  127. layer = QgsRasterLayer(path)
  128. try:
  129. # If the layer is a raster layer and has multiple sublayers, let the user chose one.
  130. # Based on QgisApp::askUserForGDALSublayers
  131. if layer and param.showSublayersDialog and layer.dataProvider().name() == "gdal" and len(layer.subLayers()) > 1:
  132. layers = []
  133. subLayerNum = 0
  134. # simplify raster sublayer name
  135. for subLayer in layer.subLayers():
  136. # if netcdf/hdf use all text after filename
  137. if bool(re.match('netcdf', subLayer, re.I)) or bool(re.match('hdf', subLayer, re.I)):
  138. subLayer = subLayer.split(path)[1]
  139. subLayer = subLayer[1:]
  140. else:
  141. # remove driver name and file name
  142. subLayer.replace(subLayer.split(QgsDataProvider.SUBLAYER_SEPARATOR)[0], "")
  143. subLayer.replace(path, "")
  144. # remove any : or " left over
  145. if subLayer.startswith(":"):
  146. subLayer = subLayer[1:]
  147. if subLayer.startswith("\""):
  148. subLayer = subLayer[1:]
  149. if subLayer.endswith(":"):
  150. subLayer = subLayer[:-1]
  151. if subLayer.endswith("\""):
  152. subLayer = subLayer[:-1]
  153. ld = QgsSublayersDialog.LayerDefinition()
  154. ld.layerId = subLayerNum
  155. ld.layerName = subLayer
  156. layers.append(ld)
  157. subLayerNum = subLayerNum + 1
  158. # Use QgsSublayersDialog
  159. # Would be good if QgsSublayersDialog had an option to allow only one sublayer to be selected
  160. chooseSublayersDialog = QgsSublayersDialog(QgsSublayersDialog.Gdal, "gdal")
  161. chooseSublayersDialog.populateLayerTable(layers)
  162. if chooseSublayersDialog.exec_():
  163. return layer.subLayers()[chooseSublayersDialog.selectionIndexes()[0]]
  164. else:
  165. # If user pressed cancel then just return the input path
  166. return path
  167. else:
  168. # If the sublayers selection dialog is not to be shown then just return the input path
  169. return path
  170. except:
  171. # If the layer is not a raster layer, then just return the input path
  172. return path