edfscan.py 24.2 KB
Newer Older
payno's avatar
payno committed
1
# coding: utf-8
payno's avatar
payno committed
2
# /*##########################################################################
payno's avatar
payno committed
3
# Copyright (C) 2016-2020 European Synchrotron Radiation Facility
payno's avatar
payno committed
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
#
# 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.
#
#############################################################################*/

payno's avatar
payno committed
25
26
"""contains EDFTomoScan, class to be used with EDF acquisition"""

payno's avatar
payno committed
27
28
29
30
31
32
33
34
35

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


import os
import re
import fabio
36
import copy
payno's avatar
payno committed
37
38
39
from lxml import etree
import json
import io
payno's avatar
payno committed
40
from typing import Union
payno's avatar
payno committed
41
42
from ..scanbase import TomoScanBase
from .utils import get_parameters_frm_par_or_info, extract_urls_from_edf
43
from ..unitsystem.metricsystem import MetricSystem
Pierre Paleo's avatar
Pierre Paleo committed
44
from ..utils import docstring
payno's avatar
payno committed
45
46
47
48
49
50
51
52
53
54
import logging

_logger = logging.getLogger(__name__)


class EDFTomoScan(TomoScanBase):
    """
    TomoScanBase instanciation for scan defined from .edf files

    :param scan: path to the root folder containing the scan.
payno's avatar
payno committed
55
    :type scan: Union[str,None]
56
57
    :param n_frames: Number of frames in each EDF file.
        If not provided, it will be inferred by reading the files.
58
        In this case, the frame number is guessed from the file name.
payno's avatar
payno committed
59
    :type n_frames: Union[int, None]=None
payno's avatar
payno committed
60
61
    """

payno's avatar
payno committed
62
    _TYPE = "edf"
payno's avatar
payno committed
63

payno's avatar
payno committed
64
    INFO_EXT = ".info"
payno's avatar
payno committed
65

payno's avatar
payno committed
66
    ABORT_FILE = ".abo"
payno's avatar
payno committed
67

payno's avatar
payno committed
68
    _REFHST_PREFIX = "refHST"
payno's avatar
payno committed
69

payno's avatar
payno committed
70
    _DARKHST_PREFIX = "dark.edf"
payno's avatar
payno committed
71

payno's avatar
payno committed
72
73
74
    _SCHEME = "fabio"

    def __init__(self, scan: Union[str, None], n_frames: Union[int, None] = None):
payno's avatar
payno committed
75
76
77
78
        TomoScanBase.__init__(self, scan=scan, type_=self._TYPE)

        # data caches
        self._darks = None
payno's avatar
payno committed
79
80
        self._flats = None
        self._projections = None
payno's avatar
payno committed
81
82
83
84
85
86
87
88
        self.__tomo_n = None
        self.__ref_n = None
        self.__dark_n = None
        self.__dim1 = None
        self.__dim2 = None
        self.__pixel_size = None
        self.__ref_on = None
        self.__scan_range = None
89
        self._edf_n_frames = n_frames
Pierre Paleo's avatar
Pierre Paleo committed
90
        self.__distance = None
91
        self.__energy = None
payno's avatar
payno committed
92
        self.__estimated_cor_frm_motor = None
93
        self.update()
payno's avatar
payno committed
94

95
96
    @docstring(TomoScanBase.clear_caches)
    def clear_caches(self):
payno's avatar
payno committed
97
        super().clear_caches()
98
99
100
101
102
103
104
105
106
107
108
109
        self._darks = None
        self._flats = None
        self._projections = None
        self.__tomo_n = None
        self.__ref_n = None
        self.__dark_n = None
        self.__dim1 = None
        self.__dim2 = None
        self.__pixel_size = None
        self.__ref_on = None
        self.__scan_range = None

payno's avatar
payno committed
110
111
    @docstring(TomoScanBase.tomo_n)
    @property
payno's avatar
payno committed
112
    def tomo_n(self) -> Union[None, int]:
payno's avatar
payno committed
113
114
115
116
117
118
        if self.__tomo_n is None:
            self.__tomo_n = EDFTomoScan.get_tomo_n(scan=self.path)
        return self.__tomo_n

    @property
    @docstring(TomoScanBase.dark_n)
payno's avatar
payno committed
119
    def dark_n(self) -> Union[None, int]:
payno's avatar
payno committed
120
121
122
123
124
125
        if self.__dark_n is None:
            self.__dark_n = EDFTomoScan.get_dark_n(scan=self.path)
        return self.__dark_n

    @property
    @docstring(TomoScanBase.ref_n)
payno's avatar
payno committed
126
    def ref_n(self) -> Union[None, int]:
payno's avatar
payno committed
127
128
129
130
131
132
        if self.__ref_n is None:
            self.__ref_n = EDFTomoScan.get_ref_n(scan=self.path)
        return self.__ref_n

    @property
    @docstring(TomoScanBase.pixel_size)
payno's avatar
payno committed
133
    def pixel_size(self) -> Union[None, int]:
payno's avatar
payno committed
134
135
136
137
138
139
        """

        :return: pixel size
        :rtype: float
        """
        if self.__pixel_size is None:
140
            self.__pixel_size = EDFTomoScan._get_pixel_size(scan=self.path)
payno's avatar
payno committed
141
142
143
144
        return self.__pixel_size

    @property
    @docstring(TomoScanBase.dim_1)
payno's avatar
payno committed
145
    def dim_1(self) -> Union[None, int]:
payno's avatar
payno committed
146
147
148
149
150
        """

        :return: image dim1
        :rtype: int
        """
151
        if self.__dim1 is None and self.path is not None:
payno's avatar
payno committed
152
153
154
155
156
            self.__dim1, self.__dim2 = EDFTomoScan.get_dim1_dim2(scan=self.path)
        return self.__dim1

    @property
    @docstring(TomoScanBase.dim_2)
payno's avatar
payno committed
157
    def dim_2(self) -> Union[None, int]:
payno's avatar
payno committed
158
159
160
161
162
        """

        :return: image dim2
        :rtype: int
        """
163
        if self.__dim2 is None and self.path is not None:
payno's avatar
payno committed
164
165
166
167
            self.__dim1, self.__dim2 = EDFTomoScan.get_dim1_dim2(scan=self.path)
        return self.__dim2

    @property
payno's avatar
payno committed
168
169
    @docstring(TomoScanBase.ff_interval)
    def ff_interval(self) -> Union[None, int]:
170
        if self.__ref_on is None and self.path is not None:
payno's avatar
payno committed
171
172
173
174
175
            self.__ref_on = EDFTomoScan.get_ff_interval(scan=self.path)
        return self.__ref_on

    @property
    @docstring(TomoScanBase.scan_range)
payno's avatar
payno committed
176
    def scan_range(self) -> Union[None, int]:
177
        if self.__scan_range is None and self.path is not None:
payno's avatar
payno committed
178
179
180
181
182
            self.__scan_range = EDFTomoScan.get_scan_range(scan=self.path)
        return self.__scan_range

    @property
    @docstring(TomoScanBase.flats)
payno's avatar
payno committed
183
184
185
186
    def flats(self) -> Union[None, dict]:
        """
        flats are given as a dictionary with index as key and DataUrl as
        value"""
187
        if self._flats is None and self.path is not None:
payno's avatar
payno committed
188
189
            self._flats = self.get_refs_url(scan_path=self.path)
        return self._flats
payno's avatar
payno committed
190
191
192

    @docstring(TomoScanBase.is_tomoscan_dir)
    @staticmethod
payno's avatar
payno committed
193
    def is_tomoscan_dir(directory: str, **kwargs) -> bool:
payno's avatar
payno committed
194
195
196
        return os.path.isfile(
            EDFTomoScan.get_info_file(directory=directory, kwargs=kwargs)
        )
payno's avatar
payno committed
197
198

    @staticmethod
payno's avatar
payno committed
199
    def get_info_file(directory: str, **kwargs) -> str:
payno's avatar
payno committed
200
        basename = os.path.basename(directory)
payno's avatar
payno committed
201
        assert basename != ""
payno's avatar
payno committed
202
203
        info_file = os.path.join(directory, basename + EDFTomoScan.INFO_EXT)

payno's avatar
payno committed
204
205
206
207
208
        if "src_pattern" in kwargs and kwargs["srx_pattern"] is not None:
            assert "dest_pattern" in kwargs
            info_file = info_file.replace(
                kwargs["src_pattern"], kwargs["dest_pattern"], 1
            )
payno's avatar
payno committed
209
210
211
        return info_file

    @docstring(TomoScanBase.is_abort)
payno's avatar
payno committed
212
    def is_abort(self, **kwargs) -> bool:
payno's avatar
payno committed
213
214
        abort_file = os.path.basename(self.path) + self.ABORT_FILE
        abort_file = os.path.join(self.path, abort_file)
payno's avatar
payno committed
215
216
217
218
219
        if "src_pattern" in kwargs and kwargs["src_pattern"] is not None:
            assert "dest_pattern" in kwargs
            abort_file = abort_file.replace(
                kwargs["src_pattern"], kwargs["dest_pattern"]
            )
payno's avatar
payno committed
220
221
222
223
        return os.path.isfile(abort_file)

    @property
    @docstring(TomoScanBase.darks)
payno's avatar
payno committed
224
    def darks(self) -> dict:
225
        if self._darks is None and self.path is not None:
payno's avatar
payno committed
226
227
228
            self._darks = self.get_darks_url(scan_path=self.path)
        return self._darks

payno's avatar
payno committed
229
230
    @docstring(TomoScanBase.get_proj_angle_url)
    def get_proj_angle_url(self) -> dict:
payno's avatar
payno committed
231
232
        # TODO: we might use fabio.open_serie instead
        if self.path is None:
payno's avatar
payno committed
233
234
235
            _logger.warning(
                "no path specified for scan, unable to retrieve" " the projections"
            )
payno's avatar
payno committed
236
            return {}
payno's avatar
payno committed
237
        n_projection = self.tomo_n
238
        data_urls = EDFTomoScan.get_proj_urls(self.path)
payno's avatar
payno committed
239
240
241
        return TomoScanBase.map_urls_on_scan_range(
            urls=data_urls, n_projection=n_projection, scan_range=self.scan_range
        )
payno's avatar
payno committed
242
243
244

    @docstring(TomoScanBase.update)
    def update(self):
245
        if self.path is not None:
payno's avatar
payno committed
246
247
248
            self.projections = EDFTomoScan.get_proj_urls(
                self.path, n_frames=self._edf_n_frames
            )
249
250
            self._darks = EDFTomoScan.get_darks_url(self.path)
            self._flats = EDFTomoScan.get_refs_url(self.path)
payno's avatar
payno committed
251
252

    @docstring(TomoScanBase.load_from_dict)
payno's avatar
payno committed
253
    def load_from_dict(self, desc: Union[dict, io.TextIOWrapper]):
payno's avatar
payno committed
254
255
256
257
        if isinstance(desc, io.TextIOWrapper):
            data = json.load(desc)
        else:
            data = desc
258
        if not (self.DICT_TYPE_KEY in data and data[self.DICT_TYPE_KEY] == self._TYPE):
payno's avatar
payno committed
259
            raise ValueError("Description is not an EDFScan json description")
payno's avatar
payno committed
260

261
262
        assert self.DICT_PATH_KEY in data
        self.path = data[self.DICT_PATH_KEY]
payno's avatar
payno committed
263
264
265
        return self

    @staticmethod
payno's avatar
payno committed
266
    def get_proj_urls(scan: str, n_frames: Union[int, None] = None) -> dict:
payno's avatar
payno committed
267
268
269
270
271
272
273
        """
        Return the dict of radios / projection for the given scan.
        Keys of the dictionary is the slice number
        Return all the file on the root of scan starting by the name of scan and
        ending by .edf

        :param scan: is the path to the folder of acquisition
payno's avatar
payno committed
274
        :type scan: str
Pierre Paleo's avatar
Pierre Paleo committed
275
        :param n_frames: Number of frames in each EDF file.
276
            If not provided, it is inferred by reading each file.
payno's avatar
payno committed
277
        :type n_frames: int
payno's avatar
payno committed
278
279
280
        :return: dict of radios files with radio index as key and file as value
        :rtype: dict
        """
281
        urls = dict({})
payno's avatar
payno committed
282
        if (scan is None) or not (os.path.isdir(scan)):
283
            return urls
payno's avatar
payno committed
284
285
286

        if os.path.isdir(scan):
            for f in os.listdir(scan):
287
                if EDFTomoScan.is_a_proj_path(fileName=f, scanID=scan):
payno's avatar
payno committed
288
                    gfile = os.path.join(scan, f)
payno's avatar
payno committed
289
290
291
292
293
294
295
296
                    index = EDFTomoScan.guess_index_frm_file_name(
                        gfile, basename=os.path.basename(scan)
                    )
                    urls.update(
                        extract_urls_from_edf(
                            start_index=index, file_=gfile, n_frames=n_frames
                        )
                    )
payno's avatar
payno committed
297

298
        return urls
payno's avatar
payno committed
299
300

    @staticmethod
payno's avatar
payno committed
301
    def is_a_proj_path(fileName: str, scanID: str) -> bool:
payno's avatar
payno committed
302
        """Return True if the given fileName can fit to a Radio name"""
payno's avatar
payno committed
303
304
305
306
        fileBasename = os.path.basename(fileName)
        folderBasename = os.path.basename(scanID)

        if fileBasename.endswith(".edf") and fileBasename.startswith(folderBasename):
payno's avatar
payno committed
307
            localstring = fileName.rstrip(".edf")
payno's avatar
payno committed
308
            # remove the scan
payno's avatar
payno committed
309
310
            localstring = re.sub(folderBasename, "", localstring)
            if "slice_" in localstring:
payno's avatar
payno committed
311
312
                # case of a reconstructed file
                return False
payno's avatar
payno committed
313
            if "refHST" in localstring:
payno's avatar
payno committed
314
                return False
payno's avatar
payno committed
315
            s = localstring.split("_")
payno's avatar
payno committed
316
317
318
319
320
321
322
            if s[-1].isdigit():
                # check that the next value is a digit
                return True

        return False

    @staticmethod
323
324
325
326
327
328
329
330
331
332
333
334
    def guess_index_frm_file_name(_file: str, basename: str) -> Union[None, int]:
        """
        Guess the index of the file. Index is most of the an integer but can be
        a float for 'ref' for example if several are taken.

        :param _file:
        :param basename:
        """

        def extract_index(my_str, type_):
            res = []
            modified_str = copy.copy(my_str)
335
            while modified_str != "" and modified_str[-1].isdigit():
336
337
338
339
340
341
342
                res.append(modified_str[-1])
                modified_str = modified_str[:-1]
            if len(res) == 0:
                return None, modified_str
            else:
                orignalOrder = res[::-1]
                if type_ is int:
payno's avatar
payno committed
343
                    return int("".join(orignalOrder)), modified_str
344
                else:
payno's avatar
payno committed
345
346
                    return float(".".join(("0", "".join(orignalOrder)))), modified_str

347
        _file = os.path.basename(_file)
payno's avatar
payno committed
348
349
350
        if _file.endswith(".edf"):
            name = _file.replace(basename, "", 1)
            name = name.rstrip(".edf")
351
352

            part_1, name = extract_index(name, type_=int)
payno's avatar
payno committed
353
354
            if name.endswith("_"):
                name = name.rstrip("_")
355
356
357
358
                part_2, name = extract_index(name, type_=float)
            else:
                part_2 = None

359
360
            if part_1 is None:
                return None
361
            if part_2 is None:
362
363
364
365
                if part_1 is None:
                    return None
                else:
                    return int(part_1)
366
367
            else:
                return float(part_1) + part_2
payno's avatar
payno committed
368
        else:
payno's avatar
payno committed
369
            raise ValueError("only edf files are managed")
payno's avatar
payno committed
370
371

    @staticmethod
payno's avatar
payno committed
372
    def get_tomo_n(scan: str) -> Union[None, int]:
payno's avatar
payno committed
373
374
375
376
377
378
379
        return EDFTomoScan.retrieve_information(
            scan=os.path.abspath(scan),
            ref_file=None,
            key="TOMO_N",
            type_=int,
            key_aliases=["tomo_N", "Tomo_N"],
        )
payno's avatar
payno committed
380
381

    @staticmethod
payno's avatar
payno committed
382
383
384
385
386
387
388
389
390
391
    def get_dark_n(scan: str) -> Union[None, int]:
        return EDFTomoScan.retrieve_information(
            scan=os.path.abspath(scan),
            ref_file=None,
            key="DARK_N",
            type_=int,
            key_aliases=[
                "dark_N",
            ],
        )
payno's avatar
payno committed
392
393

    @staticmethod
payno's avatar
payno committed
394
395
396
397
398
399
400
401
402
403
    def get_ref_n(scan: str) -> Union[None, int]:
        return EDFTomoScan.retrieve_information(
            scan=os.path.abspath(scan),
            ref_file=None,
            key="REF_N",
            type_=int,
            key_aliases=[
                "ref_N",
            ],
        )
payno's avatar
payno committed
404
405

    @staticmethod
payno's avatar
payno committed
406
    def get_ff_interval(scan: str) -> Union[None, int]:
payno's avatar
payno committed
407
408
409
410
411
412
413
414
415
        return EDFTomoScan.retrieve_information(
            scan=os.path.abspath(scan),
            ref_file=None,
            key="REF_ON",
            type_=int,
            key_aliases=[
                "ref_On",
            ],
        )
payno's avatar
payno committed
416
417

    @staticmethod
payno's avatar
payno committed
418
    def get_scan_range(scan: str) -> Union[None, int]:
payno's avatar
payno committed
419
420
421
422
423
424
425
426
427
        return EDFTomoScan.retrieve_information(
            scan=os.path.abspath(scan),
            ref_file=None,
            key="ScanRange",
            type_=int,
            key_aliases=[
                "scanRange",
            ],
        )
payno's avatar
payno committed
428
429

    @staticmethod
payno's avatar
payno committed
430
    def get_dim1_dim2(scan: str) -> Union[None, tuple]:
payno's avatar
payno committed
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
        _info_file = os.path.join(scan, os.path.basename(scan) + ".info")
        d1 = EDFTomoScan.retrieve_information(
            scan=os.path.abspath(scan),
            ref_file=None,
            key="Dim_1",
            key_aliases=["projectionSize/DIM_1"],
            type_=int,
        )
        d2 = EDFTomoScan.retrieve_information(
            scan=os.path.abspath(scan),
            ref_file=None,
            key="Dim_2",
            key_aliases=["projectionSize/DIM_2"],
            type_=int,
        )
payno's avatar
payno committed
446
447
448

        return d1, d2

payno's avatar
payno committed
449
450
451
452
    @property
    @docstring(TomoScanBase.distance)
    def distance(self) -> Union[None, float]:
        if self.__distance is None:
payno's avatar
payno committed
453
454
455
            self.__distance = EDFTomoScan.retrieve_information(
                self.path, None, "Distance", type_=float, key_aliases=("distance",)
            )
payno's avatar
payno committed
456
457
458
        if self.__distance is None:
            return None
        else:
459
            return self.__distance * MetricSystem.MILLIMETER.value
payno's avatar
payno committed
460

payno's avatar
payno committed
461
    @property
payno's avatar
payno committed
462
    @docstring(TomoScanBase.field_of_view)
payno's avatar
payno committed
463
    def field_of_view(self):
payno's avatar
payno committed
464
465
        # not managed for EDF files
        return None
payno's avatar
payno committed
466

payno's avatar
payno committed
467
468
469
    @property
    @docstring(TomoScanBase.estimated_cor_frm_motor)
    def estimated_cor_frm_motor(self):
payno's avatar
payno committed
470
471
472
        # not managed for EDF files
        return None

payno's avatar
payno committed
473
474
475
476
    @property
    @docstring(TomoScanBase.energy)
    def energy(self):
        if self.__energy is None:
payno's avatar
payno committed
477
478
479
            self.__energy = EDFTomoScan.retrieve_information(
                self.path, None, "Energy", type_=float, key_aliases=("energy",)
            )
payno's avatar
payno committed
480
481
        return self.__energy

payno's avatar
payno committed
482
    @staticmethod
payno's avatar
payno committed
483
    def _get_pixel_size(scan: str) -> Union[None, float]:
payno's avatar
payno committed
484
485
        if os.path.isdir(scan) is False:
            return None
payno's avatar
payno committed
486
487
488
489
490
491
492
493
494
        value = EDFTomoScan.retrieve_information(
            scan=scan,
            ref_file=None,
            key="PixelSize",
            type_=float,
            key_aliases=[
                "pixelSize",
            ],
        )
payno's avatar
payno committed
495
        if value is None:
payno's avatar
payno committed
496
            parFile = os.path.join(scan, os.path.basename(scan) + ".par")
payno's avatar
payno committed
497
498
499
500
501
            if os.path.exists(parFile):
                try:
                    ddict = get_parameters_frm_par_or_info(parFile)
                except ValueError as e:
                    _logger.error(e)
payno's avatar
payno committed
502
503
                if "IMAGE_PIXEL_SIZE_1".lower() in ddict:
                    value = float(ddict["IMAGE_PIXEL_SIZE_1".lower()])
payno's avatar
payno committed
504
505
506
        # for now pixel size are stored in microns.
        # We want to return them in meter
        if value is not None:
507
            return value * MetricSystem.MICROMETER.value
payno's avatar
payno committed
508
509
510
511
        else:
            return None

    @staticmethod
payno's avatar
payno committed
512
513
514
    def get_darks_url(
        scan_path: str, prefix: str = "dark", file_ext: str = ".edf"
    ) -> dict:
payno's avatar
payno committed
515
516
517
        """

        :param scan_path:
payno's avatar
payno committed
518
        :type scan_path: str
payno's avatar
payno committed
519
        :param prefix: ref / flat field file prefix
payno's avatar
payno committed
520
        :type prefix: str
payno's avatar
payno committed
521
        :param file_ext: ref / flat field file extension
payno's avatar
payno committed
522
        :type file_ext: str
payno's avatar
payno committed
523
524
        :return: list of refs as silx's `DataUrl`
        """
payno's avatar
payno committed
525
        res = {}
payno's avatar
payno committed
526
        if os.path.isdir(scan_path) is False:
payno's avatar
payno committed
527
528
529
            _logger.error(
                scan_path + " is not a directory. Cannot extract " "DarkHST files"
            )
payno's avatar
payno committed
530
            return res
payno's avatar
payno committed
531
        for file_ in os.listdir(scan_path):
payno's avatar
payno committed
532
533
534
            _prefix = prefix
            if prefix.endswith(file_ext):
                _prefix = prefix.rstrip(file_ext)
payno's avatar
payno committed
535
536
537
            if file_.startswith(_prefix) and file_.endswith(file_ext):
                # usuelly the dark file name should be dark.edf, but some
                # darkHSTXXXX remains...
payno's avatar
payno committed
538
539
540
541
542
543
544
545
                file_fp = file_.lstrip(_prefix).rstrip(file_ext).lstrip("HST")
                if file_fp == "" or file_fp.isnumeric() is True:
                    index = EDFTomoScan.guess_index_frm_file_name(
                        _file=file_, basename=os.path.basename(scan_path)
                    )
                    urls = extract_urls_from_edf(
                        os.path.join(scan_path, file_), start_index=index
                    )
payno's avatar
payno committed
546
                    res.update(urls)
payno's avatar
payno committed
547
548
549
        return res

    @staticmethod
payno's avatar
payno committed
550
551
552
    def get_refs_url(
        scan_path: str, prefix: str = "refHST", file_ext: str = ".edf", ignore=None
    ) -> dict:
payno's avatar
payno committed
553
554
555
        """

        :param scan_path:
payno's avatar
payno committed
556
        :type scan_path: str
payno's avatar
payno committed
557
        :param prefix: ref / flat field file prefix
payno's avatar
payno committed
558
        :type prefix: str
payno's avatar
payno committed
559
        :param file_ext: ref / flat field file extension
payno's avatar
payno committed
560
        :type file_ext: str
payno's avatar
payno committed
561
562
        :return: list of refs as silx's `DataUrl`
        """
payno's avatar
payno committed
563
        res = {}
payno's avatar
payno committed
564
        if os.path.isdir(scan_path) is False:
payno's avatar
payno committed
565
566
567
            _logger.error(
                scan_path + " is not a directory. Cannot extract " "RefHST files"
            )
payno's avatar
payno committed
568
            return res
569

570
571
572
573
574
575
576
        def get_next_free_index(key, keys):
            """return next free key from keys by converting it to a string
            with `key_value (n)` after it
            """
            new_key = key
            index = 2
            while new_key in keys:
payno's avatar
payno committed
577
                new_key = "%s (%s)" % (key, index)
578
579
                index += 1
            return new_key
payno's avatar
payno committed
580

581
582
583
584
585
586
587
588
        def ignore_file(file_name, to_ignore):
            if to_ignore is None:
                return False
            for pattern in to_ignore:
                if pattern in file_name:
                    return True
            return False

payno's avatar
payno committed
589
        for file_ in os.listdir(scan_path):
payno's avatar
payno committed
590
591
592
593
594
595
596
597
            if (
                file_.startswith(prefix)
                and file_.endswith(file_ext)
                and not ignore_file(file_, ignore)
            ):
                index = EDFTomoScan.guess_index_frm_file_name(
                    _file=file_, basename=os.path.basename(scan_path)
                )
payno's avatar
payno committed
598
599
                file_fp = os.path.join(scan_path, file_)
                urls = extract_urls_from_edf(start_index=index, file_=file_fp)
600
601
602
603
604
605
                for key in urls:
                    if key in res:
                        key_ = get_next_free_index(key, res.keys())
                    else:
                        key_ = key
                    res[key_] = urls[key]
payno's avatar
payno committed
606
607
608
        return res

    @staticmethod
payno's avatar
payno committed
609
610
611
612
613
614
615
    def retrieve_information(
        scan: str,
        ref_file: Union[str, None],
        key: str,
        type_: type,
        key_aliases: Union[list, tuple, None] = None,
    ):
payno's avatar
payno committed
616
617
        """
        Try to retrieve information a .info file, an .xml or a flat field file.
Pierre Paleo's avatar
Pierre Paleo committed
618

payno's avatar
payno committed
619
620
621
622
623
624
625
        file.
        Look for the key 'key' or one of it aliases.

        :param scan: root folder of an acquisition. Must be an absolute path
        :param ref_file: the refXXXX_YYYY which should contain information
                         about the scan.
        :param key: the key (information) we are looking for
payno's avatar
payno committed
626
        :type key: str
payno's avatar
payno committed
627
628
629
        :param type_: requestde out type if the information is found
        :type type_: return type if the information is found.
        :param key_aliases: aliases of the key in the different file
payno's avatar
payno committed
630
        :type key_aliases: list
payno's avatar
payno committed
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
        :return: the requested information or None if not found
        """
        info_aliases = [key]
        if key_aliases is not None:
            assert type(key_aliases) in (tuple, list)
            [info_aliases.append(alias) for alias in key_aliases]

        if not os.path.isdir(scan):
            return None

        # 1st look for ref file if any given
        def parseRefFile(filePath):
            header = fabio.open(filePath).header
            for k in key_aliases:
                if k in header:
                    return type_(header[k])
            return None

        if ref_file is not None and os.path.isfile(ref_file):
            try:
                info = parseRefFile(ref_file)
            except IOError as e:
                _logger.warning(e)
            else:
                if info is not None:
                    return info

        # 2nd look for .info file
        def parseInfoFile(filePath):
            def extractInformation(text, alias):
payno's avatar
payno committed
661
662
663
664
                text = text.replace(alias, "")
                text = text.replace("\n", "")
                text = text.replace(" ", "")
                text = text.replace("=", "")
payno's avatar
payno committed
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
                return type_(text)

            info = None
            f = open(filePath, "r")
            line = f.readline()
            while line:
                for alias in info_aliases:
                    if alias in line:
                        info = extractInformation(line, alias)
                        break
                line = f.readline()
            f.close()
            return info

        baseName = os.path.basename(scan)
payno's avatar
payno committed
680
681
        infoFiles = [os.path.join(scan, baseName + ".info")]
        infoOnDataVisitor = infoFiles[0].replace("lbsram", "")
payno's avatar
payno committed
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
        # hack to check in lbsram, would need to be removed to add some consistency
        if os.path.isfile(infoOnDataVisitor):
            infoFiles.append(infoOnDataVisitor)
        for infoFile in infoFiles:
            if os.path.isfile(infoFile) is True:
                info = parseInfoFile(infoFile)
                if info is not None:
                    return info

        # 3td look for xml files
        def parseXMLFile(filePath):
            try:
                for alias in info_aliases:
                    tree = etree.parse(filePath)
                    elmt = tree.find("acquisition/" + alias)
                    if elmt is None:
                        continue
                    else:
                        info = type_(elmt.text)
                        if info == -1:
                            return None
                        else:
                            return info
            except etree.XMLSyntaxError as e:
                _logger.warning(e)
                return None

payno's avatar
payno committed
709
710
        xmlFiles = [os.path.join(scan, baseName + ".xml")]
        xmlOnDataVisitor = xmlFiles[0].replace("lbsram", "")
payno's avatar
payno committed
711
712
713
714
715
716
717
718
719
720
        # hack to check in lbsram, would need to be removed to add some consistency
        if os.path.isfile(xmlOnDataVisitor):
            xmlFiles.append(xmlOnDataVisitor)
        for xmlFile in xmlFiles:
            if os.path.isfile(xmlFile) is True:
                info = parseXMLFile(xmlFile)
                if info is not None:
                    return info

        return None
payno's avatar
payno committed
721
722
723
724
725
726

    def get_range(self):
        if self.path is not None:
            return self.get_scan_range(self.path)
        else:
            return None