__init__.py 69.7 KB
Newer Older
1
2
# Event source for MAGIC calibrated data files.
# Requires uproot package (https://github.com/scikit-hep/uproot).
Moritz Huetten's avatar
Moritz Huetten committed
3
import logging
4
5
6
7

import glob
import re

8
import scipy
9
10
11
12
13
14
import numpy as np
import scipy.interpolate

from astropy import units as u
from astropy.time import Time
from ctapipe.io.eventsource import EventSource
15
from ctapipe.io.containers import DataContainer, TelescopePointingContainer, WeatherContainer
16
17
18
19
from ctapipe.instrument import TelescopeDescription, SubarrayDescription, OpticsDescription, CameraGeometry

__all__ = ['MAGICEventSource']

Moritz Huetten's avatar
Moritz Huetten committed
20
logger = logging.getLogger(__name__)
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

class MAGICEventSource(EventSource):
    """
    EventSource for MAGIC calibrated data.

    This class operates with the MAGIC data run-wise. This means that the files
    corresponding to the same data run are loaded and processed together.
    """
    _count = 0

    def __init__(self, config=None, tool=None, **kwargs):
        """
        Constructor

        Parameters
        ----------
        config: traitlets.loader.Config
            Configuration specified by config file or cmdline arguments.
            Used to set traitlet values.
            Set to None if no configuration to pass.
        tool: ctapipe.core.Tool
            Tool executable that is calling this component.
            Passes the correct logger to the component.
            Set to None if no Tool to pass.
        kwargs: dict
            Additional parameters to be passed.
            NOTE: The file mask of the data to read can be passed with
            the 'input_url' parameter.
        """

        try:
            import uproot
        except ImportError:
            msg = "The `uproot` python module is required to access the MAGIC data"
            self.log.error(msg)
            raise

58
59
        self.file_list = glob.glob(kwargs['input_url'])
        self.file_list.sort()
60
61
62
63
64

        # EventSource can not handle file wild cards as input_url
        # To overcome this we substitute the input_url with first file matching
        # the specified file mask.
        del kwargs['input_url']
65
        super().__init__(input_url=self.file_list[0], **kwargs)
66
67

        # Retrieving the list of run numbers corresponding to the data files
68
        run_numbers = list(map(self._get_run_number, self.file_list))
69
70
71
72
73
74
75
76
77
78
79
80
81
82
        self.run_numbers = np.unique(run_numbers)

        # # Setting up the current run with the first run present in the data
        # self.current_run = self._set_active_run(run_number=0)
        self.current_run = None

        # MAGIC telescope positions in m wrt. to the center of CTA simulations
        self.magic_tel_positions = {
            1: [-27.24, -146.66, 50.00] * u.m,
            2: [-96.44, -96.77, 51.00] * u.m
        }
        # MAGIC telescope description
        optics = OpticsDescription.from_name('MAGIC')
        geom = CameraGeometry.from_name('MAGICCam')
83
        self.magic_tel_description = TelescopeDescription(name='MAGIC', tel_type='MAGIC', optics=optics, camera=geom)
84
        self.magic_tel_descriptions = {1: self.magic_tel_description, 2: self.magic_tel_description}
85
        self._subarray_info = SubarrayDescription('MAGIC', self.magic_tel_positions, self.magic_tel_descriptions)
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

    @staticmethod
    def is_compatible(file_mask):
        """
        This method checks if the specified file mask corresponds
        to MAGIC data files. The result will be True only if all
        the files are of ROOT format and contain an 'Events' tree.

        Parameters
        ----------
        file_mask: str
            A file mask to check

        Returns
        -------
        bool:
            True if the masked files are MAGIC data runs, False otherwise.

        """

        is_magic_root_file = True

        file_list = glob.glob(file_mask)

        for file_path in file_list:
            try:
                import uproot

                try:
                    with uproot.open(file_path) as input_data:
                        if 'Events' not in input_data:
                            is_magic_root_file = False
                except ValueError:
                    # uproot raises ValueError if the file is not a ROOT file
                    is_magic_root_file = False
                    pass

            except ImportError:
Ievgen Vovk's avatar
Ievgen Vovk committed
124
                if re.match(r'.+_m\d_.+root', file_path.lower()) is None:
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
                    is_magic_root_file = False

        return is_magic_root_file

    @staticmethod
    def _get_run_number(file_name):
        """
        This internal method extracts the run number from
        the specified file name.

        Parameters
        ----------
        file_name: str
            A file name to process.

        Returns
        -------
        int:
            A run number of the file.
        """

146
        mask = r".*\d+_M\d+_(\d+)\.\d+_.*"
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
        parsed_info = re.findall(mask, file_name)

        try:
            run_number = int(parsed_info[0])
        except IndexError:
            raise IndexError('Can not identify the run number of the file {:s}'.format(file_name))

        return run_number

    def _set_active_run(self, run_number):
        """
        This internal method sets the run that will be used for data loading.

        Parameters
        ----------
        run_number: int
            The run number to use.

        Returns
        -------
Moritz Huetten's avatar
Moritz Huetten committed
167
168
        MarsDataRun:
            The run to use
169
170
171
172
173
174
175
176
        """

        input_path = '/'.join(self.input_url.split('/')[:-1])
        this_run_mask = input_path + '/*{:d}*root'.format(run_number)

        run = dict()
        run['number'] = run_number
        run['read_events'] = 0
177
        run['data'] = MarsDataRun(run_file_mask=this_run_mask, filter_list=self.file_list)
178
179
180

        return run

181
182
183
184
    @property
    def subarray(self):
        return self._subarray_info

185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
    def _generator(self):
        """
        The default event generator. Return the stereo event
        generator instance.

        Returns
        -------

        """

        return self._stereo_event_generator()

    def _stereo_event_generator(self):
        """
        Stereo event generator. Yields DataContainer instances, filled
        with the read event data.

        Returns
        -------

        """

        counter = 0

        # Data container - is initialized once, and data is replaced within it after each yield
        data = DataContainer()

        # Telescopes with data:
        tels_in_file = ["m1", "m2"]
        tels_with_data = {1, 2}

        # Loop over the available data runs
        for run_number in self.run_numbers:

            # Removing the previously read data run from memory
            if self.current_run is not None:
                if 'data' in self.current_run:
                    del self.current_run['data']

Moritz Huetten's avatar
Moritz Huetten committed
224
            # Setting the new active run (class MarsDataRun object)
225
226
227
228
229
230
231
232
233
234
235
            self.current_run = self._set_active_run(run_number)

            # Loop over the events
            for event_i in range(self.current_run['data'].n_stereo_events):
                # Event and run ids
                event_order_number = self.current_run['data'].stereo_ids[event_i][0]
                event_id = self.current_run['data'].event_data['M1']['stereo_event_number'][event_order_number]
                obs_id = self.current_run['number']

                # Reading event data
                event_data = self.current_run['data'].get_stereo_event_data(event_i)
Moritz Huetten's avatar
Moritz Huetten committed
236
                
237
                data.meta = event_data['mars_meta']
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260

                # Event counter
                data.count = counter

                # Setting up the R0 container
                data.r0.obs_id = obs_id
                data.r0.event_id = event_id
                data.r0.tel.clear()

                # Setting up the R1 container
                data.r1.obs_id = obs_id
                data.r1.event_id = event_id
                data.r1.tel.clear()

                # Setting up the DL0 container
                data.dl0.obs_id = obs_id
                data.dl0.event_id = event_id
                data.dl0.tel.clear()

                # Filling the DL1 container with the event data
                for tel_i, tel_id in enumerate(tels_in_file):
                    # Creating the telescope pointing container
                    pointing = TelescopePointingContainer()
261
262
263
264
                    pointing.azimuth = np.deg2rad(event_data['{:s}_pointing_az'.format(tel_id)]) * u.rad
                    pointing.altitude = np.deg2rad(90 - event_data['{:s}_pointing_zd'.format(tel_id)]) * u.rad
                    pointing.ra = np.deg2rad(event_data['{:s}_pointing_ra'.format(tel_id)]) * u.rad
                    pointing.dec = np.deg2rad(event_data['{:s}_pointing_dec'.format(tel_id)]) * u.rad
265
266
267
268
269
270

                    # Adding the pointing container to the event data
                    data.pointing[tel_i + 1] = pointing

                    # Adding event charge and peak positions per pixel
                    data.dl1.tel[tel_i + 1].image = event_data['{:s}_image'.format(tel_id)]
Ievgen Vovk's avatar
Ievgen Vovk committed
271
                    data.dl1.tel[tel_i + 1].pulse_time = event_data['{:s}_pulse_time'.format(tel_id)]
272
                    data.dl1.tel[tel_i + 1].badpixels = event_data['{:s}_bad_pixels'.format(tel_id)]
273
274
275
276
277
278
279
280
281
282
283
284
                    # data.dl1.tel[i_tel + 1].badpixels = np.array(
                    #     file['dl1/tel' + str(i_tel + 1) + '/badpixels'], dtype=np.bool)

                # Adding the event arrival time
                time_tmp = Time(event_data['mjd'], scale='utc', format='mjd')
                data.trig.gps_time = Time(time_tmp, format='unix', scale='utc', precision=9)

                # Setting the telescopes with data
                data.r0.tels_with_data = tels_with_data
                data.r1.tels_with_data = tels_with_data
                data.dl0.tels_with_data = tels_with_data
                data.trig.tels_with_trigger = tels_with_data
285
286
287
288
289
290
291
                
                # Filling weather information
                weather = WeatherContainer()
                weather.air_temperature = event_data['air_temperature'] * u.deg_C
                weather.air_pressure = event_data['air_pressure'] * u.hPa
                weather.air_humidity = event_data['air_humidity']
                data.weather = weather
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352

                yield data
                counter += 1

        return

    def _mono_event_generator(self, telescope):
        """
        Mono event generator. Yields DataContainer instances, filled
        with the read event data.

        Parameters
        ----------
        telescope: str
            The telescope for which to return events. Can be either "M1" or "M2".

        Returns
        -------

        """

        counter = 0
        telescope = telescope.upper()

        # Data container - is initialized once, and data is replaced within it after each yield
        data = DataContainer()

        # Telescopes with data:
        tels_in_file = ["M1", "M2"]

        if telescope not in tels_in_file:
            raise ValueError("Specified telescope {:s} is not in the allowed list {}".format(telescope, tels_in_file))

        tel_i = tels_in_file.index(telescope)
        tels_with_data = {tel_i + 1, }

        # Loop over the available data runs
        for run_number in self.run_numbers:

            # Removing the previously read data run from memory
            if self.current_run is not None:
                if 'data' in self.current_run:
                    del self.current_run['data']

            # Setting the new active run
            self.current_run = self._set_active_run(run_number)

            if telescope == 'M1':
                n_events = self.current_run['data'].n_mono_events_m1
            else:
                n_events = self.current_run['data'].n_mono_events_m2

            # Loop over the events
            for event_i in range(n_events):
                # Event and run ids
                event_order_number = self.current_run['data'].mono_ids[telescope][event_i]
                event_id = self.current_run['data'].event_data[telescope]['stereo_event_number'][event_order_number]
                obs_id = self.current_run['number']

                # Reading event data
                event_data = self.current_run['data'].get_mono_event_data(event_i, telescope=telescope)
Moritz Huetten's avatar
Moritz Huetten committed
353
                
354
                data.meta = event_data['mars_meta']
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385

                # Event counter
                data.count = counter

                # Setting up the R0 container
                data.r0.obs_id = obs_id
                data.r0.event_id = event_id
                data.r0.tel.clear()

                # Setting up the R1 container
                data.r1.obs_id = obs_id
                data.r1.event_id = event_id
                data.r1.tel.clear()

                # Setting up the DL0 container
                data.dl0.obs_id = obs_id
                data.dl0.event_id = event_id
                data.dl0.tel.clear()

                # Creating the telescope pointing container
                pointing = TelescopePointingContainer()
                pointing.azimuth = np.deg2rad(event_data['pointing_az']) * u.rad
                pointing.altitude = np.deg2rad(90 - event_data['pointing_zd']) * u.rad
                pointing.ra = np.deg2rad(event_data['pointing_ra']) * u.rad
                pointing.dec = np.deg2rad(event_data['pointing_dec']) * u.rad

                # Adding the pointing container to the event data
                data.pointing[tel_i + 1] = pointing

                # Adding event charge and peak positions per pixel
                data.dl1.tel[tel_i + 1].image = event_data['image']
Ievgen Vovk's avatar
Ievgen Vovk committed
386
                data.dl1.tel[tel_i + 1].pulse_time = event_data['pulse_time']
387
                data.dl1.tel[tel_i + 1].badpixels = event_data['bad_pixels']
388
389
390
391
392
393
394
395
396
397
398
399
400
                # data.dl1.tel[tel_i + 1].badpixels = np.array(
                #     file['dl1/tel' + str(i_tel + 1) + '/badpixels'], dtype=np.bool)

                # Adding the event arrival time
                time_tmp = Time(event_data['mjd'], scale='utc', format='mjd')
                data.trig.gps_time = Time(time_tmp, format='unix', scale='utc', precision=9)

                # Setting the telescopes with data
                data.r0.tels_with_data = tels_with_data
                data.r1.tels_with_data = tels_with_data
                data.dl0.tels_with_data = tels_with_data
                data.trig.tels_with_trigger = tels_with_data

401
402
403
404
405
406
407
                # Filling weather information
                weather = WeatherContainer()
                weather.air_temperature = event_data['air_temperature'] * u.deg_C
                weather.air_pressure = event_data['air_pressure'] * u.hPa
                weather.air_humidity = event_data['air_humidity']
                data.weather = weather

408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
                yield data
                counter += 1

        return

    def _pedestal_event_generator(self, telescope):
        """
        Pedestal event generator. Yields DataContainer instances, filled
        with the read event data.

        Parameters
        ----------
        telescope: str
            The telescope for which to return events. Can be either "M1" or "M2".

        Returns
        -------

        """

        counter = 0
        telescope = telescope.upper()

        # Data container - is initialized once, and data is replaced within it after each yield
        data = DataContainer()

        # Telescopes with data:
        tels_in_file = ["M1", "M2"]

        if telescope not in tels_in_file:
            raise ValueError("Specified telescope {:s} is not in the allowed list {}".format(telescope, tels_in_file))

        tel_i = tels_in_file.index(telescope)
        tels_with_data = {tel_i + 1, }

        # Loop over the available data runs
        for run_number in self.run_numbers:

            # Removing the previously read data run from memory
            if self.current_run is not None:
                if 'data' in self.current_run:
                    del self.current_run['data']

            # Setting the new active run
            self.current_run = self._set_active_run(run_number)

            if telescope == 'M1':
                n_events = self.current_run['data'].n_pedestal_events_m1
            else:
                n_events = self.current_run['data'].n_pedestal_events_m2

            # Loop over the events
            for event_i in range(n_events):
                # Event and run ids
                event_order_number = self.current_run['data'].pedestal_ids[telescope][event_i]
                event_id = self.current_run['data'].event_data[telescope]['stereo_event_number'][event_order_number]
                obs_id = self.current_run['number']

                # Reading event data
                event_data = self.current_run['data'].get_pedestal_event_data(event_i, telescope=telescope)
Moritz Huetten's avatar
Moritz Huetten committed
468
                
469
                data.meta = event_data['mars_meta']
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500

                # Event counter
                data.count = counter

                # Setting up the R0 container
                data.r0.obs_id = obs_id
                data.r0.event_id = event_id
                data.r0.tel.clear()

                # Setting up the R1 container
                data.r1.obs_id = obs_id
                data.r1.event_id = event_id
                data.r1.tel.clear()

                # Setting up the DL0 container
                data.dl0.obs_id = obs_id
                data.dl0.event_id = event_id
                data.dl0.tel.clear()

                # Creating the telescope pointing container
                pointing = TelescopePointingContainer()
                pointing.azimuth = np.deg2rad(event_data['pointing_az']) * u.rad
                pointing.altitude = np.deg2rad(90 - event_data['pointing_zd']) * u.rad
                pointing.ra = np.deg2rad(event_data['pointing_ra']) * u.rad
                pointing.dec = np.deg2rad(event_data['pointing_dec']) * u.rad

                # Adding the pointing container to the event data
                data.pointing[tel_i + 1] = pointing

                # Adding event charge and peak positions per pixel
                data.dl1.tel[tel_i + 1].image = event_data['image']
Ievgen Vovk's avatar
Ievgen Vovk committed
501
                data.dl1.tel[tel_i + 1].pulse_time = event_data['pulse_time']
502
                data.dl1.tel[tel_i + 1].badpixels = event_data['bad_pixels']
503
504
505
506
507
508
509
510
511
512
513
514
                # data.dl1.tel[tel_i + 1].badpixels = np.array(
                #     file['dl1/tel' + str(i_tel + 1) + '/badpixels'], dtype=np.bool)

                # Adding the event arrival time
                time_tmp = Time(event_data['mjd'], scale='utc', format='mjd')
                data.trig.gps_time = Time(time_tmp, format='unix', scale='utc', precision=9)

                # Setting the telescopes with data
                data.r0.tels_with_data = tels_with_data
                data.r1.tels_with_data = tels_with_data
                data.dl0.tels_with_data = tels_with_data
                data.trig.tels_with_trigger = tels_with_data
515
516
517
518
519
520
521
                
                # Filling weather information
                weather = WeatherContainer()
                weather.air_temperature = event_data['air_temperature'] * u.deg_C
                weather.air_pressure = event_data['air_pressure'] * u.hPa
                weather.air_humidity = event_data['air_humidity']
                data.weather = weather
522
523
524
525
526
527
528

                yield data
                counter += 1

        return


529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
class MAGICEventSourceMC(EventSource):
    """
    EventSource for MAGIC calibrated MCs.
    """
    _count = 0

    def __init__(self, config=None, tool=None, **kwargs):
        """
        Constructor

        Parameters
        ----------
        config: traitlets.loader.Config
            Configuration specified by config file or cmdline arguments.
            Used to set traitlet values.
            Set to None if no configuration to pass.
        tool: ctapipe.core.Tool
            Tool executable that is calling this component.
            Passes the correct logger to the component.
            Set to None if no Tool to pass.
        kwargs: dict
            Additional parameters to be passed.
            NOTE: The file mask of the data to read can be passed with
            the 'input_url' parameter.
        """

        try:
            import uproot
        except ImportError:
            msg = "The `uproot` python module is required to access the MAGIC data"
            self.log.error(msg)
            raise
561
562
563
        
        if len(glob.glob(kwargs['input_url'])) > 1:
            raise ImportError('MC data can no be loaded with wildcards. Please load them run by run')  
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578

        self.file_name = kwargs['input_url']

        super().__init__(**kwargs)

        self.mc_file = MarsMCFile(self.file_name)

        # MAGIC telescope positions in m wrt. to the center of CTA simulations
        self.magic_tel_positions = {
            1: [-27.24, -146.66, 50.00] * u.m,
            2: [-96.44, -96.77, 51.00] * u.m
        }
        # MAGIC telescope description
        optics = OpticsDescription.from_name('MAGIC')
        geom = CameraGeometry.from_name('MAGICCam')
579
        self.magic_tel_description = TelescopeDescription(name='MAGIC', tel_type='MAGIC', optics=optics, camera=geom)
580
        self.magic_tel_descriptions = {1: self.magic_tel_description, 2: self.magic_tel_description}
581
        self._subarray_info = SubarrayDescription('MAGIC', self.magic_tel_positions, self.magic_tel_descriptions)
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621

    @staticmethod
    def is_compatible(file_name):
        """
        This method checks if the specified file name corresponds
        to a MAGIC data file. The result will be True only if all
        the files are of ROOT format and contain an 'Events' tree.

        Parameters
        ----------
        file_name: str
            A file name to check

        Returns
        -------
        bool:
            True if the given file is MAGIC data file, False otherwise.

        """

        is_magic_root_file = True

        try:
            import uproot

            try:
                with uproot.open(file_name) as input_data:
                    if 'Events' not in input_data:
                        is_magic_root_file = False
            except ValueError:
                # uproot raises ValueError if the file is not a ROOT file
                is_magic_root_file = False
                pass

        except ImportError:
            if re.match(r'.+_m\d_.+root', file_name.lower()) is None:
                is_magic_root_file = False

        return is_magic_root_file

622
623
624
625
    @property
    def subarray(self):
        return self._subarray_info

626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
    def _generator(self):
        """
        The default event generator. Return the stereo event
        generator instance.

        Returns
        -------

        """

        return self._mono_event_generator()

    def _mono_event_generator(self):
        """
        Mono event generator. Yields DataContainer instances, filled
        with the read event data.

        Returns
        -------
        ctapipe.io.containers.DataContainer

        """

        counter = 0

        # Data container - is initialized once, and data is replaced within it after each yield
        data = DataContainer()
        data.meta['origin'] = "MAGIC MC"
        data.meta['input_url'] = self.input_url
655
        data.meta['is_simulation'] = True
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
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
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723

        tels_with_data = {self.mc_file.telescope, }

        # Loop over the events
        for event_i in range(self.mc_file.n_mono_events):
            # Event and run ids
            event_order_number = self.mc_file.mono_ids[event_i]
            event_id = self.mc_file.event_data['daq_event_number'][event_order_number]
            obs_id = self.mc_file.run_number

            # Reading event data
            event_data = self.mc_file.get_mono_event_data(event_i)

            # Event counter
            data.count = counter

            # Setting up the R0 container
            data.r0.obs_id = obs_id
            data.r0.event_id = event_id
            data.r0.tel.clear()

            # Setting up the R1 container
            data.r1.obs_id = obs_id
            data.r1.event_id = event_id
            data.r1.tel.clear()

            # Setting up the DL0 container
            data.dl0.obs_id = obs_id
            data.dl0.event_id = event_id
            data.dl0.tel.clear()

            # Setting up the MC container
            data.mc.tel.clear()

            # Creating the telescope pointing container
            pointing = TelescopePointingContainer()
            pointing.azimuth = np.deg2rad(event_data['pointing_az']) * u.rad
            pointing.altitude = np.deg2rad(90 - event_data['pointing_zd']) * u.rad

            # Adding the pointing container to the event data
            data.pointing[self.mc_file.telescope] = pointing

            # Adding event charge and peak positions per pixel
            data.dl1.tel[self.mc_file.telescope].image = event_data['image']
            data.dl1.tel[self.mc_file.telescope].pulse_time = event_data['pulse_time']

            # Setting the telescopes with data
            data.r0.tels_with_data = tels_with_data
            data.r1.tels_with_data = tels_with_data
            data.dl0.tels_with_data = tels_with_data
            data.trig.tels_with_trigger = tels_with_data

            # mc = data.mc.tel[self.mc_file.telescope]
            # mc.dc_to_pe = array_event['laser_calibrations'][tel_id]['calib']
            # mc.pedestal = array_event['camera_monitorings'][tel_id]['pedestal']
            # mc.reference_pulse_shape = pixel_settings['ref_shape'].astype('float64')
            # mc.meta['refstep'] = float(pixel_settings['ref_step'])
            # mc.time_slice = float(pixel_settings['time_slice'])
            # mc.photo_electron_image = (
            #     array_event
            #         .get('photoelectrons', {})
            #         .get(tel_index, {})
            #         .get('photoelectrons', np.zeros(n_pixel, dtype='float32'))
            # )

            data.mc.energy = event_data['true_energy'] * u.GeV
            data.mc.alt = (90 - event_data['true_zd']) * u.deg
            data.mc.az = event_data['true_az'] * u.deg
724
725
726
727
            data.mc.shower_primary_id = 1 - event_data['true_shower_primary_id']
            data.mc.h_first_int = event_data['true_h_first_int'] * u.cm
            data.mc.core_x = event_data['true_core_x'] * u.cm
            data.mc.core_y = event_data['true_core_y'] * u.cm
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750

            yield data
            counter += 1

        return

    def _pedestal_event_generator(self):
        """
        Pedestal event generator. Yields DataContainer instances, filled
        with the read event data.

        Returns
        -------
        ctapipe.io.containers.DataContainer

        """

        counter = 0

        # Data container - is initialized once, and data is replaced within it after each yield
        data = DataContainer()
        data.meta['origin'] = "MAGIC MC"
        data.meta['input_url'] = self.input_url
751
        data.meta['is_simulation'] = True
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819

        tels_with_data = {self.mc_file.telescope, }

        # Loop over the events
        for event_i in range(self.mc_file.n_pedestal_events):
            # Event and run ids
            event_order_number = self.mc_file.pedestal_ids[event_i]
            event_id = self.mc_file.event_data['daq_event_number'][event_order_number]
            obs_id = self.mc_file.run_number

            # Reading event data
            event_data = self.mc_file.get_mono_event_data(event_i)

            # Event counter
            data.count = counter

            # Setting up the R0 container
            data.r0.obs_id = obs_id
            data.r0.event_id = event_id
            data.r0.tel.clear()

            # Setting up the R1 container
            data.r1.obs_id = obs_id
            data.r1.event_id = event_id
            data.r1.tel.clear()

            # Setting up the DL0 container
            data.dl0.obs_id = obs_id
            data.dl0.event_id = event_id
            data.dl0.tel.clear()

            # Setting up the MC container
            data.mc.tel.clear()

            # Creating the telescope pointing container
            pointing = TelescopePointingContainer()
            pointing.azimuth = np.deg2rad(event_data['pointing_az']) * u.rad
            pointing.altitude = np.deg2rad(90 - event_data['pointing_zd']) * u.rad

            # Adding the pointing container to the event data
            data.pointing[self.mc_file.telescope] = pointing

            # Adding event charge and peak positions per pixel
            data.dl1.tel[self.mc_file.telescope].image = event_data['image']
            data.dl1.tel[self.mc_file.telescope].pulse_time = event_data['pulse_time']

            # Setting the telescopes with data
            data.r0.tels_with_data = tels_with_data
            data.r1.tels_with_data = tels_with_data
            data.dl0.tels_with_data = tels_with_data
            data.trig.tels_with_trigger = tels_with_data

            # mc = data.mc.tel[self.mc_file.telescope]
            # mc.dc_to_pe = array_event['laser_calibrations'][tel_id]['calib']
            # mc.pedestal = array_event['camera_monitorings'][tel_id]['pedestal']
            # mc.reference_pulse_shape = pixel_settings['ref_shape'].astype('float64')
            # mc.meta['refstep'] = float(pixel_settings['ref_step'])
            # mc.time_slice = float(pixel_settings['time_slice'])
            # mc.photo_electron_image = (
            #     array_event
            #         .get('photoelectrons', {})
            #         .get(tel_index, {})
            #         .get('photoelectrons', np.zeros(n_pixel, dtype='float32'))
            # )

            data.mc.energy = event_data['true_energy'] * u.GeV
            data.mc.alt = (90 - event_data['true_zd']) * u.deg
            data.mc.az = event_data['true_az'] * u.deg
820
821
822
823
            data.mc.shower_primary_id = 1 - event_data['true_shower_primary_id']
            data.mc.h_first_int = event_data['true_h_first_int'] * u.m
            data.mc.core_x = event_data['true_core_x'] * u.cm
            data.mc.core_y = event_data['true_core_y'] * u.cm
824
825
826
827
828
829
830

            yield data
            counter += 1

        return


831
832
833
834
835
class MarsDataRun:
    """
    This class implements reading of the event data from a single MAGIC data run.
    """

836
    def __init__(self, run_file_mask, filter_list=None):
837
838
839
840
841
842
843
844
845
        """
        Constructor of the class. Defines the run to use and the camera pixel arrangement.

        Parameters
        ----------
        run_file_mask: str
            A path mask for files belonging to the run. Must correspond to a single run
            or an exception will be raised. Must correspond to calibrated ("sorcerer"-level)
            data.
846
847
848
        filter_list: list, optional
            A list of files, to which the run_file_mask should be applied. If None, all the
            files satisfying run_file_mask will be used. Defaults to None.
849
850
851
852
853
854
        """

        self.run_file_mask = run_file_mask

        # Preparing the lists of M1/2 data files
        file_list = glob.glob(run_file_mask)
855
856
857
858
859

        # Filtering out extra files if necessary
        if filter_list is not None:
            file_list = list(set(file_list) & set(filter_list))

860
861
        self.m1_file_list = list(filter(lambda name: '_M1_' in name, file_list))
        self.m2_file_list = list(filter(lambda name: '_M2_' in name, file_list))
862
        self.m1_file_list.sort()
863
864
865
866
        self.m2_file_list.sort()

        # Retrieving the list of run numbers corresponding to the data files
        run_numbers = list(map(self._get_run_number, file_list))
867
        run_numbers = scipy.unique(run_numbers)
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884

        # Checking if a single run is going to be read
        if len(run_numbers) > 1:
            raise ValueError("Run mask corresponds to more than one run: {}".format(run_numbers))

        # Reading the event data
        self.event_data = dict()
        self.event_data['M1'] = self.load_events(self.m1_file_list)
        self.event_data['M2'] = self.load_events(self.m2_file_list)

        # Detecting pedestal events
        self.pedestal_ids = self._find_pedestal_events()
        # Detecting stereo events
        self.stereo_ids = self._find_stereo_events()
        # Detecting mono events
        self.mono_ids = self._find_mono_events()

885
886
        self.n_camera_pixels = 1039

887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
    @property
    def n_events_m1(self):
        return len(self.event_data['M1']['MJD'])

    @property
    def n_events_m2(self):
        return len(self.event_data['M2']['MJD'])

    @property
    def n_stereo_events(self):
        return len(self.stereo_ids)

    @property
    def n_mono_events_m1(self):
        return len(self.mono_ids['M1'])

    @property
    def n_mono_events_m2(self):
        return len(self.mono_ids['M2'])

    @property
    def n_pedestal_events_m1(self):
        return len(self.pedestal_ids['M1'])

    @property
    def n_pedestal_events_m2(self):
        return len(self.pedestal_ids['M2'])

    @staticmethod
    def _get_run_number(file_name):
        """
        This internal method extracts the run number from
        a specified file name.

        Parameters
        ----------
        file_name: str
            A file name to process.

        Returns
        -------
        int:
            A run number of the file.
        """

932
        mask = r".*\d+_M\d+_(\d+)\.\d+_.*"
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
        parsed_info = re.findall(mask, file_name)

        run_number = int(parsed_info[0])

        return run_number

    @staticmethod
    def load_events(file_list):
        """
        This method loads events from the pre-defiled file and returns them as a dictionary.

        Parameters
        ----------
        file_name: str
            Name of the MAGIC calibrated file to use.

        Returns
        -------
        dict:
            A dictionary with the even properties: charge / arrival time data, trigger, direction etc.
        """

        try:
            import uproot
        except ImportError:
            msg = "The `uproot` python module is required to access the MAGIC data"
            raise ImportError(msg)

        event_data = dict()

        event_data['charge'] = []
        event_data['arrival_time'] = []
965
966
967
968
969
970
971
        event_data['trigger_pattern'] = scipy.array([])
        event_data['stereo_event_number'] = scipy.array([])
        event_data['pointing_zd'] = scipy.array([])
        event_data['pointing_az'] = scipy.array([])
        event_data['pointing_ra'] = scipy.array([])
        event_data['pointing_dec'] = scipy.array([])
        event_data['MJD'] = scipy.array([])
972
973
974
975
        event_data['air_pressure'] = scipy.array([])
        event_data['air_humidity'] = scipy.array([])
        event_data['air_temperature'] = scipy.array([])
        event_data['badpixelinfo'] = []
Moritz Huetten's avatar
Moritz Huetten committed
976
        event_data['mars_meta'] = []
977
978

        # run-wise meta information (same for all events)
Moritz Huetten's avatar
Moritz Huetten committed
979
        mars_meta = dict()
980
        
981
982
        event_data['file_edges'] = [0]

983
984
985
986
        degrees_per_hour = 15.0
        seconds_per_day = 86400.0
        seconds_per_hour = 3600.

987
988
989
990
991
992
        array_list = ['MCerPhotEvt.fPixels.fPhot', 'MArrivalTime.fData',
                      'MTriggerPattern.fPrescaled',
                      'MRawEvtHeader.fStereoEvtNumber', 'MRawEvtHeader.fDAQEvtNumber',
                      'MTime.fMjd', 'MTime.fTime.fMilliSec', 'MTime.fNanoSec'
                      ]

993
994
995
996
997
998
        pointing_array_list = ['MPointingPos.fZd', 'MPointingPos.fAz', 'MPointingPos.fRa', 
                               'MPointingPos.fDec', 'MPointingPos.fDevZd',
                               'MPointingPos.fDevAz',  'MPointingPos.fDevHa', 
                               'MPointingPos.fDevDec',
                               ]
        
999
        drive_array_list = ['MReportDrive.fMjd', 'MReportDrive.fCurrentZd', 'MReportDrive.fCurrentAz',
1000
                            'MReportDrive.fRa', 'MReportDrive.fDec'