mback_norm.py 9.83 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_norm
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.XasObjectViewer import _plot_norm, _plot_mback_mu
from est.gui.larch.mback import _MBackParameters
from orangecontrib.est.progress import QProgress
from orangecontrib.est.utils import Converter
from orangecontrib.est.widgets.container import _ParameterWindowContainer
50
51
52

_logger = logging.getLogger(__file__)

53
_USE_THREAD = False
54

55
56
57
58
59
60

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

        # xas object viewer
payno's avatar
payno committed
61
        mapKeys = ["mu", "mback_mu", "norm"]
62
        self.xasObjViewer = XasObjectViewer(mapKeys=mapKeys)
payno's avatar
payno committed
63
        self.xasObjViewer._spectrumViews[0]._plotWidget.getXAxis().setLabel(
payno's avatar
payno committed
64
65
            "Energy (eV)"
        )
66
        self.setCentralWidget(self.xasObjViewer)
payno's avatar
payno committed
67
68
69
        self._parametersWindow = _ParameterWindowContainer(
            parent=self, parametersWindow=_MBackParameters
        )
70
71
72
73
74
75
76
77
78
        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
79
        self.legendDockWidget = LegendSelector.LegendsDockWidget(
80
            parent=self, plot=self.xasObjViewer._spectrumViews[0]._plotWidget
payno's avatar
payno committed
81
82
83
84
        )
        self.legendDockWidget.setAllowedAreas(
            qt.Qt.RightDockWidgetArea | qt.Qt.LeftDockWidgetArea
        )
85
86
87
88
        self.legendDockWidget.setFeatures(qt.QDockWidget.NoDockWidgetFeatures)
        self.addDockWidget(qt.Qt.RightDockWidgetArea, self.legendDockWidget)

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

        # plot settings
94
        for ope in (_plot_mback_mu, _plot_norm):
95
96
97
98
99
100
101
102
103
104
105
106
107
            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
108
109
110
        self.xasObjViewer._mapView.keySelectionDocker.setVisible(
            viewType is ViewType.map
        )
111

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

115

116
117
class Mback_normOW(
    _ProcessForOrangeMixIn,
118
    OWWidget,
119
):
120
121
122
    """
    Widget used for signal extraction
    """
payno's avatar
payno committed
123

124
    name = "mback norm"
payno's avatar
payno committed
125
    id = "orange.widgets.est.larch.mback.Mback_normOW"
payno's avatar
payno committed
126
127
128
129
    description = (
        "simplified version of MBACK to Match mu(E) data for "
        "tabulated f''(E) for normalization"
    )
130
    icon = "icons/mbacknorm.svg"
131
132
133
134
135
136
    priority = 6
    category = "esrfWidgets"
    keywords = ["spectroscopy", "mback_norm"]

    want_main_area = True
    resizing_enabled = True
137
    allows_cycle = False
138
    ewokstaskclass = est.core.process.larch.mback_norm.Larch_mback_norm
139
140
141
142

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

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

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

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

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

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

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

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

178
179
180
181
182
183
184
185
    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()

186
187
188
189
190
191
192
    @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
193
194
195
196
197
    def process(self, xas_obj):
        if xas_obj is None:
            return

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

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

        # setup the normalization process
207
        inputs = {"xas_obj": xas_obj}
208
209
210
        if _USE_THREAD is True:
            # note: for now with larch with cannot do thread computation (see
            # PreEdgeOW )
211
            process_obj = QLarch_mback_norm(inputs=inputs)
212
            process_obj._advancement.sigProgress.connect(self._setProgressValue)
213
            process_obj.set_properties(
payno's avatar
payno committed
214
215
                {"_larchSettings": self._window._parametersWindow.getParameters()}
            )
216
217
218
            # update the processing thread
            thread = self.getProcessingThread()
            thread.init(process_obj=process_obj, xas_obj=self._latest_xas_obj)
payno's avatar
payno committed
219
220
221
            self._callback_finish = functools.partial(
                self._endProcess, self._latest_xas_obj
            )
222
223
224
            thread.finished.connect(self._callback_finish)
            # start processing
            thread.start(priority=qt.QThread.LowPriority)
225
226
227
228
        else:
            # manage advancement
            self._advancement.setAdvancement(0)
            self._advancement.setMaxSpectrum(self._latest_xas_obj.n_spectrum)
229
230
231
            process_obj = est.core.process.larch.mback_norm.Larch_mback_norm(
                inputs=inputs
            )
232
            process_obj.advancement = self._advancement
233
            process_obj.set_properties(
payno's avatar
payno committed
234
235
                {"_larchSettings": self._window._parametersWindow.getParameters()}
            )
236
237
238
239
            # 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)
240
            process_obj.run()
241
242
            self._callback_finish = None
            self._endProcess(self._latest_xas_obj)
243
244


payno's avatar
payno committed
245
class QLarch_mback_norm(est.core.process.larch.mback_norm.Larch_mback_norm):
246
247
248
249
    """
    Normalization able to give advancement using qt.Signal and QThreadPool
    """

250
251
252
253
    def __init__(self, *args, **kwargs):
        est.core.process.larch.mback_norm.Larch_mback_norm.__init__(
            self, *args, **kwargs
        )
payno's avatar
payno committed
254
        self._advancement = QProgress("mback_norm")
255
256
257
258
259

    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
260
261
262
263
264
265
            runnable = ProcessRunnable(
                fct=est.core.process.larch.mback_norm.process_spectr_mback_norm,
                spectrum=spectrum,
                configuration=xas_obj.configuration,
                callback=self._advancement.increaseAdvancement,
            )
266
267
            self.pool.start(runnable)
        self.pool.waitForDone()