"""
InaSAFE Disaster risk assessment tool developed by AusAid - **GUI Dialog.**
Contact : ole.moller.nielsen@gmail.com
.. note:: 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.
.. todo:: Check raster is single band
"""
__author__ = 'tim@linfiniti.com'
__revision__ = '$Format:%H$'
__date__ = '10/01/2011'
__copyright__ = ('Copyright 2012, Australia Indonesia Facility for '
'Disaster Reduction')
import os
import numpy
import logging
from PyQt4 import QtGui, QtCore
from PyQt4.QtCore import pyqtSlot
from qgis.core import (QgsMapLayer,
QgsVectorLayer,
QgsRasterLayer,
QgsMapLayerRegistry,
QgsCoordinateReferenceSystem,
QgsCoordinateTransform,
QGis,
QgsFeature,
QgsRectangle)
from qgis.analysis import QgsZonalStatistics
# TODO: Rather import via safe_interface.py TS
from safe.api import write_keywords, read_keywords, ReadLayerError
from safe_qgis.dock_base import Ui_DockBase
from safe_qgis.help import Help
from safe_qgis.utilities import (getExceptionWithStacktrace,
getWGS84resolution)
from safe_qgis.impact_calculator import ImpactCalculator
from safe_qgis.safe_interface import (availableFunctions,
getFunctionTitle,
getOptimalExtent,
getBufferedExtent,
getSafeImpactFunctions,
writeKeywordsToFile,
safeTr,
get_version,
temp_dir)
from safe_qgis.keyword_io import KeywordIO
from safe_qgis.clipper import clipLayer
from safe_qgis.exceptions import (KeywordNotFoundException,
InsufficientOverlapException,
InvalidParameterException,
InsufficientParametersException,
HashNotFoundException)
from safe_qgis.map import Map
from safe_qgis.html_renderer import HtmlRenderer
from safe_qgis.utilities import (htmlHeader,
htmlFooter,
setVectorStyle,
setRasterStyle,
qgisVersion)
from safe_qgis.configurable_impact_functions_dialog import (
ConfigurableImpactFunctionsDialog)
from safe_qgis.keywords_dialog import KeywordsDialog
# Don't remove this even if it is flagged as unused by your ide
# it is needed for qrc:/ url resolution. See Qt Resources docs.
import safe_qgis.resources # pylint: disable=W0611
LOGGER = logging.getLogger('InaSAFE')
[docs]class Dock(QtGui.QDockWidget, Ui_DockBase):
"""Dock implementation class for the Risk In A Box plugin."""
def __init__(self, iface):
"""Constructor for the dialog.
This dialog will allow the user to select layers and scenario details
and subsequently run their model.
.. note:: We use the multiple inheritance approach from Qt4 so that
for elements are directly accessible in the form context and we can
use autoconnect to set up slots. See article below:
http://doc.qt.nokia.com/4.7-snapshot/designer-using-a-ui-file.html
Args:
* iface - a Quantum GIS QGisAppInterface instance.
Returns:
not applicable
Raises:
no exceptions explicitly raised
"""
QtGui.QDockWidget.__init__(self, None)
self.setupUi(self)
myLongVersion = get_version()
LOGGER.debug('Version: %s' % myLongVersion)
myTokens = myLongVersion.split('.')
myVersion = '%s.%s.%s' % (myTokens[0], myTokens[1], myTokens[2])
try:
myVersionType = myTokens[3].split('2')[0]
except IndexError:
myVersionType = 'final'
# Allowed version names: ('alpha', 'beta', 'rc', 'final')
self.setWindowTitle(self.tr('InaSAFE %s %s' % (
myVersion, myVersionType)))
# Save reference to the QGIS interface
self.iface = iface
self.header = None # for storing html header template
self.footer = None # for storing html footer template
self.calculator = ImpactCalculator()
self.keywordIO = KeywordIO()
self.runner = None
self.helpDialog = None
self.state = None
self.runInThreadFlag = False
self.showOnlyVisibleLayersFlag = True
self.setLayerNameFromTitleFlag = True
self.zoomToImpactFlag = True
self.hideExposureFlag = True
self.hazardLayers = None # array of all hazard layers
self.exposureLayers = None # array of all exposure layers
self.readSettings() # getLayers called by this
self.setOkButtonStatus()
self._aggregationPrefix = 'aggr_'
self.pbnPrint.setEnabled(False)
self.initPostprocessingOutput()
myButton = self.pbnHelp
QtCore.QObject.connect(myButton, QtCore.SIGNAL('clicked()'),
self.showHelp)
myButton = self.pbnPrint
QtCore.QObject.connect(myButton, QtCore.SIGNAL('clicked()'),
self.printMap)
#self.showHelp()
myButton = self.pbnRunStop
QtCore.QObject.connect(myButton, QtCore.SIGNAL('clicked()'),
self.accept)
#myAttribute = QtWebKit.QWebSettings.DeveloperExtrasEnabled
#QtWebKit.QWebSettings.setAttribute(myAttribute, True)
[docs] def readSettings(self):
"""Set the dock state from QSettings. Do this on init and after
changing options in the options dialog.
Args:
None
Returns:
None
Raises:
None
"""
mySettings = QtCore.QSettings()
myFlag = mySettings.value('inasafe/useThreadingFlag',
False).toBool()
self.runInThreadFlag = myFlag
myFlag = mySettings.value(
'inasafe/visibleLayersOnlyFlag', True).toBool()
self.showOnlyVisibleLayersFlag = myFlag
myFlag = mySettings.value(
'inasafe/setLayerNameFromTitleFlag', True).toBool()
self.setLayerNameFromTitleFlag = myFlag
myFlag = mySettings.value(
'inasafe/setZoomToImpactFlag', True).toBool()
self.zoomToImpactFlag = myFlag
# whether exposure layer should be hidden after model completes
myFlag = mySettings.value(
'inasafe/setHideExposureFlag', False).toBool()
self.hideExposureFlag = myFlag
# whether to clip hazard and exposure layers to the viewport
myFlag = mySettings.value(
'inasafe/clipToViewport', True).toBool()
self.clipToViewport = myFlag
# whether to show or not postprocessing generated layers
myFlag = mySettings.value(
'inasafe/showPostProcessingLayers', False).toBool()
self.showPostProcessingLayers = myFlag
self.getLayers()
[docs] def connectLayerListener(self):
"""Establish a signal/slot to listen for changes in the layers loaded
in QGIS.
..seealso:: disconnectLayerListener
Args:
None
Returns:
None
Raises:
None
"""
if qgisVersion() >= 10800: # 1.8 or newer
QgsMapLayerRegistry.instance().layersWillBeRemoved.connect(
self.layersWillBeRemoved)
QgsMapLayerRegistry.instance().layersAdded.connect(
self.layersAdded)
# All versions of QGIS
QtCore.QObject.connect(self.iface.mapCanvas(),
QtCore.SIGNAL('layersChanged()'),
self.getLayers)
# pylint: disable=W0702
[docs] def disconnectLayerListener(self):
"""Destroy the signal/slot to listen for changes in the layers loaded
in QGIS.
..seealso:: connectLayerListener
Args:
None
Returns:
None
Raises:
None
"""
try:
QtCore.QObject.disconnect(QgsMapLayerRegistry.instance(),
QtCore.SIGNAL('layerWillBeRemoved(QString)'),
self.getLayers)
except:
pass
try:
QtCore.QObject.disconnect(QgsMapLayerRegistry.instance(),
QtCore.SIGNAL('layerWasAdded(QgsMapLayer)'),
self.getLayers)
except:
pass
try:
QgsMapLayerRegistry.instance().layersWillBeRemoved.disconnect(
self.layersWillBeRemoved)
QgsMapLayerRegistry.instance().layersAdded.disconnect(
self.layersAdded)
except:
pass
try:
QtCore.QObject.disconnect(self.iface.mapCanvas(),
QtCore.SIGNAL('layersChanged()'),
self.getLayers)
except:
pass
# pylint: enable=W0702
[docs] def validate(self):
"""Helper method to evaluate the current state of the dialog and
determine if it is appropriate for the OK button to be enabled
or not.
.. note:: The enabled state of the OK button on the dialog will
NOT be updated (set True or False) depending on the outcome of
the UI readiness tests performed - **only** True or False
will be returned by the function.
Args:
None.
Returns:
A two-tuple consisting of:
* Boolean reflecting the results of the valudation tests.
* A message indicating any reason why the validation may
have failed.
Example::
flag,myMessage = self.validate()
Raises:
no exceptions explicitly raised
"""
myHazardIndex = self.cboHazard.currentIndex()
myExposureIndex = self.cboExposure.currentIndex()
if myHazardIndex == -1 or myExposureIndex == -1:
myMessage = '<table class="condensed">'
myNotes = self.tr(
'To use this tool you need to add some layers to your '
'QGIS project. Ensure that at least one <em>hazard</em> layer '
'(e.g. earthquake MMI) and one <em>exposure</em> layer (e.g. '
'dwellings) re available. When you are ready, click the <em>'
'run</em> button below.')
myMessage += ('<tr><th class="info button-cell">'
+ self.tr('Getting started:') + '</th></tr>\n'
'<tr><td>' + myNotes + '</td></tr>\n')
myMessage += '</table>'
return (False, myMessage)
if self.cboFunction.currentIndex() == -1:
#myHazardFilename = self.getHazardLayer().source()
myHazardKeywords = QtCore.QString(str(self.keywordIO.readKeywords(
self.getHazardLayer())))
#myExposureFilename = self.getExposureLayer().source()
myExposureKeywords = QtCore.QString(
str(self.keywordIO.readKeywords(
self.getExposureLayer())))
# TODO refactor impact_functions so it is accessible and user here
myMessage = '<table class="condensed">'
myNotes = self.tr('No functions are available for the inputs '
'you have specified. '
'Try selecting a different combination of inputs. '
'Please consult the user manual <FIXME: add link> '
'for details on what constitute valid inputs for '
'a given risk function.')
myMessage += ('<tr><th class="warning button-cell">'
+ self.tr('No valid functions:') + '</th></tr>\n'
'<tr><td>' + myNotes + '</td></tr>\n')
myMessage += ('<tr><th class="info button-cell">'
+ self.tr('Hazard keywords:') + '</th></tr>\n'
'<tr><td>' + myHazardKeywords + '</td></tr>\n')
myMessage += ('<tr><th class="info button-cell">'
+ self.tr('Exposure keywords:') + '</th></tr>\n'
'<tr><td>' + myExposureKeywords + '</td></tr>\n')
myMessage += '</table>'
return (False, myMessage)
else:
# TODO refactor impact_functions so it is accessible and user here
myMessage = '<table class="condensed">'
myNotes = self.tr('You can now proceed to run your model by'
' clicking the <em>Run</em> button.')
myMessage += ('<tr><th class="info button-cell">'
+ self.tr('Ready') + '</th></tr>\n'
'<tr><td>' + myNotes + '</td></tr>\n')
myMessage += '</table>'
return (True, myMessage)
[docs] def on_cboHazard_currentIndexChanged(self, theIndex):
"""Automatic slot executed when the Hazard combo is changed
so that we can see if the ok button should be enabled.
.. note:: Don't use the @pyqtSlot() decorator for autoslots!
Args:
None.
Returns:
None.
Raises:
No exceptions explicitly raised.
"""
# Add any other logic you might like here...
del theIndex
self.getFunctions()
self._toggleCboAggregation()
self.setOkButtonStatus()
[docs] def on_cboExposure_currentIndexChanged(self, theIndex):
"""Automatic slot executed when the Exposure combo is changed
so that we can see if the ok button should be enabled.
.. note:: Don't use the @pyqtSlot() decorator for autoslots!
Args:
None.
Returns:
None.
Raises:
No exceptions explicitly raised.
"""
# Add any other logic you mught like here...
del theIndex
self.getFunctions()
self._toggleCboAggregation()
self.setOkButtonStatus()
@pyqtSlot(QtCore.QString)
[docs] def on_cboFunction_currentIndexChanged(self, theIndex):
"""Automatic slot executed when the Function combo is changed
so that we can see if the ok button should be enabled.
Args:
None.
Returns:
None.
Raises:
no exceptions explicitly raised."""
# Add any other logic you mught like here...
if not theIndex.isNull or not theIndex == '':
myFunctionID = self.getFunctionID()
myFunctions = getSafeImpactFunctions(myFunctionID)
self.myFunction = myFunctions[0][myFunctionID]
self.functionParams = None
if hasattr(self.myFunction, 'parameters'):
self.functionParams = self.myFunction.parameters
self.setToolFunctionOptionsButton()
else:
del theIndex
self._toggleCboAggregation()
self.setOkButtonStatus()
@pyqtSlot()
[docs] def canvasLayersetChanged(self):
"""A helper slot to update the dock combos if the canvas layerset
has been changed (e.g. one or more layer visibilities changed).
If self.showOnlyVisibleLayersFlag is set to False this method will
simply return, doing nothing.
Args:
None
Returns:
None
Raises:
Any exceptions raised by the RIAB library will be propogated.
"""
if self.showOnlyVisibleLayersFlag:
self.getLayers()
@pyqtSlot()
[docs] def layersWillBeRemoved(self):
"""Slot for the new (QGIS 1.8 and beyond api) to notify us when
a group of layers is are removed. This is optimal since if many layers
are removed this slot gets called only once. This slot simply
delegates to getLayers and is only implemented here to make the
connections between the different signals and slots clearer and
better documented."""
self.getLayers()
@pyqtSlot()
[docs] def layersAdded(self, theLayers=None):
"""Slot for the new (QGIS 1.8 and beyond api) to notify us when
a group of layers is are added. This is optimal since if many layers
are added this slot gets called only once. This slot simply
delegates to getLayers and is only implemented here to make the
connections between the different signals and slots clearer and
better documented."""
del theLayers
self.getLayers()
@pyqtSlot()
[docs] def layerWillBeRemoved(self):
"""Slot for the old (pre QGIS 1.8 api) to notify us when
a layer is removed. This is suboptimal since if many layers are
removed this slot gets called multiple times. This slot simply
delegates to getLayers and is only implemented here to make the
connections between the different signals and slots clearer and
better documented."""
self.getLayers()
@pyqtSlot()
[docs] def layerWasAdded(self):
"""Slot for the old (pre QGIS 1.8 api) to notify us when
a layer is added. This is suboptimal since if many layers are
added this slot gets called multiple times. This slot simply
delegates to getLayers and is only implemented here to make the
connections between the different signals and slots clearer and
better documented."""
self.getLayers()
[docs] def getLayers(self):
"""Helper function to obtain a list of layers currently loaded in QGIS.
On invocation, this method will populate cboHazard,
cboExposure and cboAggregate on the dialog with a list of available
layers.
Only **singleband raster** layers will be added to the hazard layer
list,only **point vector** layers will be added to the exposure layer
list and Only **polygon vector** layers will be added to the aggregate
list
Args:
None.
Returns:
None
Raises:
no
"""
self.disconnectLayerListener()
self.blockSignals(True)
self.saveState()
self.cboHazard.clear()
self.cboExposure.clear()
self.cboAggregation.clear()
self.hazardLayers = []
self.exposureLayers = []
self.aggregationLayers = []
# Map registry may be invalid if QGIS is shutting down
myRegistry = None
# pylint: disable=W0702
try:
myRegistry = QgsMapLayerRegistry.instance()
except:
return
# pylint: enable=W0702
myCanvasLayers = self.iface.mapCanvas().layers()
# MapLayers returns a QMap<QString id, QgsMapLayer layer>
myLayers = myRegistry.mapLayers().values()
for myLayer in myLayers:
if (self.showOnlyVisibleLayersFlag and
myLayer not in myCanvasLayers):
continue
# .. todo:: check raster is single band
# store uuid in user property of list widget for layers
myName = myLayer.name()
mySource = str(myLayer.id())
# See if there is a title for this layer, if not,
# fallback to the layer's filename
try:
myTitle = self.keywordIO.readKeywords(myLayer, 'title')
except: # pylint: disable=W0702
myTitle = myName
else:
# Lookup internationalised title if available
myTitle = safeTr(myTitle)
# Register title with layer
if myTitle and self.setLayerNameFromTitleFlag:
myLayer.setLayerName(myTitle)
#check if layer is a vector polygon layer
layer = myRegistry.mapLayer(mySource)
if (layer.type() == QgsMapLayer.VectorLayer) and (
layer.geometryType() == QGis.Polygon):
self.addComboItemInOrder(self.cboAggregation, myTitle,
mySource)
self.aggregationLayers.append(myLayer)
# Find out if the layer is a hazard or an exposure
# layer by querying its keywords. If the query fails,
# the layer will be ignored.
try:
myCategory = self.keywordIO.readKeywords(myLayer, 'category')
except: # pylint: disable=W0702
# continue ignoring this layer
continue
if myCategory == 'hazard':
self.addComboItemInOrder(self.cboHazard, myTitle, mySource)
self.hazardLayers.append(myLayer)
elif myCategory == 'exposure':
self.addComboItemInOrder(self.cboExposure, myTitle, mySource)
self.exposureLayers.append(myLayer)
#handle the cboAggregation combo
self.cboAggregation.insertItem(0, self.tr('No aggregation'))
self.cboAggregation.setCurrentIndex(0)
self._toggleCboAggregation()
# Now populate the functions list based on the layers loaded
self.getFunctions()
self.restoreState()
self.setOkButtonStatus()
# Note: Don't change the order of the next two lines otherwise there
# will be a lot of unneeded looping around as the signal is handled
self.connectLayerListener()
self.blockSignals(False)
self.getAggregationLayer()
return
def _toggleCboAggregation(self):
"""Helper function to toggle the aggregation combo depending on the
current dock status
Args:
None.
Returns:
None
Raises:
no
"""
#FIXME (MB) remove hazardlayer and exposure layer type check when
# vector aggregation is supported
selectedHazardLayer = self.getHazardLayer()
selectedExposureLayer = self.getExposureLayer()
#more than 1 because No aggregation is always there
if (self.cboAggregation.count() > 1 and
selectedHazardLayer is not None and
selectedExposureLayer is not None and
selectedHazardLayer.type() == QgsMapLayer.RasterLayer and
selectedExposureLayer.type() == QgsMapLayer.RasterLayer):
self.cboAggregation.setEnabled(True)
else:
self.cboAggregation.setEnabled(False)
[docs] def getFunctions(self):
"""Helper function to obtain a list of impact functions from
the impact calculator.
Args:
None.
Returns:
None
Raises:
no
"""
# remember what the current function is
myOriginalFunction = self.cboFunction.currentText()
self.cboFunction.clear()
# Get the keyword dictionaries for hazard and exposure
myHazardLayer = self.getHazardLayer()
if myHazardLayer is None:
return
myExposureLayer = self.getExposureLayer()
if myExposureLayer is None:
return
myHazardKeywords = self.keywordIO.readKeywords(myHazardLayer)
# We need to add the layer type to the returned keywords
if myHazardLayer.type() == QgsMapLayer.VectorLayer:
myHazardKeywords['layertype'] = 'vector'
elif myHazardLayer.type() == QgsMapLayer.RasterLayer:
myHazardKeywords['layertype'] = 'raster'
myExposureKeywords = self.keywordIO.readKeywords(myExposureLayer)
# We need to add the layer type to the returned keywords
if myExposureLayer.type() == QgsMapLayer.VectorLayer:
myExposureKeywords['layertype'] = 'vector'
elif myExposureLayer.type() == QgsMapLayer.RasterLayer:
myExposureKeywords['layertype'] = 'raster'
# Find out which functions can be used with these layers
myList = [myHazardKeywords, myExposureKeywords]
try:
myDict = availableFunctions(myList)
# Populate the hazard combo with the available functions
for myFunctionID in myDict:
myFunction = myDict[myFunctionID]
myFunctionTitle = getFunctionTitle(myFunction)
# KEEPING THESE STATEMENTS FOR DEBUGGING UNTIL SETTLED
#print
#print 'myFunction (ID)', myFunctionID
#print 'myFunction', myFunction
#print 'Function title:', myFunctionTitle
# Provide function title and ID to function combo:
# myFunctionTitle is the text displayed in the combo
# myFunctionID is the canonical identifier
self.addComboItemInOrder(self.cboFunction,
myFunctionTitle,
theItemData=myFunctionID)
except Exception, e:
raise e
self.restoreFunctionState(myOriginalFunction)
[docs] def readImpactLayer(self, myEngineImpactLayer):
"""Helper function to read and validate layer.
Args
myEngineImpactLayer: Layer object as provided by the inasafe engine
Returns
validated qgis layer or None
Raises
Exception if layer is not valid
"""
myMessage = ('Input argument must be a InaSAFE spatial object. '
'I got %s' % type(myEngineImpactLayer))
if not hasattr(myEngineImpactLayer, 'is_inasafe_spatial_object'):
raise Exception(myMessage)
if not myEngineImpactLayer.is_inasafe_spatial_object:
raise Exception(myMessage)
# Get associated filename and symbolic name
myFilename = myEngineImpactLayer.get_filename()
myName = myEngineImpactLayer.get_name()
myQgisLayer = None
# Read layer
if myEngineImpactLayer.is_vector:
myQgisLayer = QgsVectorLayer(myFilename, myName, 'ogr')
elif myEngineImpactLayer.is_raster:
myQgisLayer = QgsRasterLayer(myFilename, myName)
# Verify that new qgis layer is valid
if myQgisLayer.isValid():
return myQgisLayer
else:
myMessage = self.tr('Loaded impact layer "%s" is not'
' valid' % myFilename)
raise Exception(myMessage)
[docs] def getHazardLayer(self):
"""Obtain qgsmaplayer id from the userrole of the QtCombo for exposure
and return it as a QgsMapLayer"""
myIndex = self.cboHazard.currentIndex()
if myIndex < 0:
return None
myLayerId = self.cboHazard.itemData(myIndex,
QtCore.Qt.UserRole).toString()
myLayer = QgsMapLayerRegistry.instance().mapLayer(myLayerId)
return myLayer
[docs] def getExposureLayer(self):
"""Obtain the name of the path to the exposure file from the
userrole of the QtCombo for exposure."""
myIndex = self.cboExposure.currentIndex()
if myIndex < 0:
return None
myLayerId = self.cboExposure.itemData(myIndex,
QtCore.Qt.UserRole).toString()
myLayer = QgsMapLayerRegistry.instance().mapLayer(myLayerId)
return myLayer
[docs] def getAggregationLayer(self):
"""Obtain the name of the path to the aggregation file from the
userrole of the QtCombo for aggregation.
Args: None
Returns:
- None if no aggregation is selected or cboAggregation is
disabled
- else a polygon layer
"""
myNoSelectionValue = 0
myIndex = self.cboAggregation.currentIndex()
if myIndex <= myNoSelectionValue:
return None
myLayerId = self.cboAggregation.itemData(myIndex,
QtCore.Qt.UserRole).toString()
myLayer = QgsMapLayerRegistry.instance().mapLayer(myLayerId)
return myLayer
def getAggregationFieldNameCount(self):
return self._aggregationPrefix + 'count'
def getAggregationFieldNameMean(self):
return self._aggregationPrefix + 'mean'
def getAggregationFieldNameSum(self):
return self._aggregationPrefix + 'sum'
[docs] def setupCalculator(self):
"""Initialise the ImpactCalculator based on the current
state of the ui.
Args: None
Returns: None
Raises: Propogates any error from :func:optimalClip()
"""
try:
myHazardFilename, myExposureFilename = self.optimalClip()
except:
QtGui.qApp.restoreOverrideCursor()
self.hideBusy()
raise
# Identify input layers
self.calculator.setHazardLayer(myHazardFilename)
self.calculator.setExposureLayer(myExposureFilename)
# Use canonical function name to identify selected function
myFunctionID = self.getFunctionID()
self.calculator.setFunction(myFunctionID)
[docs] def accept(self):
"""Execute analysis when ok button is clicked."""
#.. todo:: FIXME (Tim) We may have to implement some polling logic
# because the button click accept() function and the updating
# of the web view after model completion are asynchronous (when
# threading mode is enabled especially)
self.showBusy()
myFlag, myMessage = self.validate()
if not myFlag:
self.displayHtml(myMessage)
self.hideBusy()
return
#check and generate keywords for the aggregation layer
self.aggregationLayer = self.getAggregationLayer()
if self.aggregationLayer is not None:
try:
self.aggregationAttribute = self._checkAggregationAttribute()
except Exception, e: # pylint: disable=W0703
# FIXME (MB): This branch is not covered by the tests
QtGui.qApp.restoreOverrideCursor()
self.hideBusy()
myMessage = self.tr('An exception occurred when reading the '
'aggregation attribute.')
myMessage = getExceptionWithStacktrace(e,
html=True,
context=myMessage)
self.displayHtml(myMessage)
return
try:
self.setupCalculator()
except InsufficientOverlapException, e:
QtGui.qApp.restoreOverrideCursor()
self.hideBusy()
myMessage = self.tr('An exception occurred when setting up the '
'impact calculator.')
myMessage = getExceptionWithStacktrace(e,
html=True,
context=myMessage)
self.displayHtml(myMessage)
return
try:
self.runner = self.calculator.getRunner()
except InsufficientParametersException, e:
QtGui.qApp.restoreOverrideCursor()
self.hideBusy()
myContext = self.tr('An exception occurred when setting up the '
' model runner.')
myMessage = getExceptionWithStacktrace(e, html=True,
context=myContext)
self.displayHtml(myMessage)
return
QtCore.QObject.connect(self.runner,
QtCore.SIGNAL('done()'),
self.startPostprocessing)
QtGui.qApp.setOverrideCursor(
QtGui.QCursor(QtCore.Qt.WaitCursor))
self.repaint()
QtGui.qApp.processEvents()
myTitle = self.tr('Calculating impact...')
myMessage = self.tr('This may take a little while - we are '
'computing the areas that will be impacted '
'by the hazard and writing the result to '
'a new layer.')
myProgress = 66
try:
self.showBusy(myTitle, myMessage, myProgress)
if self.runInThreadFlag:
self.runner.start() # Run in different thread
else:
self.runner.run() # Run in same thread
QtGui.qApp.restoreOverrideCursor()
# .. todo :: Disconnect done slot/signal
except Exception, e: # pylint: disable=W0703
# FIXME (Ole): This branch is not covered by the tests
QtGui.qApp.restoreOverrideCursor()
self.hideBusy()
myContext = self.tr('An exception occurred when starting'
' the model.')
myMessage = getExceptionWithStacktrace(e, html=True,
context=myContext)
self.displayHtml(myMessage)
[docs] def completed(self):
"""Slot activated when the process is done."""
# Try to run completion code
try:
myReport = self._completed()
except Exception, e: # pylint: disable=W0703
# FIXME (Ole): This branch is not covered by the tests
# Display message and traceback
myMessage = getExceptionWithStacktrace(e, html=True)
self.displayHtml(myMessage)
else:
# On success, display generated report
self.displayHtml(myReport)
self.saveState()
# Hide hour glass
self.hideBusy()
[docs] def startPostprocessing(self):
"""
Called on self.runner SIGNAL('done()') starts all postprocessing steps
Args: None
Returns: None
"""
if self.aggregationLayer is not None:
self.aggregateResults(88)
self.completed()
self.initPostprocessingOutput()
[docs] def initPostprocessingOutput(self):
"""
initializes and clears self.postprocessingOutput. needs to run at the
end of startPostprocessing
Returns: None
"""
#FIXME (MB) maybe this could be a {} to allow having a parseable
# structure where each postprocessor adds a
# postprocessorname:'report string' pair
self.postprocessingOutput = []
[docs] def addPostprocessingOutput(self, output):
"""
adds text to the postprocessingOutput
Args:
* output: the output from a postprocessor to add to the global
output. It should be valid HTML but no checks are enforced.
Returns: None
"""
self.postprocessingOutput.append(str(output))
[docs] def getPostprocessingOutput(self):
"""
gets the of the postprocessingOutput
Args: None
Returns: a string concatenation of the list elements
"""
return ' '.join(self.postprocessingOutput)
[docs] def aggregateResults(self, progress):
"""
Aggregation postprocessing step, this delas with the gui stuff and
calls _aggregateResults to do the actual aggregation work
Args: progress %to show in the progressbar
Returns: None
"""
myTitle = self.tr('Aggregating results...')
myMessage = self.tr('This may take a little while - we are '
' aggregating the hazards by %1').arg(
self.cboAggregation.currentText())
myProgress = progress
try:
self.showBusy(myTitle, myMessage, myProgress)
self._aggregateResults()
self._parseAggregationResults()
QtGui.qApp.restoreOverrideCursor()
except Exception, e: # pylint: disable=W0703
# FIXME (Ole): This branch is not covered by the tests
QtGui.qApp.restoreOverrideCursor()
self.hideBusy()
myContext = self.tr(
'An exception occurred when aggregating '
'the results')
myMessage = getExceptionWithStacktrace(e, html=True,
context=myContext)
self.displayHtml(myMessage)
def _aggregateResults(self):
"""
Performs Aggregation postprocessing step by
- creating a copy of the dataset clipped by the impactlayer bounding
box
- stripping all attributes beside the aggregation attribute
- delegating to the appropriate aggregator for raster and vectors
Args: None
Returns: None
"""
impactLayer = self.runner.impactLayer()
myQgisImpactLayer = self.readImpactLayer(impactLayer)
if not myQgisImpactLayer.isValid():
myMessage = self.tr('Error when reading %1').arg(myQgisImpactLayer)
raise ReadLayerError(myMessage)
lName = str(self.tr('%1 aggregated to %2')
.arg(myQgisImpactLayer.name())
.arg(self.aggregationLayer.name()))
clippedAggregationLayerPath = clipLayer(
self.aggregationLayer,
impactLayer.get_bounding_box(), explodeMultipart=False)
self.aggregationLayer = QgsVectorLayer(
clippedAggregationLayerPath, lName, 'ogr')
if not self.aggregationLayer.isValid():
myMessage = self.tr('Error when reading %1').arg(
self.aggregationLayer.lastError())
raise ReadLayerError(myMessage)
#delete unwanted fields
vProvider = self.aggregationLayer.dataProvider()
vFields = vProvider.fields()
toDel = []
for i in vFields:
if vFields[i].name() != self.aggregationAttribute:
toDel.append(i)
try:
vProvider.deleteAttributes(toDel)
# FIXME (Ole): Disable pylint check for the moment
# Need to work out what exceptions we will catch here, though.
except: # pylint: disable=W0702
myMessage = self.tr('Could not remove the unneded fields')
LOGGER.debug(myMessage)
del toDel, vProvider, vFields
writeKeywordsToFile(clippedAggregationLayerPath, {'title': lName})
if myQgisImpactLayer.type() == QgsMapLayer.VectorLayer:
self._aggregateResultsVector(myQgisImpactLayer)
elif myQgisImpactLayer.type() == QgsMapLayer.RasterLayer:
self._aggregateResultsRaster(myQgisImpactLayer)
else:
myMessage = self.tr('%1 is %2 but it should be either vector or '
'raster').arg(myQgisImpactLayer.name()).arg(
myQgisImpactLayer.type())
raise ReadLayerError(myMessage)
def _aggregateResultsVector(self, myQgisImpactLayer):
"""
Performs Aggregation postprocessing step on vectorial impact layers
Args:
* myQgisImpactLayer a valid QgsRasterLayer
Returns: None
"""
#TODO implement polygon to polygon aggregation (dissolve,
# line in polygon, point in polygon)
LOGGER.debug('Vector aggregation not implemented yet. Called on'
' %s' % myQgisImpactLayer.name())
return
def _aggregateResultsRaster(self, myQgisImpactLayer):
"""
Performs Aggregation postprocessing step on raster impact layers by
calling QgsZonalStatistics
Args:
* myQgisImpactLayer a valid QgsVectorLayer
Returns: None
"""
zonStat = QgsZonalStatistics(
self.aggregationLayer,
myQgisImpactLayer.dataProvider().dataSourceUri(),
self._aggregationPrefix)
progressDialog = QtGui.QProgressDialog(
self.tr('Calculating zonal statistics'),
self.tr('Abort...'),
0,
0)
zonStat.calculateStatistics(progressDialog)
if progressDialog.wasCanceled():
QtGui.QMessageBox.error(self, self.tr('ZonalStats: Error'),
self.tr(
'You aborted aggregation, '
'so there are no data for analysis. Exiting...'))
if self.showPostProcessingLayers:
QgsMapLayerRegistry.instance().addMapLayer(self.aggregationLayer)
return
def _parseAggregationResults(self):
if self.aggregationAttribute is None:
aggrAttrTitle = self.tr('Aggregation unit')
else:
aggrAttrTitle = self.aggregationAttribute
#open table
myHTML = ('<table class="table table-striped condensed">'
' <tbody>'
' <tr>'
' <td colspan="100%">'
' <strong>'
+ self.aggregationLayer.name() +
' </strong>'
' </td>'
' </tr>'
' <tr>'
' <th width="35%">'
+ aggrAttrTitle +
' </th>'
' <th>'
+ self.tr('Sum') +
' </th>'
' </tr>')
#fill table
provider = self.aggregationLayer.dataProvider()
allAttrs = provider.attributeIndexes()
# start data retreival: fetch no geometry and all attributes for each
# feature
provider.select(allAttrs, QgsRectangle(), False)
try:
nameFieldIndex = self.aggregationLayer.fieldNameIndex(
self.aggregationAttribute)
# FIXME (Ole): Disable pylint check for the moment
# Need to work out what exceptions we will catch here, though.
except: # pylint: disable=W0702
nameFieldIndex = None
try:
sumFieldIndex = self.aggregationLayer.fieldNameIndex(
self.getAggregationFieldNameSum())
except ReadLayerError, e:
QtGui.qApp.restoreOverrideCursor()
self.hideBusy()
myMessage = self.tr('An exception occurred when reading the'
'aggregation data. %1 not found in %2')\
.arg(self.getAggregationFieldNameSum())\
.arg(self.aggregationLayer.name())
myMessage = getExceptionWithStacktrace(e,
html=True,
context=myMessage)
self.displayHtml(myMessage)
return
feat = QgsFeature()
while provider.nextFeature(feat):
attrMap = feat.attributeMap()
if nameFieldIndex is None:
name = str(feat.id())
else:
name = attrMap[nameFieldIndex].toString()
aggrSum = attrMap[sumFieldIndex].toString()
aggrSum = str(int(round(float(aggrSum))))
myHTML += (' <tr>'
' <td>'
+ name +
' </td>'
' <td>'
+ aggrSum +
' </td>'
' </tr>')
#close table
myHTML += (' </tbody>'
'</table>')
self.addPostprocessingOutput(myHTML)
def _checkAggregationAttribute(self):
"""checks if the aggregation layer has a aggregation attribute
keyword. If not it calls _promptForAggregationAttribute to prompt for
an input
Args: None
Returns: the value of the aggregation attribute keyword
Raises: Propogates any error
"""
myKeywordFilePath = os.path.splitext(str(
self.aggregationLayer.source()))[0]
myKeywordFilePath += '.keywords'
try:
keywords = read_keywords(myKeywordFilePath)
# pylint: disable=W0703
except Exception:
keywords = dict()
# pylint: disable=W0703
if ('category' in keywords and
keywords['category'] == 'postprocessing' and
'subcategory' in keywords and
keywords['subcategory'] == 'aggregation' and
'aggregation attribute' in keywords):
#keywords are already complete
myValue = keywords['aggregation attribute']
else:
#set the default values by writing to the keywords
keywords['category'] = 'postprocessing'
keywords['subcategory'] = 'aggregation'
write_keywords(keywords, myKeywordFilePath)
#prompt uset for a choice
myValue = self._promptForAggregationAttribute(myKeywordFilePath)
keywords['aggregation attribute'] = myValue
write_keywords(keywords, myKeywordFilePath)
return myValue
def _promptForAggregationAttribute(self, myKeywordFilePath):
"""prompt user for a decision on which attribute has to be the key
attribute for the aggregated data and writes the keywords file
This could be swapped to a call to the keyword editor
Args: None
Returns: the value of the aggregation attribute keyword. None if no
usable attribute has been found
Raises: Propagates any error
"""
vProvider = self.aggregationLayer.dataProvider()
vFields = vProvider.fields()
fields = []
for i in vFields:
# show only int or string fields to be chosen as aggregation
# attribute other possible would be float
if vFields[i].type() in [
QtCore.QVariant.Int, QtCore.QVariant.String]:
fields.append(vFields[i].name())
#there is no usable attribute, use None
if len(fields) == 0:
aggrAttribute = None
LOGGER.debug('there is no usable attribute, use None')
#there is only one usable attribute, use it
elif len(fields) == 1:
aggrAttribute = fields[0]
LOGGER.debug('there is only one usable attribute, '
'use it: ' + str(aggrAttribute))
#there are multiple usable attribute, prompt for an answer
elif len(fields) > 1:
myTitle = self.tr(
'Waiting for aggregation attribute selection...')
myMessage = self.tr('Please select which attribute you want to'
' use as ID for the aggregated results')
myProgress = 1
self.showBusy(myTitle, myMessage, myProgress)
self.disableBusyCursor()
self.aggregationAttributeDialog = KeywordsDialog(
self.iface.mainWindow(),
self.iface,
self,
self.aggregationLayer)
aggrAttribute = fields[0]
if self.aggregationAttributeDialog.exec_() == \
QtGui.QDialog.Accepted:
keywords = read_keywords(myKeywordFilePath)
try:
aggrAttribute = keywords['aggregation attribute']
LOGGER.debug('User selected: ' + str(aggrAttribute) +
' as aggregation attribute')
# pylint: disable=W0703
except Exception:
LOGGER.debug('User Accepted but did not select a '
'value. Using default : '
+ str(aggrAttribute) +
' as aggregation attribute')
# pylint: disable=W0703
else:
# The user cancelled, use the first attribute as default
LOGGER.debug('User cancelled, using default: '
+ str(aggrAttribute) +
' as aggregation attribute')
self.enableBusyCursor()
return aggrAttribute
def _completed(self):
"""Helper function for slot activated when the process is done.
Args
None
Returns
Report to render on canvas
Raises
Exceptions on a range of error conditions
Provides report out from impact_function to canvas
"""
myTitle = self.tr('Loading results...')
myMessage = self.tr('The impact assessment is complete - loading '
'the results into QGIS now...')
myProgress = 99
self.showBusy(myTitle, myMessage, myProgress)
# FIXME (Ole): Marco and Ole saw situation where self.runner was None.
# Could not be reproduced, but maybe an idea to put an error
# message in that case
myMessage = self.runner.result()
# FIXME (Ole): This branch is not covered by the tests
myEngineImpactLayer = self.runner.impactLayer()
if myEngineImpactLayer is None:
myMessage = str(self.tr('No impact layer was calculated. '
'Error message: %s\n' % str(myMessage)))
if self.runner.lastTraceback() is not None:
myMessage += '<br/><ul>'
for myItem in self.runner.lastTraceback():
# replace is to tidy up windows paths a little
myMessage += ('<li>' + str(myItem.replace('\\\\\\\\', ''))
+ '</li>')
myMessage += '</ul>'
raise Exception(myMessage, self.runner.lastException())
# Load impact layer into QGIS
myQgisImpactLayer = self.readImpactLayer(myEngineImpactLayer)
myKeywords = self.keywordIO.readKeywords(myQgisImpactLayer)
#write postprocessing report to keyword
myKeywords['postprocessing_report'] = self.getPostprocessingOutput()
self.keywordIO.writeKeywords(myQgisImpactLayer, myKeywords)
# Get tabular information from impact layer
myReport = self.keywordIO.readKeywords(myQgisImpactLayer,
'impact_summary')
# Get requested style for impact layer of either kind
myStyle = myEngineImpactLayer.get_style_info()
# Determine styling for QGIS layer
if myEngineImpactLayer.is_vector:
if not myStyle:
# Set default style if possible
pass
else:
setVectorStyle(myQgisImpactLayer, myStyle)
elif myEngineImpactLayer.is_raster:
if not myStyle:
myQgisImpactLayer.setDrawingStyle(
QgsRasterLayer.SingleBandPseudoColor)
myQgisImpactLayer.setColorShadingAlgorithm(
QgsRasterLayer.PseudoColorShader)
else:
setRasterStyle(myQgisImpactLayer, myStyle)
else:
myMessage = self.tr('Impact layer %s was neither a raster or a '
'vector layer' % myQgisImpactLayer.source())
raise ReadLayerError(myMessage)
# Add layer to QGIS
QgsMapLayerRegistry.instance().addMapLayer(myQgisImpactLayer)
# then zoom to it
if self.zoomToImpactFlag:
self.iface.zoomToActiveLayer()
if self.hideExposureFlag:
myExposureLayer = self.getExposureLayer()
myLegend = self.iface.legendInterface()
myLegend.setLayerVisible(myExposureLayer, False)
self.restoreState()
#append postprocessing report
myReport += self.getPostprocessingOutput()
# append properties of the result layer
myReport += ('<table class="table table-striped condensed'
' bordered-table">')
# Add this keyword to report
myReport += ('<tr>'
'<th>' + self.tr('Time stamp')
+ '</th>'
'</tr>'
'<tr>'
'<td>' + str(myKeywords['time_stamp']) + '</td>'
'</tr>')
myReport += ('<tr>'
'<th>' + self.tr('Elapsed time')
+ '</th>'
'</tr>'
'<tr>'
'<td>' + str(myKeywords['elapsed_time'])
+ ' ' + self.tr('seconds') + '</td>'
'</tr>')
myReport += '</table>'
# Return text to display in report panel
return myReport
[docs] def showHelp(self):
"""Load the help text into the wvResults widget"""
if self.helpDialog:
del self.helpDialog
self.helpDialog = Help(theParent=self.iface.mainWindow(),
theContext='dock')
[docs] def showBusy(self, theTitle=None, theMessage=None, theProgress=0):
"""A helper function to indicate the plugin is processing.
Args:
* theTitle - an optional title for the status update. Should be
plain text only
* theMessage - an optional message to pass to the busy indicator.
Can be an html snippet.
* theProgress - a number between 0 and 100 indicating % complete
Returns:
None
Raises:
Any exceptions raised by the RIAB library will be propagated.
..note:: Uses bootstrap css for progress bar.
"""
#self.pbnRunStop.setText('Cancel')
self.pbnRunStop.setEnabled(False)
if theTitle is None:
theTitle = self.tr('Analyzing this question...')
myHtml = ('<table class="condensed">'
' <tr>'
' <th class="info button-cell">'
+ str(theTitle) +
' </th>'
' </tr>'
' <tr>'
' <td>'
+ str(theMessage) +
' </td>'
' </tr>'
' <tr>'
' <td>'
' <div class="progress">'
' <div class="bar" '
' style="width: ' + str(theProgress) + '%;">'
' </div>'
' </div>'
' </td>'
' </tr>'
'</table>')
self.displayHtml(myHtml)
self.repaint()
QtGui.qApp.processEvents()
self.grpQuestion.setEnabled(False)
[docs] def hideBusy(self):
"""A helper function to indicate processing is done."""
#self.pbnRunStop.setText('Run')
if self.runner:
QtCore.QObject.disconnect(self.runner,
QtCore.SIGNAL('done()'),
self.startPostprocessing)
self.runner = None
self.grpQuestion.setEnabled(True)
self.pbnRunStop.setEnabled(True)
self.repaint()
[docs] def enableBusyCursor(self):
"""Set the hourglass enabled."""
QtGui.qApp.setOverrideCursor(QtGui.QCursor(QtCore.Qt.WaitCursor))
[docs] def disableBusyCursor(self):
"""Disable the hourglass cursor"""
QtGui.qApp.restoreOverrideCursor()
[docs] def optimalClip(self):
""" A helper function to perform an optimal clip of the input data.
Optimal extent should be considered as the intersection between
the three inputs. The inasafe library will perform various checks
to ensure that the extent is tenable, includes data from both
etc.
The result of this function will be two layers which are
clipped and resampled if needed, and in the EPSG:4326 geographic
coordinate reference system.
Args:
None
Returns:
A two-tuple containing the paths to the clipped hazard and
exposure layers.
Raises:
Any exceptions raised by the InaSAFE library will be propogated.
"""
# Get the hazard and exposure layers selected in the combos
myHazardLayer = self.getHazardLayer()
myExposureLayer = self.getExposureLayer()
# Reproject all extents to EPSG:4326 if needed
myGeoCrs = QgsCoordinateReferenceSystem()
myGeoCrs.createFromEpsg(4326)
# Get the current viewport extent as an array in EPSG:4326
myViewportGeoExtent = self.viewportGeoArray()
# Get the Hazard extents as an array in EPSG:4326
myHazardGeoExtent = self.extentToGeoArray(myHazardLayer.extent(),
myHazardLayer.crs())
# Get the Exposure extents as an array in EPSG:4326
myExposureGeoExtent = self.extentToGeoArray(myExposureLayer.extent(),
myExposureLayer.crs())
# Now work out the optimal extent between the two layers and
# the current view extent. The optimal extent is the intersection
# between the two layers and the viewport.
myGeoExtent = None
try:
# Extent is returned as an array [xmin,ymin,xmax,ymax]
# We will convert it to a QgsRectangle afterwards.
if self.clipToViewport:
myGeoExtent = getOptimalExtent(myHazardGeoExtent,
myExposureGeoExtent,
myViewportGeoExtent)
else:
myGeoExtent = getOptimalExtent(myHazardGeoExtent,
myExposureGeoExtent)
except InsufficientOverlapException, e:
# FIXME (MB): This branch is not covered by the tests
myMessage = self.tr('<p>There '
'was insufficient overlap between the input layers '
'and / or the layers and the viewable area. Please select '
'two overlapping layers and zoom or pan to them or disable'
' viewable area clipping in the options dialog'
'. Full details follow:</p>'
'<p>Failed to obtain the optimal extent given:</p>'
'<p>Hazard: %1</p>'
'<p>Exposure: %2</p>'
'<p>Viewable area Geo Extent: %3</p>'
'<p>Hazard Geo Extent: %4</p>'
'<p>Exposure Geo Extent: %5</p>'
'<p>Viewable area clipping enabled: %6</p>'
'<p>Details: %7</p>').arg(
myHazardLayer.source()).arg(
myExposureLayer.source()).arg(
QtCore.QString(str(myViewportGeoExtent))).arg(
QtCore.QString(str(myHazardGeoExtent))).arg(
QtCore.QString(str(myExposureGeoExtent))).arg(
QtCore.QString(str(self.clipToViewport))).arg(
str(e))
raise InsufficientOverlapException(myMessage)
# Next work out the ideal spatial resolution for rasters
# in the analysis. If layers are not native WGS84, we estimate
# this based on the geographic extents
# rather than the layers native extents so that we can pass
# the ideal WGS84 cell size and extents to the layer prep routines
# and do all preprocessing in a single operation.
# All this is done in the function getWGS84resolution
myBufferedGeoExtent = myGeoExtent # Bbox to use for hazard layer
myCellSize = None
extraExposureKeywords = {}
if myHazardLayer.type() == QgsMapLayer.RasterLayer:
# Hazard layer is raster
myHazardGeoCellSize = getWGS84resolution(myHazardLayer)
if myExposureLayer.type() == QgsMapLayer.RasterLayer:
# In case of two raster layers establish common resolution
myExposureGeoCellSize = getWGS84resolution(myExposureLayer)
if myHazardGeoCellSize < myExposureGeoCellSize:
myCellSize = myHazardGeoCellSize
else:
myCellSize = myExposureGeoCellSize
# Record native resolution to allow rescaling of exposure data
if not numpy.allclose(myCellSize, myExposureGeoCellSize):
extraExposureKeywords['resolution'] = myExposureGeoCellSize
else:
# If exposure is vector data grow hazard raster layer to
# ensure there are enough pixels for points at the edge of
# the view port to be interpolated correctly. This requires
# resolution to be available
if myExposureLayer.type() != QgsMapLayer.VectorLayer:
raise RuntimeError
myBufferedGeoExtent = getBufferedExtent(myGeoExtent,
myHazardGeoCellSize)
else:
# Hazard layer is vector
# FIXME (Ole): Check that it is a polygon layer
# FIXME (Ole): This should say something like this (issue #285)
#if myHazardLayer.geometry() == QgsMapLayer.Point:
# myGeoExtent = myExposureGeoExtent
pass
# Make sure that we have EPSG:4326 versions of the input layers
# that are clipped and (in the case of two raster inputs) resampled to
# the best resolution.
myTitle = self.tr('Preparing hazard data...')
myMessage = self.tr('We are resampling and clipping the hazard'
'layer to match the intersection of the exposure'
'layer and the current view extents.')
myProgress = 22
self.showBusy(myTitle, myMessage, myProgress)
myClippedHazardPath = clipLayer(myHazardLayer, myBufferedGeoExtent,
myCellSize)
myTitle = self.tr('Preparing exposure data...')
myMessage = self.tr('We are resampling and clipping the exposure'
'layer to match the intersection of the hazard'
'layer and the current view extents.')
myProgress = 44
self.showBusy(myTitle, myMessage, myProgress)
myClippedExposurePath = clipLayer(
myExposureLayer,
myGeoExtent, myCellSize,
theExtraKeywords=extraExposureKeywords)
return myClippedHazardPath, myClippedExposurePath
############################################################
# logic checked to here..............
############################################################
# .. todo:: Cleanup temporary working files, careful not to delete
# User's own data'
# FIXME: Turn paths back into layers temporarily and print res
#myExposureLayer = QgsRasterLayer(myClippedExposurePath, 'exp')
#myHazardLayer = QgsRasterLayer(myClippedHazardPath, 'haz')
#myHazardUPP = myHazardLayer.rasterUnitsPerPixel()
#myExposureUPP = myExposureLayer.rasterUnitsPerPixel()
# FIXME (Ole): This causes some strange failures. Revisit!
# Check that resolutions are equal up to some precision
#myMessage = ('Resampled pixels sizes did not match: '
# 'Exposure pixel size = %.12f, '
# 'Hazard pixel size = %.12f' % (myExposureUPP, myHazardUPP))
#if not numpy.allclose(myExposureUPP, myHazardUPP,
# # FIXME (Ole): I would like to make this tighter
# rtol=1.0e-6, atol=1.0e-3):
# raise RuntimeError(myMessage)
#print "Resampled Exposure Units Per Pixel: %s" % myExposureUPP
#print "Resampled Hazard Units Per Pixel: %s" % myHazardUPP
[docs] def viewportGeoArray(self):
"""Obtain the map canvas current extent in EPSG:4326"""
# get the current viewport extent
myCanvas = self.iface.mapCanvas()
myRect = myCanvas.extent()
myCrs = None
if myCanvas.hasCrsTransformEnabled():
myCrs = myCanvas.mapRenderer().destinationCrs()
else:
# some code duplication from extentToGeoArray here
# in favour of clarity of logic...
myCrs = QgsCoordinateReferenceSystem()
myCrs.createFromEpsg(4326)
return self.extentToGeoArray(myRect, myCrs)
[docs] def extentToGeoArray(self, theExtent, theSourceCrs):
"""Convert the supplied extent to geographic and return as as array"""
# FIXME (Ole): As there is no reference to self, this function
# should be a general helper outside the class
myGeoCrs = QgsCoordinateReferenceSystem()
myGeoCrs.createFromEpsg(4326)
myXForm = QgsCoordinateTransform(
theSourceCrs,
myGeoCrs)
# Get the clip area in the layer's crs
myTransformedExtent = myXForm.transformBoundingBox(theExtent)
myGeoExtent = [myTransformedExtent.xMinimum(),
myTransformedExtent.yMinimum(),
myTransformedExtent.xMaximum(),
myTransformedExtent.yMaximum()]
return myGeoExtent
[docs] def displayHtml(self, theMessage):
"""Given an html snippet, wrap it in a page header and footer
and display it in the wvResults widget."""
myHtml = self.htmlHeader() + theMessage + self.htmlFooter()
#f = file('/tmp/h.thml', 'wa') # for debugging
#f.write(myHtml)
#f.close()
self.wvResults.setHtml(myHtml)
[docs] def layerChanged(self, theLayer):
"""Handler for when the QGIS active layer is changed.
If the active layer is changed and it has keywords and a report,
show the report..
.. see also:: :func:`IS.layerChanged`.
Args:
theLayer - the QgsMapLayer instance that is now active..
Returns:
None.
Raises:
no exceptions explicitly raised.
"""
myReport = ('<table class="table table-striped condensed'
' bordered-table">') # will be overridden if needed
if theLayer is not None:
try:
myKeywords = self.keywordIO.readKeywords(theLayer)
if 'impact_summary' in myKeywords:
myReport = myKeywords['impact_summary']
if 'postprocessing_report' in myKeywords:
myReport += myKeywords['postprocessing_report']
# append properties of the result layer
myReport += ('<table class="table table-striped condensed'
' bordered-table">')
# Add this keyword to report
myReport += ('<tr>'
'<th>' + self.tr('Time stamp')
+ '</th>'
'</tr>'
'<tr>'
'<td>' + str(myKeywords['time_stamp']) + '</td>'
'</tr>')
myReport += ('<tr>'
'<th>' + self.tr('Elapsed time')
+ '</th>'
'</tr>'
'<tr>'
'<td>' + str(myKeywords['elapsed_time'])
+ ' ' + self.tr('seconds') + '</td>'
'</tr>')
myReport += '</table>'
self.pbnPrint.setEnabled(True)
else:
self.pbnPrint.setEnabled(False)
for myKeyword in myKeywords:
myValue = myKeywords[myKeyword]
# Translate titles explicitly if possible
if myKeyword == 'title':
myValue = safeTr(myValue)
# Add this keyword to report
myReport += ('<tr>'
# FIXME (Ole): Not sure if this will work
# with translations
'<th>' + self.tr(myKeyword.capitalize())
+ '</th>'
'</tr>'
'<tr>'
'<td>' + str(myValue) + '</td>'
'</tr>')
myReport += '</table>'
except (KeywordNotFoundException, HashNotFoundException,
InvalidParameterException), e:
myContext = self.tr('No keywords have been defined'
' for this layer yet. If you wish to use it as'
' an impact or hazard layer in a scenario, please'
' use the keyword editor. You can open the keyword'
' editor by clicking on the'
' <img src="qrc:/plugins/inasafe/keywords.png" '
' width="16" height="16"> icon'
' in the toolbar, or choosing Plugins -> InaSAFE'
' -> Keyword Editor from the menus.')
myReport += getExceptionWithStacktrace(e, html=True,
context=myContext)
except Exception, e:
myReport += getExceptionWithStacktrace(e, html=True)
if myReport is not None:
self.displayHtml(myReport)
[docs] def saveState(self):
"""Save the current state of the ui to an internal class member
so that it can be restored again easily.
Args:
None
Returns:
None
Raises:
Any exceptions raised by the InaSAFE library will be propogated.
"""
myStateDict = {'hazard': self.cboHazard.currentText(),
'exposure': self.cboExposure.currentText(),
'function': self.cboFunction.currentText(),
'aggregation': self.cboAggregation.currentText(),
'report':
self.wvResults.page().currentFrame().toHtml()}
self.state = myStateDict
[docs] def restoreState(self):
"""Restore the state of the dock to the last known state.
Args:
None
Returns:
None
Raises:
Any exceptions raised by the InaSAFE library will be propogated.
"""
if self.state is None:
return
for myCount in range(0, self.cboExposure.count()):
myItemText = self.cboExposure.itemText(myCount)
if myItemText == self.state['exposure']:
self.cboExposure.setCurrentIndex(myCount)
break
for myCount in range(0, self.cboHazard.count()):
myItemText = self.cboHazard.itemText(myCount)
if myItemText == self.state['hazard']:
self.cboHazard.setCurrentIndex(myCount)
break
for myCount in range(0, self.cboAggregation.count()):
myItemText = self.cboAggregation.itemText(myCount)
if myItemText == self.state['aggregation']:
self.cboAggregation.setCurrentIndex(myCount)
break
self.restoreFunctionState(self.state['function'])
self.wvResults.setHtml(self.state['report'])
[docs] def restoreFunctionState(self, theOriginalFunction):
"""Restore the function combo to a known state.
Args:
theOriginalFunction - name of function that should be selected
Returns:
None
Raises:
Any exceptions raised by the RIAB library will be propogated.
"""
# Restore previous state of combo
for myCount in range(0, self.cboFunction.count()):
myItemText = self.cboFunction.itemText(myCount)
if myItemText == theOriginalFunction:
self.cboFunction.setCurrentIndex(myCount)
break
[docs] def printMap(self):
"""Slot to print map when print map button pressed.
Args:
None
Returns:
None
Raises:
Any exceptions raised by the InaSAFE library will be propogated.
"""
myMap = Map(self.iface)
if self.iface.activeLayer() is None:
QtGui.QMessageBox.warning(self,
self.tr('InaSAFE'),
self.tr('Please select a valid impact layer'
' before trying to print.'))
return
self.showBusy(self.tr('Map Creator'),
self.tr('Preparing map and report'),
theProgress=20)
myMap.setImpactLayer(self.iface.activeLayer())
LOGGER.debug('Map Title: %s' % myMap.getMapTitle())
myMapFilename = QtGui.QFileDialog.getSaveFileName(self,
self.tr('Write to PDF'),
os.path.join(temp_dir(),
myMap.getMapTitle() + '.pdf'),
self.tr('Pdf File (*.pdf)'))
myMapFilename = str(myMapFilename)
myTableFilename = os.path.splitext(myMapFilename)[0] + '_table.pdf'
myHtmlRenderer = HtmlRenderer(thePageDpi=myMap.pageDpi)
myHtmlPdfPath = myHtmlRenderer.printImpactTable(
theLayer=self.iface.activeLayer(), theFilename=myTableFilename)
try:
myMapPdfPath = myMap.printToPdf(myMapFilename)
except Exception, e: # pylint: disable=W0703
# FIXME (Ole): This branch is not covered by the tests
myReport = getExceptionWithStacktrace(e, html=True)
if myReport is not None:
self.displayHtml(myReport)
myStatus = self.tr('Your PDF was created....opening using '
'the default PDF viewer on your system. '
'The generated pdfs were saved as:%1'
'%2%1 and %1%3').arg(
'<br>').arg(QtCore.QString(
myMapPdfPath)).arg(QtCore.QString(
myHtmlPdfPath))
self.showBusy(self.tr('Map Creator'),
myStatus,
theProgress=80)
QtGui.QDesktopServices.openUrl(
QtCore.QUrl('file:///' + myHtmlPdfPath,
QtCore.QUrl.TolerantMode))
QtGui.QDesktopServices.openUrl(
QtCore.QUrl('file:///' + myMapPdfPath,
QtCore.QUrl.TolerantMode))
self.showBusy(self.tr('Map Creator'),
myStatus,
theProgress=100)
self.hideBusy()
myMap.showComposer()
[docs] def addComboItemInOrder(self, theCombo, theItemText, theItemData=None):
"""Although QComboBox allows you to set an InsertAlphabetically enum
this only has effect when a user interactively adds combo items to
an editable combo. This we have this little function to ensure that
combos are always sorted alphabetically.
Args:
* theCombo - combo box receiving the new item
* theItemText - display text for the combo
* theItemData - optional UserRole data to be associated with
the item
Returns:
None
Raises:
..todo:: Move this to utilities
"""
mySize = theCombo.count()
for myCount in range(0, mySize):
myItemText = str(theCombo.itemText(myCount))
# see if theItemText alphabetically precedes myItemText
if cmp(str(theItemText).lower(), myItemText.lower()) < 0:
theCombo.insertItem(myCount, theItemText, theItemData)
return
#otherwise just add it to the end
theCombo.insertItem(mySize, theItemText, theItemData)
[docs] def getFunctionID(self, theIndex=None):
"""Get the canonical impact function ID for the currently selected
function (or the specified combo entry if theIndex is supplied.
Args:
theIndex int - Optional index position in the combo that you
want the function id for. Defaults to None. If not set / None
the currently selected combo item's function id will be
returned.
Returns:
myFunctionID str - String that identifies the function
Raises:
None
"""
if theIndex is None:
myIndex = self.cboFunction.currentIndex()
else:
myIndex = theIndex
myItemData = self.cboFunction.itemData(myIndex, QtCore.Qt.UserRole)
myFunctionID = str(myItemData.toString())
return myFunctionID