forked from gioman/gioman_processing_circuitscape
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcircuitscapeProvider.py
More file actions
157 lines (127 loc) · 6.81 KB
/
circuitscapeProvider.py
File metadata and controls
157 lines (127 loc) · 6.81 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
# -*- coding: utf-8 -*-
"""
***************************************************************************
CircuitscapeProvider.py
---------------------
Date : May 2014
Copyright : (C) 2014-2018 by Alexander Bruy
Email : alexander dot bruy at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************
"""
__author__ = 'Alexander Bruy'
__date__ = 'May 2014'
__copyright__ = '(C) 2014-2018, Alexander Bruy'
# This will get replaced with a git SHA1 when you do a git archive
__revision__ = '$Format:%H$'
import os
from qgis.PyQt.QtGui import QIcon
from qgis.PyQt.QtCore import QCoreApplication
from qgis.core import QgsProcessingProvider
from processing.core.ProcessingConfig import ProcessingConfig, Setting
from processing.tools.system import isWindows
from processing_circuitscape.pairwise import Pairwise
from processing_circuitscape.oneToAll import OneToAll
from processing_circuitscape.advanced import Advanced
from processing_circuitscape import circuitscapeUtils
pluginPath = os.path.dirname(__file__)
class CircuitscapeProvider(QgsProcessingProvider):
def __init__(self):
super().__init__()
self.algs = []
def id(self):
return "circuitscape"
def name(self):
return "Circuitscape"
def icon(self):
return QIcon(os.path.join(pluginPath, "icons", "circuitscape.png"))
def load(self):
ProcessingConfig.settingIcons[self.name()] = self.icon()
ProcessingConfig.addSetting(Setting(self.name(),
circuitscapeUtils.CIRCUITSCAPE_ACTIVE,
self.tr("Activate"),
False))
if isWindows():
ProcessingConfig.addSetting(Setting(self.name(),
circuitscapeUtils.CIRCUITSCAPE_DIRECTORY,
self.tr("Circuitscape directory"),
circuitscapeUtils.circuitscapeDirectory(),
valuetype=Setting.FOLDER))
ProcessingConfig.addSetting(Setting(self.name(),
circuitscapeUtils.CIRCUITSCAPE_VERBOSE,
self.tr("Log commands output"),
False))
ProcessingConfig.addSetting(Setting(self.name(),
circuitscapeUtils.FOUR_NEIGHBOURS,
self.tr("Connect raster cells to 4 neighbors instead of 8"),
False))
ProcessingConfig.addSetting(Setting(self.name(),
circuitscapeUtils.AVERAGE_CONDUCTANCE,
self.tr("Use average conductance instead of resistance for connections between cells"),
False))
ProcessingConfig.addSetting(Setting(self.name(),
circuitscapeUtils.PREEMPT_MEMORY,
self.tr("Preemptively release memory when possible"),
False))
ProcessingConfig.addSetting(Setting(self.name(),
circuitscapeUtils.MAX_CURRENT_MAPS,
self.tr("Write maximum of current maps"),
False))
ProcessingConfig.addSetting(Setting(self.name(),
circuitscapeUtils.CUM_MAX_MAPS,
self.tr("Write cumulative & maximum current maps only"),
False))
ProcessingConfig.addSetting(Setting(self.name(),
circuitscapeUtils.ZERO_FOCAL,
self.tr("Set focal nodes currents to zero"),
False))
ProcessingConfig.addSetting(Setting(self.name(),
circuitscapeUtils.LOG_TRANSFORM,
self.tr("Log-transform current maps"),
False))
ProcessingConfig.addSetting(Setting(self.name(),
circuitscapeUtils.COMPRESS_OUTPUT,
self.tr("Compress output grids"),
False))
ProcessingConfig.readSettings()
self.refreshAlgorithms()
return True
def unload(self):
ProcessingConfig.removeSetting(circuitscapeUtils.CIRCUITSCAPE_ACTIVE)
if isWindows():
ProcessingConfig.removeSetting(circuitscapeUtils.CIRCUITSCAPE_DIRECTORY)
ProcessingConfig.removeSetting(circuitscapeUtils.CIRCUITSCAPE_VERBOSE)
ProcessingConfig.removeSetting(circuitscapeUtils.FOUR_NEIGHBOURS)
ProcessingConfig.removeSetting(circuitscapeUtils.AVERAGE_CONDUCTANCE)
ProcessingConfig.removeSetting(circuitscapeUtils.PREEMPT_MEMORY)
ProcessingConfig.removeSetting(circuitscapeUtils.MAX_CURRENT_MAPS)
ProcessingConfig.removeSetting(circuitscapeUtils.CUM_MAX_MAPS)
ProcessingConfig.removeSetting(circuitscapeUtils.ZERO_FOCAL)
ProcessingConfig.removeSetting(circuitscapeUtils.LOG_TRANSFORM)
ProcessingConfig.removeSetting(circuitscapeUtils.COMPRESS_OUTPUT)
def isActive(self):
return ProcessingConfig.getSetting(circuitscapeUtils.CIRCUITSCAPE_ACTIVE)
def setActive(self, active):
ProcessingConfig.setSettingValue(circuitscapeUtils.CIRCUITSCAPE_ACTIVE, active)
def supportsNonFileBasedOutput(self):
return False
def getAlgs(self):
algs = [Pairwise(),
OneToAll(),
Advanced()
]
return algs
def loadAlgorithms(self):
self.algs = self.getAlgs()
for a in self.algs:
self.addAlgorithm(a)
def tr(self, string, context=''):
if context == "":
context = "CircuitscapeProvider"
return QCoreApplication.translate(context, string)