normalization.py 7.72 KB
Newer Older
payno's avatar
payno committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# 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.
#
# ###########################################################################*/
25
"""wrapper to pymca `normalization` process"""
payno's avatar
payno committed
26
27
28
29
30
31

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


32
import functools
payno's avatar
payno committed
33
import logging
34
35
import multiprocessing
from PyMca5.PyMcaPhysics.xas.XASClass import XASClass
Wout De Nolf's avatar
flake8    
Wout De Nolf committed
36
from est.core.process.process import Process
37
from est.core.process.process import _NexusDatasetDef
payno's avatar
payno committed
38
from est.core.types import Spectrum, XASObject
39

payno's avatar
payno committed
40
41
42
_logger = logging.getLogger(__name__)


payno's avatar
payno committed
43
def process_spectr_norm(
payno's avatar
payno committed
44
    spectrum: Spectrum,
payno's avatar
payno committed
45
46
47
48
49
50
    configuration,
    overwrite=True,
    callbacks=None,
    output=None,
    output_dict=None,
):
51
52
    """

53
54
55
56
57
58
    :param spectrum: spectrum to process
    :type: :class:`.Spectrum`
    :param configuration: configuration of the pymca normalization
    :type: dict
    :param overwrite: False if we want to return a new Spectrum instance
    :type: bool
59
    :param callbacks: callback to execute.
60
61
    :param output: list to store the result, needed for pool processing
    :type: multiprocessing.manager.list
62
63
64
    :param output_dict: key is input spectrum, value is index in the output
                        list.
    :type: dict
65
    :return: processed spectrum
66
67
    :rtype: tuple (configuration, spectrum)
    """
payno's avatar
payno committed
68
    assert isinstance(spectrum, Spectrum)
payno's avatar
payno committed
69
    _logger.debug("start normalization on spectrum (%s, %s)" % (spectrum.x, spectrum.y))
70
    if spectrum.energy is None or spectrum.mu is None:
payno's avatar
payno committed
71
72
73
        _logger.error(
            "Energy and or Mu is/are not specified, unable to " "compute exafs"
        )
74
        return None, None
75
    pymca_xas = XASClass()
payno's avatar
payno committed
76
    pymca_xas.setSpectrum(energy=spectrum.energy, mu=spectrum.mu)
77
    if configuration is not None:
payno's avatar
payno committed
78
79
80
        if "e0" in configuration:
            configuration["E0Value"] = configuration["e0"]
            configuration["E0Method"] = "Manual"
81
        pymca_xas.setConfiguration(configuration)
82
    configuration = pymca_xas.getConfiguration()
83
84
85
86
87
88
89
90
    try:
        res = pymca_xas.normalize()
        ddict = spectrum.to_dict()
        ddict.update(res)
        spectrum_ = Spectrum.from_dict(ddict)
    except (IndexError, ValueError) as e:
        _logger.error(e)
        return None, None
91
92
93
    if callbacks:
        for callback in callbacks:
            callback()
94
95
96
97
98
99
100
101
102
103
104
105
106

    def get_output(orignal_spec, res_spec):
        if overwrite:
            orignal_spec.update(res_spec)
            return orignal_spec
        else:
            return res_spec

    if output is not None:
        assert output_dict is not None
        output[output_dict[spectrum]] = get_output(spectrum, spectrum_)

    return configuration, get_output(spectrum, spectrum_)
107
108


109
def pymca_normalization(xas_obj):
payno's avatar
payno committed
110
    """
111

112
113
114
115
    :param xas_obj: object containing the configuration and spectra to process
    :type: Union[XASObject, dict]. If is a dict, should contain configuration or
                                 spectra keys. Otherwise is simply the spectra
    :return: spectra dict
116
    :rtype: dict
payno's avatar
payno committed
117
    """
payno's avatar
payno committed
118
119
    normalization_obj = PyMca_normalization(inputs={"xas_obj": xas_obj})
    return normalization_obj.run()
120
121


122
_USE_MULTIPROCESSING_POOL = False
payno's avatar
payno committed
123
# note: we cannot use multiprocessing pool with pypushflow for now.
124
125


126
class PyMca_normalization(
127
128
129
130
131
    Process,
    name="normalization",
    input_names=["xas_obj"],
    output_names=["xas_obj"],
    optional_input_names=["normalization"],
132
):
133
    def set_properties(self, properties):
payno's avatar
payno committed
134
135
        if "_pymcaSettings" in properties:
            self._settings = properties["_pymcaSettings"]
136

137
    def run(self):
138
139
        """

140
141
142
        :param xas_obj: object containing the configuration and spectra to process
        :type: Union[XASObject, dict]. If is a dict, should contain configuration or
                                     spectra keys. Otherwise is simply the spectra
143
144
        :return: updated XASObject
        :rtype: :class:`.XASObject`
145
        """
146
        xas_obj = self.inputs.xas_obj
147
        if xas_obj is None:
148
            raise ValueError("xas_obj should be provided")
149
        _xas_obj = self.getXasObject(xas_obj)
150
151

        if _xas_obj.energy is None:
payno's avatar
payno committed
152
            _logger.error("Energy not specified, unable to normalize spectra")
153
154
            return

155
156
157
        if self.inputs.normalization:
            self.setConfiguration(self.inputs.normalization)
            _xas_obj.configuration["Normalization"] = self.inputs.normalization
158
        self.progress = 0.0
159
        self._pool_process(xas_obj=_xas_obj)
160
        self.progress = 100.0
161
162
        if _xas_obj.normalized_energy is None:
            raise ValueError("Fail to compute normalize energy")
payno's avatar
payno committed
163
        self.register_process(
164
165
166
167
168
169
            _xas_obj,
            data_keys=(
                _NexusDatasetDef("NormalizedEnergy"),
                _NexusDatasetDef("NormalizedMu"),
                _NexusDatasetDef("NormalizedSignal"),
            ),
payno's avatar
payno committed
170
        )
171
        self.outputs.xas_obj = _xas_obj.to_dict()
172
173
174
175
        return _xas_obj

    def _pool_process(self, xas_obj):
        """process normalization from a pool"""
176
177
        assert isinstance(xas_obj, XASObject)
        if not _USE_MULTIPROCESSING_POOL:
178
            for i_s, spectrum in enumerate(xas_obj.spectra.data.flat):
payno's avatar
payno committed
179
180
181
182
183
184
                process_spectr_norm(
                    spectrum=spectrum,
                    configuration=xas_obj.configuration,
                    callbacks=self.callbacks,
                    overwrite=True,
                )
185
                self.progress = i_s / len(xas_obj.spectra.data.flat) * 100.0
186
        else:
187
            # TODO: remove this mode for simplification
188
            from multiprocessing import Manager
payno's avatar
payno committed
189

190
191
192
            manager = Manager()
            output_dict = {}
            res_list = manager.list()
payno's avatar
payno committed
193
            for i_spect, spect in enumerate(xas_obj.spectra.data.flat):
194
195
196
197
                res_list.append(None)
                output_dict[spect] = i_spect

            with multiprocessing.Pool(5) as p:
payno's avatar
payno committed
198
199
200
201
202
203
204
205
                partial_ = functools.partial(
                    process_spectr_norm,
                    configuration=xas_obj.configuration,
                    callbacks=self.callbacks,
                    overwrite=False,
                    output=res_list,
                    output_dict=output_dict,
                )
206
207
208
209
210
211
                p.map(partial_, xas_obj.spectra)

            # then update local spectrum
            for spectrum, res in zip(xas_obj.spectra, res_list):
                spectrum.update(res)

212
213
214
215
216
    def definition(self):
        return "Normalization of the spectrum"

    def program_version(self):
        import PyMca5
payno's avatar
payno committed
217

218
219
        return PyMca5.version()

220
221
    @staticmethod
    def program_name():
payno's avatar
payno committed
222
        return "pymca_normalization"
223

224
    __call__ = run