def __init__(self, iface):
"""Constructor.
:param iface: An interface instance that will be passed to this class
which provides the hook by which you can manipulate the QGIS
application at run time.
:type iface: QgsInterface
"""
#self.dialogClosed = pyqtSignal()
# Save reference to the QGIS interface
self.iface = iface
# initialize plugin directory
self.plugin_dir = os.path.dirname(__file__)
# initialize locale
locale = QSettings().value('locale/userLocale')[0:2]
locale_path = os.path.join(
self.plugin_dir, 'i18n',
'MetricCatchmentAnalyser_{}.qm'.format(locale))
if os.path.exists(locale_path):
self.translator = QTranslator()
self.translator.load(locale_path)
if qVersion() > '4.3.3':
QCoreApplication.installTranslator(self.translator)
# Create the dialog (after translation) and keep reference
self.dlg = MetricCatchmentAnalyserDialog()
self.mca_tools = mca_tools
# Declare instance attributes
self.actions = []
self.menu = self.tr(u'&Metric Catchment Analyser')
# TODO: We are going to let the user set this up in a future iteration
self.toolbar = self.iface.addToolBar(u'MetricCatchmentAnalyser')
self.toolbar.setObjectName(u'MetricCatchmentAnalyser')
# Setup input network
self.dlg.path_input_network.clear()
self.dlg.browse_input_network.clicked.connect(
self.browse_input_network)
self.dlg.choose_network.activated.connect(self.choose_network)
# Setup input origins
self.dlg.path_input_origins.clear()
self.dlg.browse_input_origins.clicked.connect(
self.browse_input_origins)
self.dlg.choose_origins.activated.connect(self.choose_origins)
# Setup output network
self.dlg.browse_output_network.clicked.connect(
self.browse_output_network)
self.dlg.path_output_network.setPlaceholderText(
"Save as temporary layer...")
# Setup output catchment
self.dlg.browse_output_polygon.clicked.connect(
self.browse_output_polygon)
self.dlg.path_output_polygon.setPlaceholderText(
"Save as temporary layer...")
# Setup cost
self.dlg.check_cost.stateChanged.connect(self.browse_cost)
self.dlg.choose_cost.activated.connect(self.choose_cost)
# Setup names
self.dlg.check_name.stateChanged.connect(self.browse_name)
self.dlg.choose_name.activated.connect(self.choose_name)
# connect refresh button
self.dlg.refresh_mca.clicked.connect(self.refresh)
# connect the run button
self.dlg.run_mca.clicked.connect(self.analysis)
# connect the close button
self.dlg.close_mca.clicked.connect(self.closeEvent)
# setup the progress bar
self.dlg.progress_mca.setMinimum(0)
self.dlg.progress_mca.setMaximum(5)
def __init__(self, iface):
"""Constructor.
:param iface: An interface instance that will be passed to this class
which provides the hook by which you can manipulate the QGIS
application at run time.
:type iface: QgsInterface
"""
#self.dialogClosed = pyqtSignal()
# Save reference to the QGIS interface
self.iface = iface
# initialize plugin directory
self.plugin_dir = os.path.dirname(__file__)
# initialize locale
locale = QSettings().value('locale/userLocale')[0:2]
locale_path = os.path.join(
self.plugin_dir,
'i18n',
'MetricCatchmentAnalyser_{}.qm'.format(locale))
if os.path.exists(locale_path):
self.translator = QTranslator()
self.translator.load(locale_path)
if qVersion() > '4.3.3':
QCoreApplication.installTranslator(self.translator)
# Create the dialog (after translation) and keep reference
self.dlg = MetricCatchmentAnalyserDialog()
self.mca_tools = mca_tools
# Declare instance attributes
self.actions = []
self.menu = self.tr(u'&Metric Catchment Analyser')
# TODO: We are going to let the user set this up in a future iteration
self.toolbar = self.iface.addToolBar(u'MetricCatchmentAnalyser')
self.toolbar.setObjectName(u'MetricCatchmentAnalyser')
# Setup input network
self.dlg.path_input_network.clear()
self.dlg.browse_input_network.clicked.connect(self.browse_input_network)
self.dlg.choose_network.activated.connect(self.choose_network)
# Setup input origins
self.dlg.path_input_origins.clear()
self.dlg.browse_input_origins.clicked.connect(self.browse_input_origins)
self.dlg.choose_origins.activated.connect(self.choose_origins)
# Setup output network
self.dlg.browse_output_network.clicked.connect(self.browse_output_network)
self.dlg.path_output_network.setPlaceholderText("Save as temporary layer...")
# Setup output catchment
self.dlg.browse_output_polygon.clicked.connect(self.browse_output_polygon)
self.dlg.path_output_polygon.setPlaceholderText("Save as temporary layer...")
# Setup cost
self.dlg.check_cost.stateChanged.connect(self.browse_cost)
self.dlg.choose_cost.activated.connect(self.choose_cost)
# Setup names
self.dlg.check_name.stateChanged.connect(self.browse_name)
self.dlg.choose_name.activated.connect(self.choose_name)
# connect refresh button
self.dlg.refresh_mca.clicked.connect(self.refresh)
# connect the run button
self.dlg.run_mca.clicked.connect(self.analysis)
# connect the close button
self.dlg.close_mca.clicked.connect(self.closeEvent)
# setup the progress bar
self.dlg.progress_mca.setMinimum(0)
self.dlg.progress_mca.setMaximum(5)
class MetricCatchmentAnalyser:
"""QGIS Plugin Implementation."""
def __init__(self, iface):
"""Constructor.
:param iface: An interface instance that will be passed to this class
which provides the hook by which you can manipulate the QGIS
application at run time.
:type iface: QgsInterface
"""
#self.dialogClosed = pyqtSignal()
# Save reference to the QGIS interface
self.iface = iface
# initialize plugin directory
self.plugin_dir = os.path.dirname(__file__)
# initialize locale
locale = QSettings().value('locale/userLocale')[0:2]
locale_path = os.path.join(
self.plugin_dir, 'i18n',
'MetricCatchmentAnalyser_{}.qm'.format(locale))
if os.path.exists(locale_path):
self.translator = QTranslator()
self.translator.load(locale_path)
if qVersion() > '4.3.3':
QCoreApplication.installTranslator(self.translator)
# Create the dialog (after translation) and keep reference
self.dlg = MetricCatchmentAnalyserDialog()
self.mca_tools = mca_tools
# Declare instance attributes
self.actions = []
self.menu = self.tr(u'&Metric Catchment Analyser')
# TODO: We are going to let the user set this up in a future iteration
self.toolbar = self.iface.addToolBar(u'MetricCatchmentAnalyser')
self.toolbar.setObjectName(u'MetricCatchmentAnalyser')
# Setup input network
self.dlg.path_input_network.clear()
self.dlg.browse_input_network.clicked.connect(
self.browse_input_network)
self.dlg.choose_network.activated.connect(self.choose_network)
# Setup input origins
self.dlg.path_input_origins.clear()
self.dlg.browse_input_origins.clicked.connect(
self.browse_input_origins)
self.dlg.choose_origins.activated.connect(self.choose_origins)
# Setup output network
self.dlg.browse_output_network.clicked.connect(
self.browse_output_network)
self.dlg.path_output_network.setPlaceholderText(
"Save as temporary layer...")
# Setup output catchment
self.dlg.browse_output_polygon.clicked.connect(
self.browse_output_polygon)
self.dlg.path_output_polygon.setPlaceholderText(
"Save as temporary layer...")
# Setup cost
self.dlg.check_cost.stateChanged.connect(self.browse_cost)
self.dlg.choose_cost.activated.connect(self.choose_cost)
# Setup names
self.dlg.check_name.stateChanged.connect(self.browse_name)
self.dlg.choose_name.activated.connect(self.choose_name)
# connect refresh button
self.dlg.refresh_mca.clicked.connect(self.refresh)
# connect the run button
self.dlg.run_mca.clicked.connect(self.analysis)
# connect the close button
self.dlg.close_mca.clicked.connect(self.closeEvent)
# setup the progress bar
self.dlg.progress_mca.setMinimum(0)
self.dlg.progress_mca.setMaximum(5)
# noinspection PyMethodMayBeStatic
def tr(self, message):
"""Get the translation for a string using Qt translation API.
We implement this ourselves since we do not inherit QObject.
:param message: String for translation.
:type message: str, QString
:returns: Translated version of message.
:rtype: QString
"""
# noinspection PyTypeChecker,PyArgumentList,PyCallByClass
return QCoreApplication.translate('MetricCatchmentAnalyser', message)
def add_action(self,
icon_path,
text,
callback,
enabled_flag=True,
add_to_menu=True,
add_to_toolbar=True,
status_tip=None,
whats_this=None,
parent=None):
"""Add a toolbar icon to the toolbar.
:param icon_path: Path to the icon for this action. Can be a resource
path (e.g. ':/plugins/foo/bar.png') or a normal file system path.
:type icon_path: str
:param text: Text that should be shown in menu items for this action.
:type text: str
:param callback: Function to be called when the action is triggered.
:type callback: function
:param enabled_flag: A flag indicating if the action should be enabled
by default. Defaults to True.
:type enabled_flag: bool
:param add_to_menu: Flag indicating whether the action should also
be added to the menu. Defaults to True.
:type add_to_menu: bool
:param add_to_toolbar: Flag indicating whether the action should also
be added to the toolbar. Defaults to True.
:type add_to_toolbar: bool
:param status_tip: Optional text to show in a popup when mouse pointer
hovers over the action.
:type status_tip: str
:param parent: Parent widget for the new action. Defaults None.
:type parent: QWidget
:param whats_this: Optional text to show in the status bar when the
mouse pointer hovers over the action.
:returns: The action that was created. Note that the action is also
added to self.actions list.
:rtype: QAction
"""
icon = QIcon(icon_path)
action = QAction(icon, text, parent)
action.triggered.connect(callback)
action.setEnabled(enabled_flag)
if status_tip is not None:
action.setStatusTip(status_tip)
if whats_this is not None:
action.setWhatsThis(whats_this)
if add_to_toolbar:
self.toolbar.addAction(action)
if add_to_menu:
self.iface.addPluginToMenu(self.menu, action)
self.actions.append(action)
return action
def initGui(self):
"""Create the menu entries and toolbar icons inside the QGIS GUI."""
icon_path = ':/plugins/MetricCatchmentAnalyser/icon.png'
self.add_action(icon_path,
text=self.tr(u'Metric Catchment Analyser'),
callback=self.run,
parent=self.iface.mainWindow())
def unload(self):
"""Removes the plugin menu item and icon from QGIS GUI."""
for action in self.actions:
self.iface.removePluginMenu(self.tr(u'&Metric Catchment Analyser'),
action)
self.iface.removeToolBarIcon(action)
# remove the toolbar
del self.toolbar
def browse_input_network(self):
filename = QFileDialog.getOpenFileName(self.dlg, "Select input file ",
"", '*.shp')
if filename:
network = QgsVectorLayer(filename, 'input', 'ogr')
# Checking network layer
if not network.isValid():
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"Invalid network file!",
level=QgsMessageBar.WARNING,
duration=5)
elif not (network.wkbType() == 2 or network.wkbType() == 5):
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"This file does not contain lines!",
level=QgsMessageBar.WARNING,
duration=5)
else:
# Showing path/name of network
self.dlg.path_input_network.setText(filename)
# Activate custom cost option
self.browse_cost()
def choose_network(self):
layers = self.iface.legendInterface().layers()
layer_name = self.dlg.choose_network.currentText()
layer_index = self.dlg.choose_network.currentIndex()
network = layers[layer_index]
if not network.isValid():
self.iface.messageBar().pushMessage("Metric Catchment Analyser: ",
"Invalid network file!",
level=QgsMessageBar.WARNING,
duration=5)
else:
self.dlg.path_input_network.setText(layer_name)
# Activate custom cost option
self.browse_cost()
def browse_cost(self):
if self.dlg.check_cost.isChecked() == True:
# Activate and refresh combobox
self.dlg.choose_cost.setEnabled(True)
self.dlg.choose_cost.clear()
self.dlg.cost_column.setEnabled(True)
self.dlg.cost_column.clear()
# Get origins table
network_name = self.dlg.path_input_network.text()
# Get active layers
active_layers = self.iface.legendInterface().layers()
active_layer_names = [layer.name() for layer in active_layers]
# loading network
if network_name in active_layer_names:
network = active_layers[active_layer_names.index(network_name)]
else:
network = QgsVectorLayer("%s" % (network_name), "", "ogr")
# Creating field list
network_fields = network.pendingFields()
network_field_names = [field.name() for field in network_fields]
# Adding layers to the comboboxes
self.dlg.choose_cost.addItems(network_field_names)
elif self.dlg.check_cost.isChecked() == False:
self.dlg.choose_cost.setEnabled(False)
self.dlg.choose_cost.clear()
self.dlg.cost_column.setEnabled(False)
self.dlg.cost_column.clear()
def choose_cost(self):
if self.dlg.path_input_network.text():
cost_name = self.dlg.choose_cost.currentText()
self.dlg.cost_column.setText(cost_name)
else:
self.dlg.choose_cost.clear()
self.dlg.cost_column.clear()
def choose_origins(self):
layers = self.iface.legendInterface().layers()
layer_name = self.dlg.choose_origins.currentText()
layer_index = self.dlg.choose_origins.currentIndex()
origins = layers[layer_index]
if not origins.isValid():
self.iface.messageBar().pushMessage("Metric Catchment Analyser: ",
"Invalid origin file!",
level=QgsMessageBar.WARNING,
duration=5)
else:
self.dlg.path_input_origins.setText(layer_name)
# Activate custom name option
self.browse_name()
def browse_input_origins(self):
filename = QFileDialog.getOpenFileName(self.dlg, "Select input file ",
"", '*.shp')
if filename:
origins = QgsVectorLayer(filename, 'input', 'ogr')
if not origins.isValid():
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"Invalid origin file!",
level=QgsMessageBar.WARNING,
duration=5)
elif not origins.wkbType() == 1:
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"This file does not contain points!",
level=QgsMessageBar.WARNING,
duration=5)
else:
self.dlg.path_input_origins.setText(filename)
# Activate custom name option
self.browse_name()
def browse_name(self):
# Activate custom names
if self.dlg.check_name.isChecked() == True:
# Activate and refresh combobox
self.dlg.choose_name.setEnabled(True)
self.dlg.choose_name.clear()
self.dlg.name_column.setEnabled(True)
self.dlg.name_column.clear()
# Get origins table
origins_name = self.dlg.path_input_origins.text()
# Get active layers
active_layers = self.iface.legendInterface().layers()
active_layer_names = [layer.name() for layer in active_layers]
# loading origins
if origins_name in active_layer_names:
origins = active_layers[active_layer_names.index(origins_name)]
else:
origins = QgsVectorLayer("%s" % (origins_name), "", "ogr")
# Creating field list
origins_fields = origins.pendingFields()
origin_field_names = [field.name() for field in origins_fields]
# Adding layers to the comboboxes
self.dlg.choose_name.addItems(origin_field_names)
# Deactivate custom naqmes
elif self.dlg.check_name.isChecked() == False:
self.dlg.choose_name.setEnabled(False)
self.dlg.choose_name.clear()
self.dlg.name_column.setEnabled(False)
self.dlg.name_column.clear()
def choose_name(self):
if self.dlg.path_input_origins.text():
name_column = self.dlg.choose_name.currentText()
self.dlg.name_column.setText(name_column)
else:
self.dlg.choose_name.clear()
self.dlg.name_column.clear()
def browse_output_network(self):
file_name = QFileDialog.getSaveFileName(self.dlg, "Save output file ",
"mca_network", '*.shp')
if file_name:
self.dlg.path_output_network.setText(file_name)
def browse_output_polygon(self):
file_name = QFileDialog.getSaveFileName(self.dlg, "Save output file ",
"mca_catchment", '*.shp')
if file_name:
self.dlg.path_output_polygon.setText(file_name)
def analysis(self, mca):
self.dlg.progress_mca.reset()
# get network and origins
network_name = self.dlg.choose_network.currentText()
network_path = self.dlg.path_input_network.text()
network_cost = self.dlg.cost_column.text()
origins_name = self.dlg.choose_origins.currentText()
origins_path = self.dlg.path_input_origins.text()
origins_column = self.dlg.name_column.text()
output_network_path = self.dlg.path_output_network.text()
output_polygon_path = self.dlg.path_output_polygon.text()
# get active layers
active_layers = self.iface.legendInterface().layers()
active_layer_names = []
for layer in active_layers:
active_layer_names.append(layer.name())
# file check
if not network_path and not origins_path:
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"No network or origins selected!",
level=QgsMessageBar.WARNING,
duration=5)
elif not network_path:
self.iface.messageBar().pushMessage("Metric Catchment Analyser: ",
"No network selected!",
level=QgsMessageBar.WARNING,
duration=5)
elif not origins_path:
self.iface.messageBar().pushMessage("Metric Catchment Analyser: ",
"No origins selected!",
level=QgsMessageBar.WARNING,
duration=5)
else:
# loading network
if network_name in active_layer_names:
network = active_layers[active_layer_names.index(network_name)]
else:
network = QgsVectorLayer("%s" % (network_path), "", "ogr")
# loading origins
if origins_name in active_layer_names:
origins = active_layers[active_layer_names.index(origins_name)]
else:
origins = QgsVectorLayer("%s" % (origins_path), "", "ogr")
# loading settings
radius = self.dlg.radius.value()
network_tolerance = self.dlg.network_tolerance.value()
polygon_tolerance = self.dlg.polygon_tolerance.value()
crs = network.crs()
self.dlg.progress_mca.setValue(1)
# setting up the output network
output_network = QgsVectorLayer("linestring?crs=" + crs.toWkt(),
"mca_network", "memory")
# setup of output polygon
output_catchment = QgsVectorLayer("polygon?crs=" + crs.toWkt(),
"mca_catchment", "memory")
output_catchment.dataProvider().addAttributes(
[QgsField("origin", QVariant.String)])
output_catchment.updateFields()
self.dlg.progress_mca.setValue(2)
# build graph with custom cost
print origins_column
if network_cost:
graph, tied_points, origins_name = self.mca_tools.graph_builder(
network, origins, origins_column, network_tolerance, True,
network_cost)
# build graph without custom cost
else:
graph, tied_points, origins_name = self.mca_tools.graph_builder(
network, origins, origins_column, network_tolerance, False,
'')
self.dlg.progress_mca.setValue(3)
# run analysis with origin name
if origins_name:
self.mca_tools.mca(graph, tied_points, origins_name,
output_network, output_catchment,
polygon_tolerance, radius)
else:
self.mca_tools.mca(graph, tied_points, '', output_network,
output_catchment, polygon_tolerance, radius)
self.dlg.progress_mca.setValue(4)
# render network
if self.dlg.check_network.isChecked() == True:
# saving and rendering network in shapefile format
if self.dlg.path_output_network.text():
self.mca_tools.mca_vector_writer(output_network,
output_network_path, crs)
output_network = QgsVectorLayer(output_network_path,
'mca_network', 'ogr')
self.mca_tools.mca_network_renderer(output_network, radius)
# rendering the temporary network
else:
self.mca_tools.mca_network_renderer(output_network, radius)
# render catchments
if self.dlg.check_polygon.isChecked() == True:
# saving and rendering the catchment in shapefile format
if self.dlg.path_output_polygon.text():
self.mca_tools.mca_vector_writer(output_catchment,
output_polygon_path, crs)
output_polygon = QgsVectorLayer(output_polygon_path,
'mca_catchment', 'ogr')
self.mca_tools.mca_catchment_renderer(output_polygon)
# rendering the temporary catchment
else:
self.mca_tools.mca_catchment_renderer(output_catchment)
self.dlg.progress_mca.setValue(5)
def active_layers(self):
# list of active layers for the comboxes
self.dlg.choose_network.clear()
self.dlg.choose_origins.clear()
layers = self.iface.legendInterface().layers()
network_list = []
origins_list = []
for layer in layers:
if layer.type() == 0:
if (layer.wkbType() == 2 or layer.wkbType() == 5):
network_list.append(layer.name())
elif layer.wkbType() == 1:
origins_list.append(layer.name())
# adding layers to the comboboxes
if not len(network_list) == 0:
self.dlg.choose_network.addItems(network_list)
if not len(origins_list) == 0:
self.dlg.choose_origins.addItems(origins_list)
def refresh(self):
self.dlg.path_input_network.clear()
self.dlg.path_input_origins.clear()
self.active_layers()
self.dlg.path_output_network.setPlaceholderText(
"Save as temporary layer...")
self.dlg.path_output_polygon.setPlaceholderText(
"Save as temporary layer...")
self.dlg.progress_mca.reset()
def run(self):
if self.mca_tools.ex_dep_loaded == False:
self.iface.messageBar().pushMessage("Metric Catchment Analyser: ",
"Dependencies failed to load",
level=QgsMessageBar.CRITICAL,
duration=5)
self.active_layers()
# show the dialog
self.dlg.show()
def closeEvent(self, event):
self.refresh()
#self.dialogClosed.emit()
return self.dlg.close()
class MetricCatchmentAnalyser:
"""QGIS Plugin Implementation."""
def __init__(self, iface):
"""Constructor.
:param iface: An interface instance that will be passed to this class
which provides the hook by which you can manipulate the QGIS
application at run time.
:type iface: QgsInterface
"""
#self.dialogClosed = pyqtSignal()
# Save reference to the QGIS interface
self.iface = iface
# initialize plugin directory
self.plugin_dir = os.path.dirname(__file__)
# initialize locale
locale = QSettings().value('locale/userLocale')[0:2]
locale_path = os.path.join(
self.plugin_dir,
'i18n',
'MetricCatchmentAnalyser_{}.qm'.format(locale))
if os.path.exists(locale_path):
self.translator = QTranslator()
self.translator.load(locale_path)
if qVersion() > '4.3.3':
QCoreApplication.installTranslator(self.translator)
# Create the dialog (after translation) and keep reference
self.dlg = MetricCatchmentAnalyserDialog()
self.mca_tools = mca_tools
# Declare instance attributes
self.actions = []
self.menu = self.tr(u'&Metric Catchment Analyser')
# TODO: We are going to let the user set this up in a future iteration
self.toolbar = self.iface.addToolBar(u'MetricCatchmentAnalyser')
self.toolbar.setObjectName(u'MetricCatchmentAnalyser')
# Setup input network
self.dlg.path_input_network.clear()
self.dlg.browse_input_network.clicked.connect(self.browse_input_network)
self.dlg.choose_network.activated.connect(self.choose_network)
# Setup input origins
self.dlg.path_input_origins.clear()
self.dlg.browse_input_origins.clicked.connect(self.browse_input_origins)
self.dlg.choose_origins.activated.connect(self.choose_origins)
# Setup output network
self.dlg.browse_output_network.clicked.connect(self.browse_output_network)
self.dlg.path_output_network.setPlaceholderText("Save as temporary layer...")
# Setup output catchment
self.dlg.browse_output_polygon.clicked.connect(self.browse_output_polygon)
self.dlg.path_output_polygon.setPlaceholderText("Save as temporary layer...")
# Setup cost
self.dlg.check_cost.stateChanged.connect(self.browse_cost)
self.dlg.choose_cost.activated.connect(self.choose_cost)
# Setup names
self.dlg.check_name.stateChanged.connect(self.browse_name)
self.dlg.choose_name.activated.connect(self.choose_name)
# connect refresh button
self.dlg.refresh_mca.clicked.connect(self.refresh)
# connect the run button
self.dlg.run_mca.clicked.connect(self.analysis)
# connect the close button
self.dlg.close_mca.clicked.connect(self.closeEvent)
# setup the progress bar
self.dlg.progress_mca.setMinimum(0)
self.dlg.progress_mca.setMaximum(5)
# noinspection PyMethodMayBeStatic
def tr(self, message):
"""Get the translation for a string using Qt translation API.
We implement this ourselves since we do not inherit QObject.
:param message: String for translation.
:type message: str, QString
:returns: Translated version of message.
:rtype: QString
"""
# noinspection PyTypeChecker,PyArgumentList,PyCallByClass
return QCoreApplication.translate('MetricCatchmentAnalyser', message)
def add_action(
self,
icon_path,
text,
callback,
enabled_flag=True,
add_to_menu=True,
add_to_toolbar=True,
status_tip=None,
whats_this=None,
parent=None):
"""Add a toolbar icon to the toolbar.
:param icon_path: Path to the icon for this action. Can be a resource
path (e.g. ':/plugins/foo/bar.png') or a normal file system path.
:type icon_path: str
:param text: Text that should be shown in menu items for this action.
:type text: str
:param callback: Function to be called when the action is triggered.
:type callback: function
:param enabled_flag: A flag indicating if the action should be enabled
by default. Defaults to True.
:type enabled_flag: bool
:param add_to_menu: Flag indicating whether the action should also
be added to the menu. Defaults to True.
:type add_to_menu: bool
:param add_to_toolbar: Flag indicating whether the action should also
be added to the toolbar. Defaults to True.
:type add_to_toolbar: bool
:param status_tip: Optional text to show in a popup when mouse pointer
hovers over the action.
:type status_tip: str
:param parent: Parent widget for the new action. Defaults None.
:type parent: QWidget
:param whats_this: Optional text to show in the status bar when the
mouse pointer hovers over the action.
:returns: The action that was created. Note that the action is also
added to self.actions list.
:rtype: QAction
"""
icon = QIcon(icon_path)
action = QAction(icon, text, parent)
action.triggered.connect(callback)
action.setEnabled(enabled_flag)
if status_tip is not None:
action.setStatusTip(status_tip)
if whats_this is not None:
action.setWhatsThis(whats_this)
if add_to_toolbar:
self.toolbar.addAction(action)
if add_to_menu:
self.iface.addPluginToMenu(
self.menu,
action)
self.actions.append(action)
return action
def initGui(self):
"""Create the menu entries and toolbar icons inside the QGIS GUI."""
icon_path = ':/plugins/MetricCatchmentAnalyser/icon.png'
self.add_action(
icon_path,
text=self.tr(u'Metric Catchment Analyser'),
callback=self.run,
parent=self.iface.mainWindow())
def unload(self):
"""Removes the plugin menu item and icon from QGIS GUI."""
for action in self.actions:
self.iface.removePluginMenu(
self.tr(u'&Metric Catchment Analyser'),
action)
self.iface.removeToolBarIcon(action)
# remove the toolbar
del self.toolbar
def browse_input_network(self):
filename = QFileDialog.getOpenFileName(self.dlg, "Select input file ","", '*.shp')
if filename:
network = QgsVectorLayer(filename, 'input', 'ogr')
# Checking network layer
if not network.isValid():
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"Invalid network file!",
level=QgsMessageBar.WARNING,
duration=5)
elif not (network.wkbType() == 2 or network.wkbType() == 5):
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"This file does not contain lines!",
level=QgsMessageBar.WARNING,
duration=5)
else:
# Showing path/name of network
self.dlg.path_input_network.setText(filename)
# Activate custom cost option
self.browse_cost()
def choose_network(self):
layers = self.iface.legendInterface().layers()
layer_name = self.dlg.choose_network.currentText()
layer_index = self.dlg.choose_network.currentIndex()
network = layers[layer_index]
if not network.isValid():
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"Invalid network file!",
level=QgsMessageBar.WARNING,
duration=5)
else:
self.dlg.path_input_network.setText(layer_name)
# Activate custom cost option
self.browse_cost()
def browse_cost(self):
if self.dlg.check_cost.isChecked() == True:
# Activate and refresh combobox
self.dlg.choose_cost.setEnabled(True)
self.dlg.choose_cost.clear()
self.dlg.cost_column.setEnabled(True)
self.dlg.cost_column.clear()
# Get origins table
network_name = self.dlg.path_input_network.text()
# Get active layers
active_layers = self.iface.legendInterface().layers()
active_layer_names = [layer.name() for layer in active_layers]
# loading network
if network_name in active_layer_names:
network = active_layers[active_layer_names.index(network_name)]
else:
network = QgsVectorLayer("%s" % (network_name) , "", "ogr")
# Creating field list
network_fields = network.pendingFields()
network_field_names = [field.name() for field in network_fields]
# Adding layers to the comboboxes
self.dlg.choose_cost.addItems(network_field_names)
elif self.dlg.check_cost.isChecked() == False:
self.dlg.choose_cost.setEnabled(False)
self.dlg.choose_cost.clear()
self.dlg.cost_column.setEnabled(False)
self.dlg.cost_column.clear()
def choose_cost(self):
if self.dlg.path_input_network.text():
cost_name = self.dlg.choose_cost.currentText()
self.dlg.cost_column.setText(cost_name)
else:
self.dlg.choose_cost.clear()
self.dlg.cost_column.clear()
def choose_origins(self):
layers = self.iface.legendInterface().layers()
layer_name = self.dlg.choose_origins.currentText()
layer_index = self.dlg.choose_origins.currentIndex()
origins = layers[layer_index]
if not origins.isValid():
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"Invalid origin file!",
level=QgsMessageBar.WARNING,
duration=5)
else:
self.dlg.path_input_origins.setText(layer_name)
# Activate custom name option
self.browse_name()
def browse_input_origins(self):
filename = QFileDialog.getOpenFileName(self.dlg, "Select input file ","", '*.shp')
if filename:
origins = QgsVectorLayer(filename, 'input', 'ogr')
if not origins.isValid():
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"Invalid origin file!",
level=QgsMessageBar.WARNING,
duration=5)
elif not origins.wkbType() == 1:
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"This file does not contain points!",
level=QgsMessageBar.WARNING,
duration=5)
else:
self.dlg.path_input_origins.setText(filename)
# Activate custom name option
self.browse_name()
def browse_name(self):
# Activate custom names
if self.dlg.check_name.isChecked() == True:
# Activate and refresh combobox
self.dlg.choose_name.setEnabled(True)
self.dlg.choose_name.clear()
self.dlg.name_column.setEnabled(True)
self.dlg.name_column.clear()
# Get origins table
origins_name = self.dlg.path_input_origins.text()
# Get active layers
active_layers = self.iface.legendInterface().layers()
active_layer_names = [layer.name() for layer in active_layers]
# loading origins
if origins_name in active_layer_names:
origins = active_layers[active_layer_names.index(origins_name)]
else:
origins = QgsVectorLayer("%s" % (origins_name) , "", "ogr")
# Creating field list
origins_fields = origins.pendingFields()
origin_field_names = [field.name() for field in origins_fields]
# Adding layers to the comboboxes
self.dlg.choose_name.addItems(origin_field_names)
# Deactivate custom naqmes
elif self.dlg.check_name.isChecked() == False:
self.dlg.choose_name.setEnabled(False)
self.dlg.choose_name.clear()
self.dlg.name_column.setEnabled(False)
self.dlg.name_column.clear()
def choose_name(self):
if self.dlg.path_input_origins.text():
name_column = self.dlg.choose_name.currentText()
self.dlg.name_column.setText(name_column)
else:
self.dlg.choose_name.clear()
self.dlg.name_column.clear()
def browse_output_network(self):
file_name = QFileDialog.getSaveFileName(self.dlg, "Save output file ","mca_network", '*.shp')
if file_name:
self.dlg.path_output_network.setText(file_name)
def browse_output_polygon(self):
file_name = QFileDialog.getSaveFileName(self.dlg, "Save output file ","mca_catchment", '*.shp')
if file_name:
self.dlg.path_output_polygon.setText(file_name)
def analysis(self,mca):
self.dlg.progress_mca.reset()
# get network and origins
network_name = self.dlg.choose_network.currentText()
network_path = self.dlg.path_input_network.text()
network_cost = self.dlg.cost_column.text()
origins_name = self.dlg.choose_origins.currentText()
origins_path = self.dlg.path_input_origins.text()
origins_column = self.dlg.name_column.text()
output_network_path = self.dlg.path_output_network.text()
output_polygon_path = self.dlg.path_output_polygon.text()
# get active layers
active_layers = self.iface.legendInterface().layers()
active_layer_names = []
for layer in active_layers:
active_layer_names.append(layer.name())
# file check
if not network_path and not origins_path:
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"No network or origins selected!",
level=QgsMessageBar.WARNING,
duration=5)
elif not network_path:
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"No network selected!",
level=QgsMessageBar.WARNING,
duration=5)
elif not origins_path:
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"No origins selected!",
level=QgsMessageBar.WARNING,
duration=5)
else:
# loading network
if network_name in active_layer_names:
network = active_layers[active_layer_names.index(network_name)]
else:
network = QgsVectorLayer("%s" % (network_path) , "", "ogr")
# loading origins
if origins_name in active_layer_names:
origins = active_layers[active_layer_names.index(origins_name)]
else:
origins = QgsVectorLayer("%s" % (origins_path) , "", "ogr")
# loading settings
radius = self.dlg.radius.value()
network_tolerance = self.dlg.network_tolerance.value()
polygon_tolerance = self.dlg.polygon_tolerance.value()
crs = network.crs()
self.dlg.progress_mca.setValue(1)
# setting up the output network
output_network = QgsVectorLayer("linestring?crs="+ crs.toWkt(), "mca_network", "memory")
# setup of output polygon
output_catchment = QgsVectorLayer("polygon?crs="+ crs.toWkt(), "mca_catchment", "memory")
output_catchment.dataProvider().addAttributes([QgsField("origin", QVariant.String)])
output_catchment.updateFields()
self.dlg.progress_mca.setValue(2)
# build graph with custom cost
print origins_column
if network_cost:
graph, tied_points, origins_name= self.mca_tools.graph_builder(
network,
origins,
origins_column,
network_tolerance,
True,
network_cost)
# build graph without custom cost
else:
graph, tied_points, origins_name = self.mca_tools.graph_builder(
network,
origins,
origins_column,
network_tolerance,
False,
'')
self.dlg.progress_mca.setValue(3)
# run analysis with origin name
if origins_name:
self.mca_tools.mca(
graph,
tied_points,
origins_name,
output_network,
output_catchment,
polygon_tolerance,
radius)
else:
self.mca_tools.mca(
graph,
tied_points,
'',
output_network,
output_catchment,
polygon_tolerance,
radius)
self.dlg.progress_mca.setValue(4)
# render network
if self.dlg.check_network.isChecked() == True:
# saving and rendering network in shapefile format
if self.dlg.path_output_network.text():
self.mca_tools.mca_vector_writer(output_network, output_network_path,crs)
output_network = QgsVectorLayer(output_network_path, 'mca_network', 'ogr')
self.mca_tools.mca_network_renderer(output_network,radius)
# rendering the temporary network
else:
self.mca_tools.mca_network_renderer(output_network, radius)
# render catchments
if self.dlg.check_polygon.isChecked() == True:
# saving and rendering the catchment in shapefile format
if self.dlg.path_output_polygon.text():
self.mca_tools.mca_vector_writer(output_catchment, output_polygon_path,crs)
output_polygon = QgsVectorLayer(output_polygon_path, 'mca_catchment', 'ogr')
self.mca_tools.mca_catchment_renderer(output_polygon)
# rendering the temporary catchment
else:
self.mca_tools.mca_catchment_renderer(output_catchment)
self.dlg.progress_mca.setValue(5)
def active_layers(self):
# list of active layers for the comboxes
self.dlg.choose_network.clear()
self.dlg.choose_origins.clear()
layers = self.iface.legendInterface().layers()
network_list = []
origins_list = []
for layer in layers:
if layer.type() == 0:
if (layer.wkbType() == 2 or layer.wkbType() == 5):
network_list.append(layer.name())
elif layer.wkbType() == 1:
origins_list.append(layer.name())
# adding layers to the comboboxes
if not len(network_list) == 0:
self.dlg.choose_network.addItems(network_list)
if not len(origins_list) == 0:
self.dlg.choose_origins.addItems(origins_list)
def refresh(self):
self.dlg.path_input_network.clear()
self.dlg.path_input_origins.clear()
self.active_layers()
self.dlg.path_output_network.setPlaceholderText("Save as temporary layer...")
self.dlg.path_output_polygon.setPlaceholderText("Save as temporary layer...")
self.dlg.progress_mca.reset()
def run(self):
if self.mca_tools.ex_dep_loaded == False:
self.iface.messageBar().pushMessage(
"Metric Catchment Analyser: ",
"Dependencies failed to load",
level=QgsMessageBar.CRITICAL,
duration=5)
self.active_layers()
# show the dialog
self.dlg.show()
def closeEvent(self,event):
self.refresh()
#self.dialogClosed.emit()
return self.dlg.close()