autobk.py 10.6 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
56
57

_logger = logging.getLogger(__file__)

58
_USE_THREAD = False
59

60
61
62
63
64
65

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

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

88
89
        # bkg legend selector
        self.bkgLegendDockWidget = LegendSelector.LegendsDockWidget(
90
            parent=self, plot=self.xasObjViewer._spectrumViews[0]._plotWidget
payno's avatar
payno committed
91
        )
92
93
94
95
96
97
98
99
100
101
102
        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
103
104
            qt.Qt.RightDockWidgetArea | qt.Qt.LeftDockWidgetArea
        )
105
106
        self._chiLegendDockWidget.setFeatures(qt.QDockWidget.NoDockWidgetFeatures)
        self.addDockWidget(qt.Qt.RightDockWidgetArea, self._chiLegendDockWidget)
107
108

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

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

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

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

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

        # set up
        self._updateLegendView()

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

    def _updateLegendView(self):
        index, viewType = self.xasObjViewer.getViewType()
132
133
134
135
136
137
        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
138
139
140
        self.xasObjViewer._mapView.keySelectionDocker.setVisible(
            viewType is ViewType.map
        )
141
142


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

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

    want_main_area = True
    resizing_enabled = True
158
    allows_cycle = False
159

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

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

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

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

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

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

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

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

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

199
        # self.handleNewSignals()
200

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

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

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

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

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

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

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


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

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

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