__init__.py 64.2 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
Moritz Huetten's avatar
Moritz Huetten committed
15
16
from ctapipe.core import Container, Field
from ctapipe.io.containers import DataContainer, EventAndMonDataContainer, TelescopePointingContainer, MonitoringCameraContainer
17
18
19
20
from ctapipe.instrument import TelescopeDescription, SubarrayDescription, OpticsDescription, CameraGeometry

__all__ = ['MAGICEventSource']

Moritz Huetten's avatar
Moritz Huetten committed
21
logger = logging.getLogger(__name__)
22

Ievgen Vovk's avatar
Ievgen Vovk committed
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
58
59
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

60
        self.file_list = glob.glob(kwargs['input_url'])
61
62
        if len(self.file_list) == 0:
            raise ValueError("Unreadable or wrong wildcard file path given.")
63
        self.file_list.sort()
64
65
66
67
68

        # 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']
69
        super().__init__(input_url=self.file_list[0], **kwargs)
70
71

        # Retrieving the list of run numbers corresponding to the data files
Moritz Huetten's avatar
Moritz Huetten committed
72
73
        run_info = list(map(self._get_run_info_from_name, self.file_list))
        run_numbers = [i[0] for i in run_info]
74
        is_mc_runs = [i[1] for i in run_info]
Moritz Huetten's avatar
Moritz Huetten committed
75
76

        self.run_numbers, indices = np.unique(run_numbers, return_index=True)
77
78
79
80
81
82
        is_mc_runs = [is_mc_runs[i] for i in indices]
        is_mc_runs = np.unique(is_mc_runs)
        # Checking if runt type (data/MC) is consistent:
        if len(is_mc_runs) > 1:
            raise ValueError("Loaded files contain data and MC runs. Please load only data OR Monte Carlos.")
        self.is_mc = is_mc_runs[0]
83
84
85
86
87
88
89
90
91
92
93
94
95

        # # 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')
96
        self.magic_tel_description = TelescopeDescription(name='MAGIC', tel_type='MAGIC', optics=optics, camera=geom)
97
        self.magic_tel_descriptions = {1: self.magic_tel_description, 2: self.magic_tel_description}
98
        self._subarray_info = SubarrayDescription('MAGIC', self.magic_tel_positions, self.magic_tel_descriptions)
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
124
125
126
127
128
129
130
131
132
133
134
135
136

    @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
137
                if re.match(r'.+_m\d_.+root', file_path.lower()) is None:
138
139
140
141
142
                    is_magic_root_file = False

        return is_magic_root_file

    @staticmethod
Moritz Huetten's avatar
Moritz Huetten committed
143
    def _get_run_info_from_name(file_name):
144
        """
Moritz Huetten's avatar
Moritz Huetten committed
145
146
        This internal method extracts the run number and 
        type (data/MC) from the specified file name.
147
148
149
150
151
152
153
154
155
156
157
158

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

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

Moritz Huetten's avatar
Moritz Huetten committed
159
        mask_data = r".*\d+_M\d+_(\d+)\.\d+_Y_.*"
Moritz Huetten's avatar
Moritz Huetten committed
160
161
162
163
164
165
166
167
168
169
170
        mask_mc = r".*_M\d_za\d+to\d+_\d_(\d+)_Y_.*"
        mask_mc_alt = r".*_M\d_\d_(\d+)_.*"
        if len(re.findall(mask_data, file_name)) > 0:
            parsed_info = re.findall(mask_data, file_name)
            is_mc = False
        elif len(re.findall(mask_mc, file_name)) > 0:
            parsed_info = re.findall(mask_mc, file_name)
            is_mc = True
        else:
            parsed_info = re.findall(mask_mc_alt, file_name)
            is_mc = True
171
172
173
174

        try:
            run_number = int(parsed_info[0])
        except IndexError:
Moritz Huetten's avatar
Moritz Huetten committed
175
            raise IndexError('Can not identify the run number and type (data/MC) of the file {:s}'.format(file_name))
176

Moritz Huetten's avatar
Moritz Huetten committed
177
        return run_number, is_mc
178

Moritz Huetten's avatar
Moritz Huetten committed
179
    def _set_active_run(self, run_number):
180
181
182
183
184
185
186
187
188
189
        """
        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
190
        MarsRun:
Moritz Huetten's avatar
Moritz Huetten committed
191
            The run to use
192
193
194
195
196
197
198
199
        """

        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
Moritz Huetten's avatar
Moritz Huetten committed
200
        run['data'] = MarsRun(run_file_mask=this_run_mask, filter_list=self.file_list)
201
202
203

        return run

204
205
206
207
    @property
    def subarray(self):
        return self._subarray_info

208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
    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
233
234
235
236
        if not self.is_mc:
            data = EventAndMonDataContainer()
        else:
            data = DataContainer()
237
238
239
240
241
242

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

        # Loop over the available data runs
243
        for run_number in self.run_numbers:
244
245
246
247
248
249

            # 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
250
            # Setting the new active run (class MarsRun object)
Moritz Huetten's avatar
Moritz Huetten committed
251
            self.current_run = self._set_active_run(run_number)
252

253
254
            # Set monitoring data:
            if not self.is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
255

256
                monitoring_data = self.current_run['data'].monitoring_data
Moritz Huetten's avatar
Moritz Huetten committed
257

258
259
260
                for tel_i, tel_id in enumerate(tels_in_file):
                    monitoring_camera = MonitoringCameraContainer()
                    pedestal_info = PedestalContainer()
261
                    badpixel_info = PixelStatusContainer()
Moritz Huetten's avatar
Moritz Huetten committed
262

263
264
265
266
267
268
269
270
271
272
273
                    time_tmp = Time(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalMJD'], scale='utc', format='mjd')
                    pedestal_info.sample_time = Time(time_tmp, format='unix', scale='utc', precision=9)
                    pedestal_info.n_events = 500 # hardcoded number of pedestal events averaged over
                    pedestal_info.charge_mean = []
                    pedestal_info.charge_mean.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFundamental']['Mean'])
                    pedestal_info.charge_mean.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFromExtractor']['Mean'])
                    pedestal_info.charge_mean.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFromExtractorRndm']['Mean'])
                    pedestal_info.charge_std = []
                    pedestal_info.charge_std.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFundamental']['Rms'])
                    pedestal_info.charge_std.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFromExtractor']['Rms'])
                    pedestal_info.charge_std.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFromExtractorRndm']['Rms'])
Moritz Huetten's avatar
Moritz Huetten committed
274

Moritz Huetten's avatar
Moritz Huetten committed
275
276
                    t_range = Time(monitoring_data['M{:d}'.format(tel_i + 1)]['badpixelinfoMJDrange'], scale='utc', format='mjd')

277
                    badpixel_info.hardware_failing_pixels = monitoring_data['M{:d}'.format(tel_i + 1)]['badpixelinfo']
Moritz Huetten's avatar
Moritz Huetten committed
278
                    badpixel_info.sample_time_range = t_range
279

280
                    monitoring_camera.pedestal = pedestal_info
281
                    monitoring_camera.pixel_status = badpixel_info
282
283

                    data.mon.tels_with_data = {1, 2}
284
285
                    data.mon.tel[tel_i + 1] = monitoring_camera

286
287
288
289
290
291
292
293
294
            # 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
295
                
296
                data.meta = event_data['mars_meta']
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319

                # 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()
320
321
322
323
                    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
324
325
326
327
328
329

                    # 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
330
                    data.dl1.tel[tel_i + 1].pulse_time = event_data['{:s}_pulse_time'.format(tel_id)]
Moritz Huetten's avatar
Moritz Huetten committed
331

332
                if self.is_mc == False:
Moritz Huetten's avatar
Moritz Huetten committed
333
334
335
336
337
                    # 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)
                else:
                    data.mc.energy = event_data['true_energy'] * u.GeV
338
                    data.mc.alt = (np.pi/2 - event_data['true_zd']) * u.rad
339
                    data.mc.az = -1 * (event_data['true_az'] - np.deg2rad(180 - 7)) * u.rad # check meaning of 7deg transformation (I.Vovk)
Moritz Huetten's avatar
Moritz Huetten committed
340
341
342
343
                    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
344
345
346
347
348
349

                # 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
350
                
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375

                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
Moritz Huetten's avatar
Moritz Huetten committed
376
377
378
379
        if not self.is_mc:
            data = EventAndMonDataContainer()
        else:
            data = DataContainer()
380
381
382
383
384
385
386
387
388
389
390

        # 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
391
        for run_number in self.run_numbers:
392
393
394
395
396
397
398

            # 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
Moritz Huetten's avatar
Moritz Huetten committed
399
            self.current_run = self._set_active_run(run_number)
400

Moritz Huetten's avatar
Moritz Huetten committed
401
402
            # Set monitoring data:
            if not self.is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
403

Moritz Huetten's avatar
Moritz Huetten committed
404
                monitoring_data = self.current_run['data'].monitoring_data
Moritz Huetten's avatar
Moritz Huetten committed
405

Moritz Huetten's avatar
Moritz Huetten committed
406
407
408
                monitoring_camera = MonitoringCameraContainer()
                pedestal_info = PedestalContainer()
                badpixel_info = PixelStatusContainer()
Moritz Huetten's avatar
Moritz Huetten committed
409

Moritz Huetten's avatar
Moritz Huetten committed
410
411
412
413
414
415
416
417
418
419
420
                time_tmp = Time(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalMJD'], scale='utc', format='mjd')
                pedestal_info.sample_time = Time(time_tmp, format='unix', scale='utc', precision=9)
                pedestal_info.n_events = 500 # hardcoded number of pedestal events averaged over
                pedestal_info.charge_mean = []
                pedestal_info.charge_mean.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFundamental']['Mean'])
                pedestal_info.charge_mean.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFromExtractor']['Mean'])
                pedestal_info.charge_mean.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFromExtractorRndm']['Mean'])
                pedestal_info.charge_std = []
                pedestal_info.charge_std.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFundamental']['Rms'])
                pedestal_info.charge_std.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFromExtractor']['Rms'])
                pedestal_info.charge_std.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFromExtractorRndm']['Rms'])
Moritz Huetten's avatar
Moritz Huetten committed
421

Moritz Huetten's avatar
Moritz Huetten committed
422
423
424
425
                t_range = Time(monitoring_data['M{:d}'.format(tel_i + 1)]['badpixelinfoMJDrange'], scale='utc', format='mjd')

                badpixel_info.hardware_failing_pixels = monitoring_data['M{:d}'.format(tel_i + 1)]['badpixelinfo']
                badpixel_info.sample_time_range = t_range
Moritz Huetten's avatar
Moritz Huetten committed
426

Moritz Huetten's avatar
Moritz Huetten committed
427
428
429
430
431
432
                monitoring_camera.pedestal = pedestal_info
                monitoring_camera.pixel_status = badpixel_info

                data.mon.tels_with_data = tels_with_data
                data.mon.tel[tel_i + 1] = monitoring_camera

433
434
435
436
437
438
439
440
441
442
443
444
445
446
            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
447
                
448
                data.meta = event_data['mars_meta']
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479

                # 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
480
                data.dl1.tel[tel_i + 1].pulse_time = event_data['pulse_time']
481

482
                if self.is_mc == False:
Moritz Huetten's avatar
Moritz Huetten committed
483
484
485
486
487
                    # 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)
                else:
                    data.mc.energy = event_data['true_energy'] * u.GeV
488
                    data.mc.alt = (np.pi/2 - event_data['true_zd']) * u.rad
489
                    data.mc.az = -1 * (event_data['true_az'] - np.deg2rad(180 - 7)) * u.rad # check meaning of 7deg transformation (I.Vovk)
Moritz Huetten's avatar
Moritz Huetten committed
490
491
492
493
                    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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524

                # 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

                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
Moritz Huetten's avatar
Moritz Huetten committed
525
        data = EventAndMonDataContainer()
526
527
528
529
530
531
532
533
534
535
536

        # 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
537
        for run_number in self.run_numbers:
538
539
540
541
542
543
544

            # 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
Moritz Huetten's avatar
Moritz Huetten committed
545
            self.current_run = self._set_active_run(run_number)
546

Moritz Huetten's avatar
Moritz Huetten committed
547
            monitoring_data = self.current_run['data'].monitoring_data
Moritz Huetten's avatar
Moritz Huetten committed
548

Moritz Huetten's avatar
Moritz Huetten committed
549
550
551
            monitoring_camera = MonitoringCameraContainer()
            pedestal_info = PedestalContainer()
            badpixel_info = PixelStatusContainer()
Moritz Huetten's avatar
Moritz Huetten committed
552

Moritz Huetten's avatar
Moritz Huetten committed
553
554
555
556
557
558
559
560
561
562
563
            time_tmp = Time(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalMJD'], scale='utc', format='mjd')
            pedestal_info.sample_time = Time(time_tmp, format='unix', scale='utc', precision=9)
            pedestal_info.n_events = 500 # hardcoded number of pedestal events averaged over
            pedestal_info.charge_mean = []
            pedestal_info.charge_mean.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFundamental']['Mean'])
            pedestal_info.charge_mean.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFromExtractor']['Mean'])
            pedestal_info.charge_mean.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFromExtractorRndm']['Mean'])
            pedestal_info.charge_std = []
            pedestal_info.charge_std.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFundamental']['Rms'])
            pedestal_info.charge_std.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFromExtractor']['Rms'])
            pedestal_info.charge_std.append(monitoring_data['M{:d}'.format(tel_i + 1)]['PedestalFromExtractorRndm']['Rms'])
Moritz Huetten's avatar
Moritz Huetten committed
564

Moritz Huetten's avatar
Moritz Huetten committed
565
566
567
568
            t_range = Time(monitoring_data['M{:d}'.format(tel_i + 1)]['badpixelinfoMJDrange'], scale='utc', format='mjd')

            badpixel_info.hardware_failing_pixels = monitoring_data['M{:d}'.format(tel_i + 1)]['badpixelinfo']
            badpixel_info.sample_time_range = t_range
Moritz Huetten's avatar
Moritz Huetten committed
569

Moritz Huetten's avatar
Moritz Huetten committed
570
571
572
573
574
575
            monitoring_camera.pedestal = pedestal_info
            monitoring_camera.pixel_status = badpixel_info

            data.mon.tels_with_data = tels_with_data
            data.mon.tel[tel_i + 1] = monitoring_camera

576
577
578
579
580
581
582
583
584
585
586
587
588
589
            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
590
                
591
                data.meta = event_data['mars_meta']
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
622

                # 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
623
                data.dl1.tel[tel_i + 1].pulse_time = event_data['pulse_time']
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640

                # 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

                yield data
                counter += 1

        return


Moritz Huetten's avatar
Moritz Huetten committed
641
class MarsRun:
642
643
644
645
    """
    This class implements reading of the event data from a single MAGIC data run.
    """

Moritz Huetten's avatar
Moritz Huetten committed
646
    def __init__(self, run_file_mask, filter_list=None):
647
648
649
650
651
652
653
654
655
        """
        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.
656
657
658
        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.
659
660
        """

661
662
        geom = CameraGeometry.from_name('MAGICCam')
        self.n_camera_pixels = geom.n_pixels
663

664
665
666
667
        self.run_file_mask = run_file_mask

        # Preparing the lists of M1/2 data files
        file_list = glob.glob(run_file_mask)
668
669
670
671
672

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

673
674
        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))
675
        self.m1_file_list.sort()
676
677
678
        self.m2_file_list.sort()

        # Retrieving the list of run numbers corresponding to the data files
Moritz Huetten's avatar
Moritz Huetten committed
679
680
        run_info = list(map(MAGICEventSource._get_run_info_from_name, file_list))
        run_numbers = [i[0] for i in run_info]
681
682
683
684
685
686
687
688
689
        is_mc_runs   = [i[1] for i in run_info]

        run_numbers = np.unique(run_numbers)
        is_mc_runs = np.unique(is_mc_runs)
        # Checking if runt type (data/MC) is consistent:
        if len(is_mc_runs) > 1:
            raise ValueError("Run type is not consistently data or MC: {}".format(is_mc))
        
        self.is_mc = is_mc_runs[0]
690
691
692
693
694

        # 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))

695
696
697
698
699
        # Reading the data
        m1_data = self.load_events(self.m1_file_list, self.is_mc, self.n_camera_pixels)
        m2_data = self.load_events(self.m2_file_list, self.is_mc, self.n_camera_pixels)
        
        # Getting the event data
700
        self.event_data = dict()
701
702
703
704
705
706
707
        self.event_data['M1'] = m1_data[0]
        self.event_data['M2'] = m2_data[0]

        # Getting the monitoring data
        self.monitoring_data = dict()
        self.monitoring_data['M1'] = m1_data[1]
        self.monitoring_data['M2'] = m2_data[1]
708
709
710
711
712
713
714
715

        # 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()

716

717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
    @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
746
    def load_events(file_list, is_mc, n_camera_pixels):
747
        """
748
        This method loads events and monitoring data from the pre-defiled file and returns them as a dictionary.
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770

        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'] = []
771
772
773
774
775
776
777
        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([])
Moritz Huetten's avatar
Moritz Huetten committed
778
        event_data['mars_meta'] = []
779

780
781
        # monitoring information (updated from time to time)
        monitoring_data = dict()
782
        
Moritz Huetten's avatar
Moritz Huetten committed
783
784
        monitoring_data['badpixelinfo'] = []
        monitoring_data['badpixelinfoMJDrange'] = []
785
786
787
788
789
790
791
792
793
794
795
        monitoring_data['PedestalMJD'] = scipy.array([])
        monitoring_data['PedestalFundamental'] = dict()
        monitoring_data['PedestalFundamental']['Mean'] = []
        monitoring_data['PedestalFundamental']['Rms'] = []
        monitoring_data['PedestalFromExtractor'] = dict()
        monitoring_data['PedestalFromExtractor']['Mean'] = []
        monitoring_data['PedestalFromExtractor']['Rms'] = []
        monitoring_data['PedestalFromExtractorRndm'] = dict()
        monitoring_data['PedestalFromExtractorRndm']['Mean'] = []
        monitoring_data['PedestalFromExtractorRndm']['Rms'] = []

796
797
        event_data['file_edges'] = [0]

798
799
800
801
        degrees_per_hour = 15.0
        seconds_per_day = 86400.0
        seconds_per_hour = 3600.

Moritz Huetten's avatar
Moritz Huetten committed
802
        evt_common_list = [
803
            'MCerPhotEvt.fPixels.fPhot', 
Moritz Huetten's avatar
Moritz Huetten committed
804
805
            'MArrivalTime.fData',
            'MTriggerPattern.fPrescaled',
806
            'MRawEvtHeader.fStereoEvtNumber', 
Moritz Huetten's avatar
Moritz Huetten committed
807
808
            'MRawEvtHeader.fDAQEvtNumber',
            ]
809
        
Moritz Huetten's avatar
Moritz Huetten committed
810
811
812
813
814
815
816
817
818
819
820
821
        # Separately, because only used with pre-processed MARS data 
        # to create MPointingPos container
        pointing_array_list = [
            'MPointingPos.fZd', 
            'MPointingPos.fAz', 
            'MPointingPos.fRa', 
            'MPointingPos.fDec', 
            'MPointingPos.fDevZd',
            'MPointingPos.fDevAz', 
            'MPointingPos.fDevHa', 
            'MPointingPos.fDevDec',
            ]
822
        
Moritz Huetten's avatar
Moritz Huetten committed
823
824
825
826
827
828
        # Info only applicable for data:
        time_array_list = [
            'MTime.fMjd',
            'MTime.fTime.fMilliSec',
            'MTime.fNanoSec', 
            ]
Moritz Huetten's avatar
Moritz Huetten committed
829
        
Moritz Huetten's avatar
Moritz Huetten committed
830
831
832
833
834
835
836
837
        drive_array_list = [
            'MReportDrive.fMjd',
            'MReportDrive.fCurrentZd',
            'MReportDrive.fCurrentAz',
            'MReportDrive.fRa',
            'MReportDrive.fDec'
            ]

838
839
840
841
842
843
844
845
846
847
848
849
        pedestal_array_list = [
            'MTimePedestals.fMjd',
            'MTimePedestals.fTime.fMilliSec',
            'MTimePedestals.fNanoSec',
            'MPedPhotFundamental.fArray.fMean',
            'MPedPhotFundamental.fArray.fRms',
            'MPedPhotFromExtractor.fArray.fMean',
            'MPedPhotFromExtractor.fArray.fRms',
            'MPedPhotFromExtractorRndm.fArray.fMean',
            'MPedPhotFromExtractorRndm.fArray.fRms'
            ]

Moritz Huetten's avatar
Moritz Huetten committed
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
        # Info only applicable for MC:
        mc_list = [
            'MMcEvt.fEnergy',
            'MMcEvt.fTheta',
            'MMcEvt.fPhi',
            'MMcEvt.fPartId',
            'MMcEvt.fZFirstInteraction',
            'MMcEvt.fCoreX',
            'MMcEvt.fCoreY', 
            ]

        # Metadata, currently not strictly required
        metainfo_array_list = [
            'MRawRunHeader.fRunNumber',
            'MRawRunHeader.fRunType',
            'MRawRunHeader.fSubRunIndex',
            'MRawRunHeader.fSourceRA',
            'MRawRunHeader.fSourceDEC',
            'MRawRunHeader.fTelescopeNumber']
869

870
871
872
873
        for file_name in file_list:

            input_file = uproot.open(file_name)

Moritz Huetten's avatar
Moritz Huetten committed
874
            events = input_file['Events'].arrays(evt_common_list)
875

876
            # Reading the info common to MC and real data
877
878
879
880
            charge = events[b'MCerPhotEvt.fPixels.fPhot']
            arrival_time = events[b'MArrivalTime.fData']
            trigger_pattern = events[b'MTriggerPattern.fPrescaled']
            stereo_event_number = events[b'MRawEvtHeader.fStereoEvtNumber']
881

Moritz Huetten's avatar
Moritz Huetten committed
882
883
            # Reading run-wise meta information (same for all events in subrun):
            mars_meta = dict()
Moritz Huetten's avatar
Moritz Huetten committed
884

Moritz Huetten's avatar
Moritz Huetten committed
885
            mars_meta['is_simulation'] = is_mc
Moritz Huetten's avatar
Moritz Huetten committed
886

Moritz Huetten's avatar
Moritz Huetten committed
887
888
889
890
891
892
893
894
            # Reading event timing information:
            if not is_mc:
                event_times = input_file['Events'].arrays(time_array_list)
                # Computing the event arrival time
                
                event_mjd = event_times[b'MTime.fMjd']
                event_millisec = event_times[b'MTime.fTime.fMilliSec']
                event_nanosec = event_times[b'MTime.fNanoSec']
Moritz Huetten's avatar
Moritz Huetten committed
895

Moritz Huetten's avatar
Moritz Huetten committed
896
897
898
                event_mjd = event_mjd + (event_millisec / 1e3 + event_nanosec / 1e9) / seconds_per_day
                event_data['MJD'] = scipy.concatenate((event_data['MJD'], event_mjd))

Moritz Huetten's avatar
Moritz Huetten committed
899
            # try to read RunHeaders tree (soft fail if not present, to pass current tests)
Moritz Huetten's avatar
Moritz Huetten committed
900
901
902
903
904
            try:
                meta_info = input_file['RunHeaders'].arrays(metainfo_array_list)
                
                mars_meta['origin'] = "MAGIC"
                mars_meta['input_url'] = file_name
Moritz Huetten's avatar
Moritz Huetten committed
905

Moritz Huetten's avatar
Moritz Huetten committed
906
                mars_meta['number'] = int(meta_info[b'MRawRunHeader.fRunNumber'][0])
Moritz Huetten's avatar
Moritz Huetten committed
907
                mars_meta['number_subrun'] = int(meta_info[b'MRawRunHeader.fSubRunIndex'][0])
Moritz Huetten's avatar
Moritz Huetten committed
908
909
                mars_meta['source_ra'] = meta_info[b'MRawRunHeader.fSourceRA'][0] / seconds_per_hour * degrees_per_hour * u.deg
                mars_meta['source_dec'] = meta_info[b'MRawRunHeader.fSourceDEC'][0] / seconds_per_hour * u.deg
Moritz Huetten's avatar
Moritz Huetten committed
910
911
912
913
914
915

                is_mc_check = int(meta_info[b'MRawRunHeader.fRunType'][0])
                if is_mc_check == 0:
                    is_mc_check = False
                elif is_mc_check == 256:
                    is_mc_check = True
Moritz Huetten's avatar
Moritz Huetten committed
916
917
                else:
                    msg = "Run type (Data or MC) of MAGIC data file not recognised."
Moritz Huetten's avatar
Moritz Huetten committed
918
919
                    logger.error(msg)
                    raise ValueError(msg)
Moritz Huetten's avatar
Moritz Huetten committed
920
                if is_mc_check != is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
921
                    msg = "Inconsistent run type (data or MC) between file name and runheader content."
Moritz Huetten's avatar
Moritz Huetten committed
922
923
                    logger.error(msg)
                    raise ValueError(msg)
Moritz Huetten's avatar
Moritz Huetten committed
924

Moritz Huetten's avatar
Moritz Huetten committed
925
                # Reading the info only contained in real data
Moritz Huetten's avatar
Moritz Huetten committed
926
                if not is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
927
                    badpixelinfo = input_file['RunHeaders']['MBadPixelsCam.fArray.fInfo'].array(uproot.asjagged(uproot.asdtype(np.int32))).flatten().reshape((4, 1183), order='F')
Moritz Huetten's avatar
Moritz Huetten committed
928
929
                    # now we have 4 axes:
                    # 0st axis: empty (?)
Moritz Huetten's avatar
Moritz Huetten committed
930
931
932
933
                    # 1st axis: Unsuitable pixels
                    # 2nd axis: Uncalibrated pixels (says why pixel is unsuitable)
                    # 3rd axis: Bad hardware pixels (says why pixel is unsuitable)
                    # Each axis cointains a 32bit integer encoding more information about the specific problem, see MARS software, MBADPixelsPix.h
Moritz Huetten's avatar
Moritz Huetten committed
934
                    unsuitable_pix_bitinfo = badpixelinfo[1][:n_camera_pixels] # take first axis
Moritz Huetten's avatar
Moritz Huetten committed
935
                    # extract unsuitable bit:
936
937
938
939
940
                    unsuitable_evt = np.zeros(n_camera_pixels, dtype = np.bool)
                    unsuitable_run = np.zeros(n_camera_pixels, dtype = np.bool)
                    unsuitable_dt = np.zeros(n_camera_pixels, dtype = np.bool)
                    unsuitable_dc = np.zeros(n_camera_pixels, dtype = np.bool)
                    unsuitable_hv = np.zeros(n_camera_pixels, dtype = np.bool)
Moritz Huetten's avatar
Moritz Huetten committed
941
                    for i in range(n_camera_pixels):
942
943
944
945
946
947
                        unsuitable_run[i] = int('\t{0:08b}'.format(unsuitable_pix_bitinfo[i]&0xff)[-1])
                        unsuitable_evt[i] = int('\t{0:08b}'.format(unsuitable_pix_bitinfo[i]&0xff)[-2])
                        unsuitable_dt[i] = int('\t{0:08b}'.format(unsuitable_pix_bitinfo[i]&0xff)[-4])
                        unsuitable_dc[i] = int('\t{0:08b}'.format(unsuitable_pix_bitinfo[i]&0xff)[-5])
                        unsuitable_hv[i] = int('\t{0:08b}'.format(unsuitable_pix_bitinfo[i]&0xff)[-3])
                    monitoring_data['badpixelinfo'].append(np.logical_or(np.logical_or(np.logical_or(np.logical_or(unsuitable_run, unsuitable_evt), unsuitable_dt),unsuitable_dc),unsuitable_hv))
Moritz Huetten's avatar
Moritz Huetten committed
948
949
                    # save time interval of badpixel info:
                    monitoring_data['badpixelinfoMJDrange'].append([event_mjd[0], event_mjd[-1]])
950

Moritz Huetten's avatar
Moritz Huetten committed
951
            except KeyError:
952
                logger.warning("RunHeaders tree not present in file. Cannot read meta information - will assume it is a real data run.")
Moritz Huetten's avatar
Moritz Huetten committed
953
                is_mc = False
954

955
            # try to read Pedestals tree (soft fail if not present)
Moritz Huetten's avatar
Moritz Huetten committed
956
            if not is_mc:
957
958
                try:
                    pedestal_info = input_file['Pedestals'].arrays(pedestal_array_list)
Moritz Huetten's avatar
Moritz Huetten committed
959

960
961
962
963
964
965
966
967
968
969
970
                    pedestal_mjd = pedestal_info[b'MTimePedestals.fMjd']
                    pedestal_millisec = pedestal_info[b'MTimePedestals.fTime.fMilliSec']
                    pedestal_nanosec = pedestal_info[b'MTimePedestals.fNanoSec']
                    n_pedestals = len(pedestal_mjd)
                    pedestal_mjd = pedestal_mjd + (pedestal_millisec / 1e3 + pedestal_nanosec / 1e9) / seconds_per_day
                    monitoring_data['PedestalMJD'] = scipy.concatenate((monitoring_data['PedestalMJD'], pedestal_mjd))
                    for quantity in ['Mean', 'Rms']:
                        for i_pedestal in range(n_pedestals):
                            monitoring_data['PedestalFundamental'][quantity].append(pedestal_info['MPedPhotFundamental.fArray.f{:s}'.format(quantity).encode()][i_pedestal][:n_camera_pixels])
                            monitoring_data['PedestalFromExtractor'][quantity].append(pedestal_info['MPedPhotFromExtractor.fArray.f{:s}'.format(quantity).encode()][i_pedestal][:n_camera_pixels])
                            monitoring_data['PedestalFromExtractorRndm'][quantity].append(pedestal_info['MPedPhotFromExtractorRndm.fArray.f{:s}'.format(quantity).encode()][i_pedestal][:n_camera_pixels])
Moritz Huetten's avatar
Moritz Huetten committed
971

972
                except KeyError:
Moritz Huetten's avatar
Moritz Huetten committed
973
                    logger.warning("Pedestals tree not present in file. Cleaning algorithm may fail.")
974

975
            # Reading pointing information (in units of degrees):
976
977
            if 'MPointingPos.' in input_file['Events']:
                # Retrieving the telescope pointing direction
978
979
                pointing = input_file['Events'].arrays(pointing_array_list)

980
981
982
983
                pointing_zd = pointing[b'MPointingPos.fZd'] - pointing[b'MPointingPos.fDevZd']
                pointing_az = pointing[b'MPointingPos.fAz'] - pointing[b'MPointingPos.fDevAz']
                pointing_ra = (pointing[b'MPointingPos.fRa'] + pointing[b'MPointingPos.fDevHa']) * degrees_per_hour # N.B. the positive sign here, as HA = local sidereal time - ra
                pointing_dec = pointing[b'MPointingPos.fDec'] - pointing[b'MPointingPos.fDevDec']
984
985
            else:
                # Getting the telescope drive info
986
987
988
989
990
                drive = input_file['Drive'].arrays(drive_array_list)

                drive_mjd = drive[b'MReportDrive.fMjd']
                drive_zd = drive[b'MReportDrive.fCurrentZd']
                drive_az = drive[b'MReportDrive.fCurrentAz']
991
                drive_ra = drive[b'MReportDrive.fRa'] * degrees_per_hour
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
                drive_dec = drive[b'MReportDrive.fDec']

                # Finding only non-repeating drive entries
                # Repeating entries lead to failure in pointing interpolation
                non_repeating = scipy.diff(drive_mjd) > 0
                non_repeating = scipy.concatenate((non_repeating, [True]))

                # Filtering out the repeating ones
                drive_mjd = drive_mjd[non_repeating]
                drive_zd = drive_zd[non_repeating]
                drive_az = drive_az[non_repeating]
                drive_ra = drive_ra[non_repeating]
                drive_dec = drive_dec[non_repeating]

                if len(drive_zd) > 2:
                    # If there are enough drive data, creating azimuth and zenith angles interpolators
                    drive_zd_pointing_interpolator = scipy.interpolate.interp1d(drive_mjd, drive_zd, fill_value="extrapolate")
                    drive_az_pointing_interpolator = scipy.interpolate.interp1d(drive_mjd, drive_az, fill_value="extrapolate")

                    # Creating azimuth and zenith angles interpolators
                    drive_ra_pointing_interpolator = scipy.interpolate.interp1d(drive_mjd, drive_ra, fill_value="extrapolate")
                    drive_dec_pointing_interpolator = scipy.interpolate.interp1d(drive_mjd, drive_dec, fill_value="extrapolate")

                    # Interpolating the drive pointing to the event time stamps
1016
1017
1018
1019
                    pointing_zd = drive_zd_pointing_interpolator(event_mjd)
                    pointing_az = drive_az_pointing_interpolator(event_mjd)
                    pointing_ra = drive_ra_pointing_interpolator(event_mjd)
                    pointing_dec = drive_dec_pointing_interpolator(event_mjd)
1020
1021
1022

                else:
                    # Not enough data to interpolate the pointing direction.
1023
1024
1025
1026
                    pointing_zd = scipy.repeat(-1, len(event_mjd))
                    pointing_az = scipy.repeat(-1, len(event_mjd))
                    pointing_ra = scipy.repeat(-1, len(event_mjd))
                    pointing_dec = scipy.repeat(-1, len(event_mjd))
1027
1028
1029

            event_data['charge'].append(charge)
            event_data['arrival_time'].append(arrival_time)
Moritz Huetten's avatar
Moritz Huetten committed
1030
            event_data['mars_meta'].append(mars_meta)
1031
            event_data['trigger_pattern'] = scipy.concatenate((event_data['trigger_pattern'], trigger_pattern))
1032
            event_data['stereo_event_number'] = scipy.concatenate((event_data['stereo_event_number'], stereo_event_number)).astype(dtype='int')
1033
1034
1035
1036
            event_data['pointing_zd'] = scipy.concatenate((event_data['pointing_zd'], pointing_zd))
            event_data['pointing_az'] = scipy.concatenate((event_data['pointing_az'], pointing_az))
            event_data['pointing_ra'] = scipy.concatenate((event_data['pointing_ra'], pointing_ra))
            event_data['pointing_dec'] = scipy.concatenate((event_data['pointing_dec'], pointing_dec))
1037
1038

            # Reading MC only information:
Moritz Huetten's avatar
Moritz Huetten committed
1039
            if is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
1040
                mc_info = input_file['Events'].arrays(mc_list)
Moritz Huetten's avatar
Moritz Huetten committed
1041
                # N.B.: For MC, there is only one subrun, so do not need to 'append'
Moritz Huetten's avatar
Moritz Huetten committed
1042
1043
1044
1045
1046
1047
1048
                event_data['true_energy'] = mc_info[b'MMcEvt.fEnergy']
                event_data['true_zd'] = mc_info[b'MMcEvt.fTheta']
                event_data['true_az'] = mc_info[b'MMcEvt.fPhi']
                event_data['true_shower_primary_id'] = mc_info[b'MMcEvt.fPartId']
                event_data['true_h_first_int'] = mc_info[b'MMcEvt.fZFirstInteraction']
                event_data['true_core_x'] = mc_info[b'MMcEvt.fCoreX']
                event_data['true_core_y'] = mc_info[b'MMcEvt.fCoreY']
1049
1050
1051

            event_data['file_edges'].append(len(event_data['trigger_pattern']))

Moritz Huetten's avatar
Moritz Huetten committed
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
        if not is_mc:
            try:
                monitoring_data['badpixelinfo'] = np.array(monitoring_data['badpixelinfo'])
                monitoring_data['badpixelinfoMJDrange'] = np.array(monitoring_data['badpixelinfoMJDrange'])
                # sort monitoring data:
                order = np.argsort(monitoring_data['PedestalMJD'])
                monitoring_data['PedestalMJD'] = monitoring_data['PedestalMJD'][order]
                
                for quantity in ['Mean', 'Rms']:
                    monitoring_data['PedestalFundamental'][quantity] = np.array(monitoring_data['PedestalFundamental'][quantity])
                    monitoring_data['PedestalFromExtractor'][quantity] = np.array(monitoring_data['PedestalFromExtractor'][quantity])
                    monitoring_data['PedestalFromExtractorRndm'][quantity] = np.array(monitoring_data['PedestalFromExtractorRndm'][quantity])
Moritz Huetten's avatar
Moritz Huetten committed
1064

Moritz Huetten's avatar
Moritz Huetten committed
1065
1066
            except:
                pass
Moritz Huetten's avatar
Moritz Huetten committed
1067

1068
        return event_data, monitoring_data
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099

    def _find_pedestal_events(self):
        """
        This internal method identifies the IDs (order numbers) of the
        pedestal events in the run.

        Returns
        -------
        dict:
            A dictionary of pedestal event IDs in M1/2 separately.
        """

        pedestal_ids = dict()

        pedestal_trigger_pattern = 8

        for telescope in self.event_data:
            ped_triggers = np.where(self.event_data[telescope]['trigger_pattern'] == pedestal_trigger_pattern)
            pedestal_ids[telescope] = ped_triggers[0]

        return pedestal_ids

    def _find_stereo_events(self):
        """
        This internal methods identifies stereo events in the run.

        Returns
        -------
        list:
            A list of pairs (M1_id, M2_id) corresponding to stereo events in the run.
        """
1100
1101
1102
1103
1104

        stereo_ids = []

        n_m1_events = len(self.event_data['M1']['stereo_event_number'])
        n_m2_events = len(self.event_data['M2']['stereo_event_number'])
Ievgen Vovk's avatar
Ievgen Vovk committed
1105
        if (n_m1_events == 0) or (n_m2_events == 0):
1106
1107
            return stereo_ids

Ievgen Vovk's avatar
Ievgen Vovk committed
1108
        if not self.is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
1109
            data_trigger_pattern = 128
Ievgen Vovk's avatar
Ievgen Vovk committed
1110

Moritz Huetten's avatar
Moritz Huetten committed
1111
            m2_data_condition = (self.event_data['M2']['trigger_pattern'] == data_trigger_pattern)
Ievgen Vovk's avatar
Ievgen Vovk committed
1112

Moritz Huetten's avatar
Moritz Huetten committed
1113
1114
1115
1116
            for m1_id in range(0, n_m1_events):
                if self.event_data['M1']['trigger_pattern'][m1_id] == data_trigger_pattern:
                    m2_stereo_condition = (self.event_data['M2']['stereo_event_number'] ==
                                           self.event_data['M1']['stereo_event_number'][m1_id])
Ievgen Vovk's avatar
Ievgen Vovk committed
1117

Moritz Huetten's avatar
Moritz Huetten committed
1118
                    m12_match = np.where(m2_data_condition & m2_stereo_condition)
Ievgen Vovk's avatar
Ievgen Vovk committed
1119

Moritz Huetten's avatar
Moritz Huetten committed
1120
1121
1122
1123
1124
                    if len(m12_match[0]) > 0:
                        stereo_pair = (m1_id, m12_match[0][0])
                        stereo_ids.append(stereo_pair)
        else:
            data_trigger_pattern = 1
Ievgen Vovk's avatar
Ievgen Vovk committed
1125

Moritz Huetten's avatar
Moritz Huetten committed
1126
            m2_data_condition = (self.event_data['M2']['trigger_pattern'] == data_trigger_pattern)
Ievgen Vovk's avatar
Ievgen Vovk committed
1127

Moritz Huetten's avatar
Moritz Huetten committed
1128
1129
1130
1131
            for m1_id in range(0, n_m1_events):
                if self.event_data['M1']['trigger_pattern'][m1_id] == data_trigger_pattern and self.event_data['M1']['stereo_event_number'][m1_id] != 0:
                    m2_stereo_condition = (self.event_data['M2']['stereo_event_number'] ==
                                           self.event_data['M1']['stereo_event_number'][m1_id])
Ievgen Vovk's avatar
Ievgen Vovk committed
1132

Moritz Huetten's avatar
Moritz Huetten committed
1133
                    m12_match = np.where(m2_data_condition & m2_stereo_condition)
Ievgen Vovk's avatar
Ievgen Vovk committed
1134

Moritz Huetten's avatar
Moritz Huetten committed
1135
1136
1137
                    if len(m12_match[0]) > 0:
                        stereo_pair = (m1_id, m12_match[0][0])
                        stereo_ids.append(stereo_pair)
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154

        return stereo_ids

    def _find_mono_events(self):
        """
        This internal method identifies the IDs (order numbers) of the
        pedestal events in the run.

        Returns
        -------
        dict:
            A dictionary of pedestal event IDs in M1/2 separately.
        """

        mono_ids = dict()
        mono_ids['M1'] = []
        mono_ids['M2'] = []
Moritz Huetten's avatar
Moritz Huetten committed
1155
        
1156
1157
        n_m1_events = len(self.event_data['M1']['stereo_event_number'])
        n_m2_events = len(self.event_data['M2']['stereo_event_number'])
1158

Ievgen Vovk's avatar
Ievgen Vovk committed
1159
        if not self.is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
            data_trigger_pattern = 128
    
            m1_data_condition = self.event_data['M1']['trigger_pattern'] == data_trigger_pattern
            m2_data_condition = self.event_data['M2']['trigger_pattern'] == data_trigger_pattern
    
            for m1_id in range(0, n_m1_events):
                if m1_data_condition[m1_id]:
                    m2_stereo_condition = (self.event_data['M2']['stereo_event_number'] ==
                                           self.event_data['M1']['stereo_event_number'][m1_id])
    
                    m12_match = np.where(m2_data_condition & m2_stereo_condition)
    
                    if len(m12_match[0]) == 0:
                        mono_ids['M1'].append(m1_id)
    
            for m2_id in range(0, n_m2_events):
                if m2_data_condition[m2_id]:
                    m1_stereo_condition = (self.event_data['M1']['stereo_event_number'] ==
                                           self.event_data['M2']['stereo_event_number'][m2_id])
    
                    m12_match = np.where(m1_data_condition & m1_stereo_condition)
    
                    if len(m12_match[0]) == 0:
                        mono_ids['M2'].append(m2_id)
        else:
1185

Moritz Huetten's avatar
Moritz Huetten committed
1186
1187
1188
            data_trigger_pattern = 1
            m1_data_condition = self.event_data['M1']['trigger_pattern'] == data_trigger_pattern
            m2_data_condition = self.event_data['M2']['trigger_pattern'] == data_trigger_pattern
1189
1190
1191

            # shortcut if only single file is loaded:
            if n_m1_events == 0:
1192
1193
                if n_m2_events > 0:
                    mono_ids['M2'] = np.arange(0, n_m2_events)[m2_data_condition]
1194
1195
                return mono_ids
            if n_m2_events == 0:
1196
1197
                if n_m1_events > 0:
                    mono_ids['M1'] = np.arange(0, n_m1_events)[m1_data_condition]
1198
1199
                return mono_ids

Moritz Huetten's avatar
Moritz Huetten committed
1200
1201
1202
1203
1204
1205
1206
1207
            for m1_id in range(0, n_m1_events):
                if m1_data_condition[m1_id]:
                    if self.event_data['M1']['stereo_event_number'][m1_id] == 0:
                        mono_ids['M1'].append(m1_id)
            for m2_id in range(0, n_m2_events):
                if m2_data_condition[m2_id]:
                    if self.event_data['M2']['stereo_event_number'][m2_id] == 0:
                        mono_ids['M2'].append(m2_id)
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311

        return mono_ids

    def _get_pedestal_file_num(self, pedestal_event_num, telescope):
        """
        This internal method identifies the M1/2 file number of the
        given pedestal event in M1/2 file lists, corresponding to this run.

        Parameters
        ----------
        pedestal_event_num: int
            Order number of the event in the list of pedestal events
            of the specified telescope, corresponding to this run.
        telescope: str
            The name of the telescope to which this event corresponds.
            May be "M1" or "M2".

        Returns
        -------
        file_num:
            Order number of the corresponding file in the M1 or M2 file list.
        """

        event_id = self.pedestal_ids[telescope][pedestal_event_num]
        file_num = np.digitize([event_id], self.event_data[telescope]['file_edges'])
        file_num = file_num[0] - 1

        return file_num

    def _get_stereo_file_num(self, stereo_event_num):
        """
        This internal method identifies the M1/2 file numbers of the
        given stereo event in M1/2 file lists, corresponding to this run.

        Parameters
        ----------
        stereo_event_num: int
            Order number of the event in the list of stereo events corresponding
            to this run.

        Returns
        -------
        m1_file_num:
            Order number of the corresponding file in the M1 file list.
        m2_file_num:
            Order number of the corresponding file in the M2 file list.
        """

        m1_id = self.stereo_ids[stereo_event_num][0]
        m2_id = self.stereo_ids[stereo_event_num][1]
        m1_file_num = np.digitize([m1_id], self.event_data['M1']['file_edges'])
        m2_file_num = np.digitize([m2_id], self.event_data['M2']['file_edges'])

        m1_file_num = m1_file_num[0] - 1
        m2_file_num = m2_file_num[0] - 1

        return m1_file_num, m2_file_num

    def _get_mono_file_num(self, mono_event_num, telescope):
        """
        This internal method identifies the M1/2 file number of the
        given mono event in M1/2 file lists, corresponding to this run.

        Parameters
        ----------
        mono_event_num: int
            Order number of the event in the list of stereo events corresponding
            to this run.
        telescope: str
            The name of the telescope to which this event corresponds.
            May be "M1" or "M2".

        Returns
        -------
        file_num:
            Order number of the corresponding file in the M1 or M2 file list.
        """

        event_id = self.mono_ids[telescope][mono_event_num]
        file_num = np.digitize([event_id], self.event_data[telescope]['file_edges'])
        file_num = file_num[0] - 1

        return file_num

    def get_pedestal_event_data(self, pedestal_event_num, telescope):
        """
        This method read the photon content and arrival time (per pixel)
        for the specified pedestal event. Also returned is the event telescope pointing
        data.

        Parameters
        ----------
        pedestal_event_num: int
            Order number of the event in the list of pedestal events for the
            given telescope, corresponding to this run.
        telescope: str
            The name of the telescope to which this event corresponds.
            May be "M1" or "M2".

        Returns
        -------
        dict:
            The output has the following structure:
            'image' - photon_content in requested telescope
Ievgen Vovk's avatar
Ievgen Vovk committed
1312
            'pulse_time' - arrival_times in requested telescope
1313
1314
1315
1316
1317
            'pointing_az' - pointing azimuth [degrees]
            'pointing_zd' - pointing zenith angle [degrees]
            'pointing_ra' - pointing right ascension [degrees]
            'pointing_dec' - pointing declination [degrees]
            'mjd' - event arrival time [MJD]
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
        """

        file_num = self._get_pedestal_file_num(pedestal_event_num, telescope)
        event_id = self.pedestal_ids[telescope][pedestal_event_num]

        id_in_file = event_id - self.event_data[telescope]['file_edges'][file_num]

        photon_content = self.event_data[telescope]['charge'][file_num][id_in_file][:self.n_camera_pixels]
        arrival_times = self.event_data[telescope]['arrival_time'][file_num][id_in_file][:self.n_camera_pixels]

        event_data = dict()
        event_data['image'] = photon_content
Ievgen Vovk's avatar
Ievgen Vovk committed
1330
        event_data['pulse_time'] = arrival_times
1331
1332
1333
1334
1335
        event_data['pointing_az'] = self.event_data[telescope]['pointing_az'][event_id]
        event_data['pointing_zd'] = self.event_data[telescope]['pointing_zd'][event_id]
        event_data['pointing_ra'] = self.event_data[telescope]['pointing_ra'][event_id]
        event_data['pointing_dec'] = self.event_data[telescope]['pointing_dec'][event_id]
        event_data['mjd'] = self.event_data[telescope]['MJD'][event_id]
Moritz Huetten's avatar
Moritz Huetten committed
1336
        event_data['mars_meta'] = self.event_data[telescope]['mars_meta'][file_num]
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356

        return event_data

    def get_stereo_event_data(self, stereo_event_num):
        """
        This method read the photon content and arrival time (per pixel)
        for the specified stereo event. Also returned is the event telescope pointing
        data.

        Parameters
        ----------
        stereo_event_num: int
            Order number of the event in the list of stereo events corresponding
            to this run.

        Returns
        -------
        dict:
            The output has the following structure:
            'm1_image' - M1 photon_content
Ievgen Vovk's avatar
Ievgen Vovk committed
1357
            'm1_pulse_time' - M1 arrival_times
1358
            'm2_image' - M2 photon_content
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
            'm2_peak_pos' - M2 arrival_times
            'm1_pointing_az' - M1 pointing azimuth [degrees]
            'm1_pointing_zd' - M1 pointing zenith angle [degrees]
            'm1_pointing_ra' - M1 pointing right ascension [degrees]
            'm1_pointing_dec' - M1 pointing declination [degrees]
            'm2_pointing_az' - M2 pointing azimuth [degrees]
            'm2_pointing_zd' - M2 pointing zenith angle [degrees]
            'm2_pointing_ra' - M2 pointing right ascension [degrees]
            'm2_pointing_dec' - M2 pointing declination [degrees]
            'mjd' - event arrival time [MJD]
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
        """

        m1_file_num, m2_file_num = self._get_stereo_file_num(stereo_event_num)
        m1_id = self.stereo_ids[stereo_event_num][0]
        m2_id = self.stereo_ids[stereo_event_num][1]

        m1_id_in_file = m1_id - self.event_data['M1']['file_edges'][m1_file_num]
        m2_id_in_file = m2_id - self.event_data['M2']['file_edges'][m2_file_num]

        m1_photon_content = self.event_data['M1']['charge'][m1_file_num][m1_id_in_file][:self.n_camera_pixels]
        m1_arrival_times = self.event_data['M1']['arrival_time'][m1_file_num][m1_id_in_file][:self.n_camera_pixels]

        m2_photon_content = self.event_data['M2']['charge'][m2_file_num][m2_id_in_file][:self.n_camera_pixels]
        m2_arrival_times = self.event_data['M2']['arrival_time'][m2_file_num][m2_id_in_file][:self.n_camera_pixels]

        event_data = dict()
        event_data['m1_image'] = m1_photon_content
Ievgen Vovk's avatar
Ievgen Vovk committed
1386
        event_data['m1_pulse_time'] = m1_arrival_times
1387
        event_data['m2_image'] = m2_photon_content
Ievgen Vovk's avatar
Ievgen Vovk committed
1388
        event_data['m2_pulse_time'] = m2_arrival_times
1389
1390
1391
1392
1393
1394
1395
1396
        event_data['m1_pointing_az'] = self.event_data['M1']['pointing_az'][m1_id]
        event_data['m1_pointing_zd'] = self.event_data['M1']['pointing_zd'][m1_id]
        event_data['m1_pointing_ra'] = self.event_data['M1']['pointing_ra'][m1_id]
        event_data['m1_pointing_dec'] = self.event_data['M1']['pointing_dec'][m1_id]
        event_data['m2_pointing_az'] = self.event_data['M2']['pointing_az'][m2_id]
        event_data['m2_pointing_zd'] = self.event_data['M2']['pointing_zd'][m2_id]
        event_data['m2_pointing_ra'] = self.event_data['M2']['pointing_ra'][m2_id]
        event_data['m2_pointing_dec'] = self.event_data['M2']['pointing_dec'][m2_id]
Moritz Huetten's avatar
Moritz Huetten committed
1397
        
1398
        # get information identical for both telescopes from M1:
Moritz Huetten's avatar
Moritz Huetten committed
1399
        event_data['mars_meta'] = self.event_data['M1']['mars_meta'][m1_file_num]
Moritz Huetten's avatar
Moritz Huetten committed
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
        
        if self.is_mc == False:
            event_data['mjd'] = self.event_data['M1']['MJD'][m1_id]
        else:
            event_data['true_energy'] = self.event_data['M1']['true_energy'][m1_id]
            event_data['true_zd'] = self.event_data['M1']['true_zd'][m1_id]
            event_data['true_az'] = self.event_data['M1']['true_az'][m1_id]
            event_data['true_shower_primary_id'] = self.event_data['M1']['true_shower_primary_id'][m1_id]
            event_data['true_h_first_int'] = self.event_data['M1']['true_h_first_int'][m1_id]
            event_data['true_core_x'] = self.event_data['M1']['true_core_x'][m1_id]
            event_data['true_core_y'] = self.event_data['M1']['true_core_y'][m1_id]