autobk.py 10.7 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
import est.core.process.larch.autobk
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
45
46
47
48
49
50
from est.gui.XasObjectViewer import (
    _plot_bkg,
    _plot_spectrum,
    _plot_knots,
    _plot_chi,
)
payno's avatar
payno committed
51
52
53
54
from est.gui.larch.autobk import _AutobkParameters
from orangecontrib.est.progress import QProgress
from orangecontrib.est.utils import Converter
from orangecontrib.est.widgets.container import _ParameterWindowContainer
55
from ewokscore.registration import Registered
56
57
58

_logger = logging.getLogger(__file__)

59
_USE_THREAD = False
60

61
62
63
64
65
66

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

        # xas object viewer
payno's avatar
payno committed
67
        mapKeys = ["mu", "bkg", "chie", "k", "chi", "e0"]
68
69
70
        self.xasObjViewer = XasObjectViewer(
            mapKeys=mapKeys, spectrumPlots=("background", "chi(k)")
        )
payno's avatar
payno committed
71
72
73
        self.xasObjViewer._spectrumViews[0]._plotWidget.getXAxis().setLabel(
            "Energy (eV)"
        )
74
        self.xasObjViewer._spectrumViews[0]._plotWidget.getYAxis().setLabel(
payno's avatar
payno committed
75
76
            "Absorption (a.u.)"
        )
77
        self.setCentralWidget(self.xasObjViewer)
payno's avatar
payno committed
78
79
80
        self._parametersWindow = _ParameterWindowContainer(
            parent=self, parametersWindow=_AutobkParameters
        )
81
82
83
84
85
86
87
88
        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)

89
90
        # bkg legend selector
        self.bkgLegendDockWidget = LegendSelector.LegendsDockWidget(
91
            parent=self, plot=self.xasObjViewer._spectrumViews[0]._plotWidget
payno's avatar
payno committed
92
        )
93
94
95
96
97
98
99
100
101
102
103
        self.bkgLegendDockWidget.setAllowedAreas(
            qt.Qt.RightDockWidgetArea | qt.Qt.LeftDockWidgetArea
        )
        self.bkgLegendDockWidget.setFeatures(qt.QDockWidget.NoDockWidgetFeatures)
        self.addDockWidget(qt.Qt.RightDockWidgetArea, self.bkgLegendDockWidget)

        # chi legend selector
        self._chiLegendDockWidget = LegendSelector.LegendsDockWidget(
            parent=self, plot=self.xasObjViewer._spectrumViews[1]._plotWidget
        )
        self._chiLegendDockWidget.setAllowedAreas(
payno's avatar
payno committed
104
105
            qt.Qt.RightDockWidgetArea | qt.Qt.LeftDockWidgetArea
        )
106
107
        self._chiLegendDockWidget.setFeatures(qt.QDockWidget.NoDockWidgetFeatures)
        self.addDockWidget(qt.Qt.RightDockWidgetArea, self._chiLegendDockWidget)
108
109

        # volume key selection
payno's avatar
payno committed
110
111
112
        self.addDockWidget(
            qt.Qt.RightDockWidgetArea, self.xasObjViewer._mapView.keySelectionDocker
        )
113
114

        # plot settings
115
        for ope in (_plot_bkg, _plot_spectrum, _plot_knots):
116
117
            self.xasObjViewer._spectrumViews[0].addCurveOperation(ope)

118
119
        self.xasObjViewer._spectrumViews[1].addCurveOperation(_plot_chi)

120
121
122
123
124
125
126
127
128
        self.setWindowFlags(qt.Qt.Widget)

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

        # set up
        self._updateLegendView()

    def getNCurves(self):
129
        return len(self.xasObjViewer._spectrumViews[0]._plotWidget.getAllCurves())
130
131
132

    def _updateLegendView(self):
        index, viewType = self.xasObjViewer.getViewType()
133
134
135
136
137
138
        self.bkgLegendDockWidget.setVisible(
            viewType is ViewType.spectrum and index == 0
        )
        self._chiLegendDockWidget.setVisible(
            viewType is ViewType.spectrum and index == 1
        )
payno's avatar
payno committed
139
140
141
        self.xasObjViewer._mapView.keySelectionDocker.setVisible(
            viewType is ViewType.map
        )
142
143


144
class AutobkOW(_ProcessForOrangeMixIn, OWWidget, Registered):
145
146
147
    """
    Widget used for signal extraction
    """
payno's avatar
payno committed
148

149
    name = "autobk"
payno's avatar
payno committed
150
    id = "orange.widgets.est.larch.autobk"
151
152
153
154
    description = "background removal"
    icon = "icons/autobk.png"
    priority = 1
    category = "esrfWidgets"
payno's avatar
payno committed
155
    keywords = ["spectroscopy", "autobk", "background"]
156
157
158

    want_main_area = True
    resizing_enabled = True
159
    allows_cycle = False
160

161
    _larchSettings = Setting(dict())
162
163
    """Store the configuration of the PyMca XASClass"""

164
165
    ewokstaskclass = est.core.process.larch.autobk.Larch_autobk

166
    class Inputs:
payno's avatar
payno committed
167
        xas_obj = Input("xas_obj", XASObject, default=True)
168
169
        # simple compatibility for some Orange widget and especialy the
        # 'spectroscopy add-on'
payno's avatar
payno committed
170
        data_table = Input("Data", Orange.data.Table)
171
172

    class Outputs:
173
        xas_obj = Output("xas_obj", XASObject)
174
175
176
        # by default we want to avoid sending 'Orange.data.Table' to avoid
        # loosing the XASObject flow process and results.

177
178
179
180
    def __init__(self):
        super().__init__()
        self._latest_xas_obj = None
        self._window = AutobkWindow(parent=self)
payno's avatar
payno committed
181
        layout = gui.vBox(self.mainArea, "autobk").layout()
182
        layout.addWidget(self._window)
payno's avatar
payno committed
183
        self._window.xasObjViewer.setWindowTitle("spectra")
184
185

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

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

192
193
        # required to display advancement
        if _USE_THREAD is False:
payno's avatar
payno committed
194
            self._advancement = QProgress("autobk")
195
196
            self._advancement.sigProgress.connect(self._setProgressValue)

197
        # set up (insure settings will be store
198
        self._update_settings()
199

200
        # self.handleNewSignals()
201

202
    def _updateProcess(self):
203
        """Update settings keeping current xas obj"""
204
205
206
207
208
        self._update_settings()
        if self._latest_xas_obj:
            self.process(self._latest_xas_obj)

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

211
212
213
214
215
216
217
    @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
218
219
220
221
222
    def process(self, xas_obj):
        if xas_obj is None:
            return

        if not self._canProcess():
payno's avatar
payno committed
223
224
225
226
            _logger.warning(
                "There is some processing on going already, will"
                "not process the new dataset"
            )
227

228
        self._latest_xas_obj = xas_obj
229
230
231
        self._startProcess()

        # setup the normalization process
232
        inputs = {"xas_obj": xas_obj}
233
234
235
        if _USE_THREAD is True:
            # note: for now with larch with cannot do thread computation (see
            # PreEdgeOW )
236
            process_obj = QLarch_autobk(inputs=inputs)
237
            process_obj._advancement.sigProgress.connect(self._setProgressValue)
238
            process_obj.set_properties(
payno's avatar
payno committed
239
240
                {"_larchSettings": self._window._parametersWindow.getParameters()}
            )
241
242
243
244

            # update the processing thread
            thread = self.getProcessingThread()
            thread.init(process_obj=process_obj, xas_obj=self._latest_xas_obj)
payno's avatar
payno committed
245
246
247
            self._callback_finish = functools.partial(
                self._endProcess, self._latest_xas_obj
            )
248
249
250
            thread.finished.connect(self._callback_finish)
            # start processing
            thread.start(priority=qt.QThread.LowPriority)
251
252
253
254
        else:
            # manage advancement
            self._advancement.setAdvancement(0)
            self._advancement.setMaxSpectrum(self._latest_xas_obj.n_spectrum)
255
            process_obj = est.core.process.larch.autobk.Larch_autobk(inputs=inputs)
256
            process_obj.advancement = self._advancement
257
            process_obj.set_properties(
payno's avatar
payno committed
258
259
                {"_larchSettings": self._window._parametersWindow.getParameters()}
            )
260
261
262
263
            # 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)
264
            process_obj.run()
265
266
            self._callback_finish = None
            self._endProcess(self._latest_xas_obj)
267
268


payno's avatar
payno committed
269
class QLarch_autobk(est.core.process.larch.autobk.Larch_autobk):
270
271
272
273
    """
    Normalization able to give advancement using qt.Signal and QThreadPool
    """

274
275
    def __init__(self, *args, **kwargs):
        est.core.process.larch.autobk.Larch_autobk.__init__(self, *args, **kwargs)
payno's avatar
payno committed
276
        self._advancement = QProgress("autobk")
277
278
279
280
281

    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
282
283
284
285
286
287
            runnable = ProcessRunnable(
                fct=est.core.process.larch.autobk.process_spectr_autobk,
                spectrum=spectrum,
                configuration=xas_obj.configuration,
                callback=self._advancement.increaseAdvancement,
            )
288
289
            self.pool.start(runnable)
        self.pool.waitForDone()