mback.py 9.76 KB
Newer Older
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
# coding: utf-8
# /*##########################################################################
#
# Copyright (c) 2016-2017 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/

__authors__ = ["H. Payno"]
__license__ = "MIT"
__date__ = "06/07/2019"


import functools
import logging
from Orange.widgets import gui
from Orange.widgets.settings import Setting
35
from Orange.widgets.widget import OWWidget
36
37
from Orange.widgets.widget import Input, Output
import Orange.data
38
39
from silx.gui import qt
from silx.gui.plot import LegendSelector
payno's avatar
payno committed
40
41
42
43
44
45
46
47
48
49
import est.core.process.larch.mback
from orangecontrib.est.process import _ProcessForOrangeMixIn
from orangecontrib.est.process import ProcessRunnable
from est.core.types import XASObject
from est.gui.XasObjectViewer import XasObjectViewer, ViewType
from est.gui.larch.mback import _MBackParameters
from orangecontrib.est.progress import QProgress
from est.gui.XasObjectViewer import _plot_norm, _plot_raw, _plot_fpp, _plot_f2
from orangecontrib.est.utils import Converter
from orangecontrib.est.widgets.container import _ParameterWindowContainer
50
from ewokscore.registration import Registered
51
52
53

_logger = logging.getLogger(__file__)

54
_USE_THREAD = False
55

56
57
58
59
60
61

class MbackWindow(qt.QMainWindow):
    def __init__(self, parent=None):
        qt.QMainWindow.__init__(self, parent)

        # xas object viewer
payno's avatar
payno committed
62
        mapKeys = ["mu", "fpp", "f2"]
63
        self.xasObjViewer = XasObjectViewer(mapKeys=mapKeys)
payno's avatar
payno committed
64
65
66
        self.xasObjViewer._spectrumViews[0]._plotWidget.getXAxis().setLabel(
            "Energy (eV)"
        )
67
        self.setCentralWidget(self.xasObjViewer)
payno's avatar
payno committed
68
69
70
        self._parametersWindow = _ParameterWindowContainer(
            parent=self, parametersWindow=_MBackParameters
        )
71
72
73
74
75
76
77
78
79
        dockWidget = qt.QDockWidget(parent=self)

        # parameters window
        dockWidget.setWidget(self._parametersWindow)
        self.addDockWidget(qt.Qt.RightDockWidgetArea, dockWidget)
        dockWidget.setAllowedAreas(qt.Qt.RightDockWidgetArea | qt.Qt.LeftDockWidgetArea)
        dockWidget.setFeatures(qt.QDockWidget.NoDockWidgetFeatures)

        # legend selector
payno's avatar
payno committed
80
        self.legendDockWidget = LegendSelector.LegendsDockWidget(
81
            parent=self, plot=self.xasObjViewer._spectrumViews[0]._plotWidget
payno's avatar
payno committed
82
83
84
85
        )
        self.legendDockWidget.setAllowedAreas(
            qt.Qt.RightDockWidgetArea | qt.Qt.LeftDockWidgetArea
        )
86
87
88
89
        self.legendDockWidget.setFeatures(qt.QDockWidget.NoDockWidgetFeatures)
        self.addDockWidget(qt.Qt.RightDockWidgetArea, self.legendDockWidget)

        # volume key selection
payno's avatar
payno committed
90
91
92
        self.addDockWidget(
            qt.Qt.RightDockWidgetArea, self.xasObjViewer._mapView.keySelectionDocker
        )
93
94

        # plot settings
95
        for ope in (_plot_fpp, _plot_f2, _plot_raw, _plot_norm):
96
97
98
99
100
101
102
103
104
105
106
107
108
            self.xasObjViewer._spectrumViews[0].addCurveOperation(ope)

        self.setWindowFlags(qt.Qt.Widget)

        # connect signal / slot
        self.xasObjViewer.viewTypeChanged.connect(self._updateLegendView)

        # set up
        self._updateLegendView()

    def _updateLegendView(self):
        index, viewType = self.xasObjViewer.getViewType()
        self.legendDockWidget.setVisible(viewType is ViewType.spectrum)
payno's avatar
payno committed
109
110
111
        self.xasObjViewer._mapView.keySelectionDocker.setVisible(
            viewType is ViewType.map
        )
112

113
    def getNCurves(self):
114
        return len(self.xasObjViewer._spectrumViews[0]._plotWidget.getAllCurves())
115

116

117
class MbackOW(_ProcessForOrangeMixIn, OWWidget, Registered):
118
119
120
    """
    Widget used for signal extraction
    """
payno's avatar
payno committed
121

122
    name = "mback"
payno's avatar
payno committed
123
    id = "orange.widgets.est.larch.mback.MbackOW"
payno's avatar
payno committed
124
125
126
127
    description = (
        "Match mu(E) data for tabulated f''(E) using the MBACK "
        "algorithm and, optionally, the Lee & Xiang extension"
    )
128
    icon = "icons/mback.svg"
129
130
    priority = 5
    category = "esrfWidgets"
131
    keywords = ["spectroscopy", "mback"]
132
133
134

    want_main_area = True
    resizing_enabled = True
135
    allows_cycle = False
136
137
138
139

    _larchSettings = Setting(dict())
    """Store the configuration of the larch configuration"""

140
141
    ewokstaskclass = est.core.process.larch.mback.Larch_mback

142
    class Inputs:
payno's avatar
payno committed
143
        xas_obj = Input("xas_obj", XASObject, default=True)
144
145
        # simple compatibility for some Orange widget and especialy the
        # 'spectroscopy add-on'
payno's avatar
payno committed
146
        data_table = Input("Data", Orange.data.Table)
147
148

    class Outputs:
149
        xas_obj = Output("xas_obj", XASObject)
150
151
152
        # by default we want to avoid sending 'Orange.data.Table' to avoid
        # loosing the XASObject flow process and results.

153
154
155
156
    def __init__(self):
        super().__init__()
        self._latest_xas_obj = None
        self._window = MbackWindow(parent=self)
payno's avatar
payno committed
157
        layout = gui.vBox(self.mainArea, "mback").layout()
158
        layout.addWidget(self._window)
payno's avatar
payno committed
159
        self._window.xasObjViewer.setWindowTitle("spectra")
160
161
162
163
164
165
166
167

        # manage settings
        if self._larchSettings != dict():
            self._window._parametersWindow.setParameters(self._larchSettings)

        # connect signals / slots
        self._window._parametersWindow.sigChanged.connect(self._updateProcess)

168
169
        # required to display advancement
        if _USE_THREAD is False:
payno's avatar
payno committed
170
            self._advancement = QProgress("mback")
171
172
            self._advancement.sigProgress.connect(self._setProgressValue)

173
        # set up (insure settings will be store
174
        self._update_settings()
175
        # self.handleNewSignals()
176

177
178
179
180
181
182
183
184
    def _updateProcess(self):
        self._update_settings()
        if self._latest_xas_obj:
            self.process(self._latest_xas_obj)

    def _update_settings(self):
        self._larchSettings = self._window._parametersWindow.getParameters()

185
186
187
188
189
190
191
    @Inputs.data_table
    def processFrmDataTable(self, data_table):
        if data_table is None:
            return
        self.process(Converter.toXASObject(data_table=data_table))

    @Inputs.xas_obj
192
193
194
195
196
    def process(self, xas_obj):
        if xas_obj is None:
            return

        if not self._canProcess():
payno's avatar
payno committed
197
198
199
200
            _logger.warning(
                "There is some processing on going already, will"
                "not process the new dataset"
            )
201

202
        self._latest_xas_obj = xas_obj
203
204
205
        self._startProcess()

        # setup the normalization process
206
        inputs = {"xas_obj": xas_obj}
207
208
209
        if _USE_THREAD is True:
            # note: for now with larch with cannot do thread computation (see
            # PreEdgeOW )
210
            process_obj = QLarch_mback(inputs=inputs)
211
            process_obj._advancement.sigProgress.connect(self._setProgressValue)
212
            process_obj.set_properties(
payno's avatar
payno committed
213
214
                {"_larchSettings": self._window._parametersWindow.getParameters()}
            )
215
216
217
            # update the processing thread
            thread = self.getProcessingThread()
            thread.init(process_obj=process_obj, xas_obj=self._latest_xas_obj)
payno's avatar
payno committed
218
219
220
            self._callback_finish = functools.partial(
                self._endProcess, self._latest_xas_obj
            )
221
222
223
            thread.finished.connect(self._callback_finish)
            # start processing
            thread.start(priority=qt.QThread.LowPriority)
224
225
226
227
        else:
            # manage advancement
            self._advancement.setAdvancement(0)
            self._advancement.setMaxSpectrum(self._latest_xas_obj.n_spectrum)
228
            process_obj = est.core.process.larch.mback.Larch_mback(inputs=inputs)
229
            process_obj.advancement = self._advancement
230
            process_obj.set_properties(
payno's avatar
payno committed
231
232
                {"_larchSettings": self._window._parametersWindow.getParameters()}
            )
233
234
235
236
            # hack (reason explained in the thread part)
            # to avoid gui freeze, processevents after each spectrum process
            process_obj.addCallback(qt.QApplication.instance().processEvents)
            process_obj.addCallback(self._advancement.increaseAdvancement)
237
            process_obj.run()
238
239
            self._callback_finish = None
            self._endProcess(self._latest_xas_obj)
240
241


payno's avatar
payno committed
242
class QLarch_mback(est.core.process.larch.mback.Larch_mback):
243
244
245
246
    """
    Normalization able to give advancement using qt.Signal and QThreadPool
    """

247
248
    def __init__(self, *args, **kwargs):
        est.core.process.larch.mback.Larch_mback.__init__(self, *args, **kwargs)
payno's avatar
payno committed
249
        self._advancement = QProgress("mback")
250
251
252
253
254

    def _pool_process(self, xas_obj):
        self.pool = qt.QThreadPool()
        self.pool.setMaxThreadCount(5)
        for spectrum in xas_obj.spectra:
payno's avatar
payno committed
255
256
257
258
259
260
            runnable = ProcessRunnable(
                fct=est.core.process.larch.mback.process_spectr_mback,
                spectrum=spectrum,
                configuration=xas_obj.configuration,
                callback=self._advancement.increaseAdvancement,
            )
261
262
            self.pool.start(runnable)
        self.pool.waitForDone()