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

Moritz Huetten's avatar
Moritz Huetten committed
6
import logging
7
8
9

import glob
import re
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
10
import os.path
11
from pathlib import Path
12
13

import numpy as np
14
15

import scipy
16
17
18
19
import scipy.interpolate

from astropy import units as u
from astropy.time import Time
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
20

21
from ctapipe.io.eventsource import EventSource
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
22
23
24
25
26
27
28
from ctapipe.io.datalevels import DataLevel

from ctapipe.core import Container
from ctapipe.core import Field

from ctapipe.containers import DataContainer
from ctapipe.containers import EventAndMonDataContainer
29
from ctapipe.containers import PointingContainer, TelescopePointingContainer
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
30
31
32
33
34
35
from ctapipe.containers import MonitoringCameraContainer
from ctapipe.containers import PedestalContainer

from ctapipe.instrument import TelescopeDescription
from ctapipe.instrument import SubarrayDescription
from ctapipe.instrument import OpticsDescription
36
from ctapipe.instrument import CameraDescription
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
37

38
39
40

__all__ = ['MAGICEventSource']

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
41
LOGGER = logging.getLogger(__name__)
42

Ievgen Vovk's avatar
Ievgen Vovk committed
43

44
# MAGIC telescope positions in m wrt. to the center of CTA simulations
45
46
47
48
49
50
#MAGIC_TEL_POSITIONS = {
#    1: [-27.24, -146.66, 50.00] * u.m,
#    2: [-96.44, -96.77, 51.00] * u.m
#}

# MAGIC telescope positions in m wrt. to the center of MAGIC simulations, from reflector input card
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
51
MAGIC_TEL_POSITIONS = {
52
53
    1: [31.80, -28.10, 0.00] * u.m,
    2: [-31.80, 28.10, 0.00] * u.m
54
}
55

56
# MAGIC telescope description
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
57
OPTICS = OpticsDescription.from_name('MAGIC')
58
59
MAGICCAM = CameraDescription.from_name("MAGICCam")
GEOM = MAGICCAM.geometry
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
60
MAGIC_TEL_DESCRIPTION = TelescopeDescription(
61
    name='MAGIC', tel_type='MAGIC', optics=OPTICS, camera=MAGICCAM)
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
62
MAGIC_TEL_DESCRIPTIONS = {1: MAGIC_TEL_DESCRIPTION, 2: MAGIC_TEL_DESCRIPTION}
63

64
# trigger patterns:
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
65
66
67
68
MC_TRIGGER_PATTERN = 1
PEDESTAL_TRIGGER_PATTERN = 8
DATA_TRIGGER_PATTERN = 128

69
70
71
72
73
74
75
class L3JumpError(Exception):
    """
    Exception raised when L3 trigger number jumps backward.
    """

    def __init__(self, message):
        self.message = message
76

77
78
79
80
81
82
83
84
class MissingDriveReportError(Exception):
    """
    Exception raised when a subrun does not have drive reports.
    """

    def __init__(self, message):
        self.message = message

85
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
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.
        """

114
115
        file_path = Path(kwargs['input_url'])
        self.file_list = glob.glob(str(file_path.absolute()))
116
        if not self.file_list:
117
            raise ValueError("Unreadable or wrong wildcard file path given.")
118
        self.file_list.sort()
119
120
121
122
123

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

        # Retrieving the list of run numbers corresponding to the data files
127
        run_info = list(map(self.get_run_info_from_name, self.file_list))
Moritz Huetten's avatar
Moritz Huetten committed
128
        run_numbers = [i[0] for i in run_info]
129
        is_mc_runs = [i[1] for i in run_info]
Moritz Huetten's avatar
Moritz Huetten committed
130
131

        self.run_numbers, indices = np.unique(run_numbers, return_index=True)
132
133
        is_mc_runs = [is_mc_runs[i] for i in indices]
        is_mc_runs = np.unique(is_mc_runs)
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
134

135
136
        # Checking if runt type (data/MC) is consistent:
        if len(is_mc_runs) > 1:
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
137
138
            raise ValueError(
                "Loaded files contain data and MC runs. Please load only data OR Monte Carlos.")
139
        self.is_mc = is_mc_runs[0]
140

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
141
142
143
        # Retrieving the data level (so far HARDCODED Sorcerer)
        self.datalevel = DataLevel.DL1_IMAGES

144
145
146
147
        # # 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

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
148
149
        self._subarray_info = SubarrayDescription(
            'MAGIC', MAGIC_TEL_POSITIONS, MAGIC_TEL_DESCRIPTIONS)
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

    @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:
Alessio Berti's avatar
Alessio Berti committed
176
                import uproot
177
178
179
180
181
182
183
184
185
186

                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

            except ImportError:
Ievgen Vovk's avatar
Ievgen Vovk committed
187
                if re.match(r'.+_m\d_.+root', file_path.lower()) is None:
188
189
190
191
192
                    is_magic_root_file = False

        return is_magic_root_file

    @staticmethod
193
    def get_run_info_from_name(file_name):
194
        """
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
195
        This internal method extracts the run number and
Moritz Huetten's avatar
Moritz Huetten committed
196
        type (data/MC) from the specified file name.
197
198
199
200
201
202
203
204
205
206
207
208

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

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

Moritz Huetten's avatar
Moritz Huetten committed
209
        mask_data = r".*\d+_M\d+_(\d+)\.\d+_Y_.*"
Moritz Huetten's avatar
Moritz Huetten committed
210
211
        mask_mc = r".*_M\d_za\d+to\d+_\d_(\d+)_Y_.*"
        mask_mc_alt = r".*_M\d_\d_(\d+)_.*"
212
        if re.findall(mask_data, file_name):
Moritz Huetten's avatar
Moritz Huetten committed
213
214
            parsed_info = re.findall(mask_data, file_name)
            is_mc = False
215
        elif re.findall(mask_mc, file_name):
Moritz Huetten's avatar
Moritz Huetten committed
216
217
218
219
220
            parsed_info = re.findall(mask_mc, file_name)
            is_mc = True
        else:
            parsed_info = re.findall(mask_mc_alt, file_name)
            is_mc = True
221
222
223
224

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

Moritz Huetten's avatar
Moritz Huetten committed
229
        return run_number, is_mc
230

Moritz Huetten's avatar
Moritz Huetten committed
231
    def _set_active_run(self, run_number):
232
233
234
235
236
237
238
239
240
241
        """
        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
242
        MarsRun:
Moritz Huetten's avatar
Moritz Huetten committed
243
            The run to use
244
        """
Moritz Huetten's avatar
Moritz Huetten committed
245

246
        this_run_mask = os.path.join(self.input_url.parents[0],
Moritz Huetten's avatar
Moritz Huetten committed
247
                                     '*{:d}*root'.format(run_number))
248
249
250
251

        run = dict()
        run['number'] = run_number
        run['read_events'] = 0
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
252
253
        run['data'] = MarsRun(run_file_mask=this_run_mask,
                              filter_list=self.file_list)
254
255
256

        return run

257
258
259
260
    @property
    def subarray(self):
        return self._subarray_info

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
261
262
263
264
265
266
267
268
269
270
271
272
    @property
    def is_simulation(self):
        return self.is_mc

    @property
    def datalevels(self):
        return (self.datalevel, )

    @property
    def obs_id(self):
        return self.run_numbers

273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
    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
298
299
300
301
        if not self.is_mc:
            data = EventAndMonDataContainer()
        else:
            data = DataContainer()
302
303
304
305
306
307

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

        # Loop over the available data runs
308
        for run_number in self.run_numbers:
309
310
311
312
313
314

            # 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
315
            # Setting the new active run (class MarsRun object)
Moritz Huetten's avatar
Moritz Huetten committed
316
            self.current_run = self._set_active_run(run_number)
317
            
318
319
            # Set monitoring data:
            if not self.is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
320

321
                monitoring_data = self.current_run['data'].monitoring_data
Moritz Huetten's avatar
Moritz Huetten committed
322

323
324
325
                for tel_i, tel_id in enumerate(tels_in_file):
                    monitoring_camera = MonitoringCameraContainer()
                    pedestal_info = PedestalContainer()
326
                    badpixel_info = PixelStatusContainer()
Moritz Huetten's avatar
Moritz Huetten committed
327

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
328
329
330
331
332
333
                    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)
                    # hardcoded number of pedestal events averaged over:
                    pedestal_info.n_events = 500
334
                    pedestal_info.charge_mean = []
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
335
336
337
338
339
340
                    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'])
341
                    pedestal_info.charge_std = []
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
342
343
344
345
346
347
348
349
350
351
352
353
                    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'])

                    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']
Moritz Huetten's avatar
Moritz Huetten committed
354
                    badpixel_info.sample_time_range = t_range
355

356
                    monitoring_camera.pedestal = pedestal_info
357
                    monitoring_camera.pixel_status = badpixel_info
358
359

                    data.mon.tels_with_data = {1, 2}
360
                    data.mon.tel[tel_i + 1] = monitoring_camera
361
            else:
362
363
                assert self.current_run['data'].mcheader_data['M1'] == self.current_run['data'].mcheader_data['M2'], "Simulation configurations are different for M1 and M2 !!!"
                data.mcheader.num_showers = self.current_run['data'].mcheader_data['M1']['sim_nevents']
364
                data.mcheader.shower_reuse = self.current_run['data'].mcheader_data['M1']['sim_reuse']
365
366
367
368
369
370
371
                data.mcheader.energy_range_min = (self.current_run['data'].mcheader_data['M1']['sim_emin']).to(u.TeV) # GeV->TeV
                data.mcheader.energy_range_max = (self.current_run['data'].mcheader_data['M1']['sim_emax']).to(u.TeV) # GeV->TeV
                data.mcheader.spectral_index = self.current_run['data'].mcheader_data['M1']['sim_eslope']
                data.mcheader.max_scatter_range = (self.current_run['data'].mcheader_data['M1']['sim_max_impact']).to(u.m) # cm->m
                data.mcheader.max_viewcone_radius = (self.current_run['data'].mcheader_data['M1']['sim_conesemiangle']).to(u.deg)# deg->deg
                if data.mcheader.max_viewcone_radius != 0.:
                    data.mcheader.diffuse = True
372
                else:
373
374
                    data.mcheader.diffuse = False
                    
375

376
377
378
379
380
381
382
383
            # 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
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
384
385
386
                event_data = self.current_run['data'].get_stereo_event_data(
                    event_i)

387
                data.meta = event_data['mars_meta']
388
389
390

                # Event counter
                data.count = counter
Moritz Huetten's avatar
Moritz Huetten committed
391
392
                data.index.obs_id = obs_id
                data.index.event_id = event_id
393
394
395
396
397
398
399
400
401
402

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

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

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

Alessio Berti's avatar
Alessio Berti committed
403
404
405
                # Setting up the DL1 container
                data.dl1.tel.clear()

406
                pointing = PointingContainer()
407
408
409
                # Filling the DL1 container with the event data
                for tel_i, tel_id in enumerate(tels_in_file):
                    # Creating the telescope pointing container
410
411
412
                    pointing_tel = TelescopePointingContainer()
                    
                    pointing_tel.azimuth = np.deg2rad(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
413
                        event_data['{:s}_pointing_az'.format(tel_id)]) * u.rad
414
415
                    
                    pointing_tel.altitude = np.deg2rad(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
416
                        90 - event_data['{:s}_pointing_zd'.format(tel_id)]) * u.rad
417
                    
418
                    # pointing.ra = np.deg2rad(
Moritz Huetten's avatar
Moritz Huetten committed
419
                    #    event_data['{:s}_pointing_ra'.format(tel_id)]) * u.rad
420
                    # pointing.dec = np.deg2rad(
Moritz Huetten's avatar
Moritz Huetten committed
421
                    #    event_data['{:s}_pointing_dec'.format(tel_id)]) * u.rad
422

423
                    pointing.tel[tel_i + 1] = pointing_tel
424

Moritz Huetten's avatar
Moritz Huetten committed
425
426
427
428
429
                    # Adding trigger id (MAGIC nomenclature)
                    data.r0.tel[tel_i + 1].trigger_type = self.current_run['data'].event_data['M1']['trigger_pattern'][event_order_number]
                    data.r1.tel[tel_i + 1].trigger_type = self.current_run['data'].event_data['M1']['trigger_pattern'][event_order_number]
                    data.dl0.tel[tel_i + 1].trigger_type = self.current_run['data'].event_data['M1']['trigger_pattern'][event_order_number]

430
                    # Adding event charge and peak positions per pixel
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
431
432
433
                    data.dl1.tel[tel_i +
                                 1].image = event_data['{:s}_image'.format(tel_id)]
                    data.dl1.tel[tel_i +
Moritz Huetten's avatar
Moritz Huetten committed
434
                                 1].peak_time = event_data['{:s}_pulse_time'.format(tel_id)]
435
436
437
438
439
440
                
                pointing.array_azimuth = np.deg2rad(event_data['m1_pointing_az']) * u.rad
                pointing.array_altitude = np.deg2rad(90 - event_data['m1_pointing_zd']) * u.rad
                pointing.array_ra = np.deg2rad(event_data['m1_pointing_ra']) * u.rad
                pointing.array_dec = np.deg2rad(90 - event_data['m1_pointing_dec']) * u.rad
                data.pointing = pointing
Moritz Huetten's avatar
Moritz Huetten committed
441

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
442
                if not self.is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
443
                    # Adding the event arrival time
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
444
445
                    time_tmp = Time(
                        event_data['mjd'], scale='utc', format='mjd')
Moritz Huetten's avatar
Moritz Huetten committed
446
                    data.trigger.time = Time(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
447
                        time_tmp, format='unix', scale='utc', precision=9)
Moritz Huetten's avatar
Moritz Huetten committed
448
449
                else:
                    data.mc.energy = event_data['true_energy'] * u.GeV
450
                    data.mc.alt = (np.pi/2 - event_data['true_zd']) * u.rad
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
451
452
453
454
455
                    # check meaning of 7deg transformation (I.Vovk)
                    data.mc.az = -1 * \
                        (event_data['true_az'] - np.deg2rad(180 - 7)) * u.rad
                    data.mc.shower_primary_id = 1 - \
                        event_data['true_shower_primary_id']
Moritz Huetten's avatar
Moritz Huetten committed
456
                    data.mc.h_first_int = event_data['true_h_first_int'] * u.cm
457
458
459
460
461
462
                    
                    # adding a 7deg rotation between the orientation of corsika (x axis = magnetic north) and MARS (x axis = geographical north) frames
                    # magnetic north is 7 deg westward w.r.t. geographical north
                    rot_corsika = 7 *u.deg
                    data.mc.core_x = (event_data['true_core_x']*np.cos(rot_corsika) - event_data['true_core_y']*np.sin(rot_corsika))* u.cm
                    data.mc.core_y = (event_data['true_core_x']*np.sin(rot_corsika) + event_data['true_core_y']*np.cos(rot_corsika))* u.cm
463
464
465
466
467

                # 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
Moritz Huetten's avatar
Moritz Huetten committed
468
                data.trigger.tels_with_trigger = tels_with_data
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493

                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
494
495
496
497
        if not self.is_mc:
            data = EventAndMonDataContainer()
        else:
            data = DataContainer()
498
499
500
501
502

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

        if telescope not in tels_in_file:
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
503
504
            raise ValueError("Specified telescope {:s} is not in the allowed list {}".format(
                telescope, tels_in_file))
505
506
507
508
509

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

        # Loop over the available data runs
510
        for run_number in self.run_numbers:
511
512
513
514
515
516
517

            # 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
518
            self.current_run = self._set_active_run(run_number)
519

Moritz Huetten's avatar
Moritz Huetten committed
520
521
            # Set monitoring data:
            if not self.is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
522

Moritz Huetten's avatar
Moritz Huetten committed
523
                monitoring_data = self.current_run['data'].monitoring_data
Moritz Huetten's avatar
Moritz Huetten committed
524

Moritz Huetten's avatar
Moritz Huetten committed
525
526
527
                monitoring_camera = MonitoringCameraContainer()
                pedestal_info = PedestalContainer()
                badpixel_info = PixelStatusContainer()
Moritz Huetten's avatar
Moritz Huetten committed
528

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
529
530
531
532
                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)
533
                pedestal_info.n_events = 500 # hardcoded number of pedestal events averaged over
Moritz Huetten's avatar
Moritz Huetten committed
534
                pedestal_info.charge_mean = []
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
535
536
537
538
539
540
                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'])
Moritz Huetten's avatar
Moritz Huetten committed
541
                pedestal_info.charge_std = []
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
542
543
544
545
546
547
548
549
550
551
552
553
                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'])

                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']
Moritz Huetten's avatar
Moritz Huetten committed
554
                badpixel_info.sample_time_range = t_range
Moritz Huetten's avatar
Moritz Huetten committed
555

Moritz Huetten's avatar
Moritz Huetten committed
556
557
558
559
560
561
                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

562
             #fdp (mono version not fully tested)
563
564
            else:
                data.mcheader.num_showers = self.current_run['data'].mcheader_data[telescope]['sim_nevents'] # total, including reuse
565
                data.mcheader.shower_reuse = self.current_run['data'].mcheader_data[telescope]['sim_reuse']
566
567
568
569
570
                data.mcheader.energy_range_min = (self.current_run['data'].mcheader_data[telescope]['sim_emin']).to(u.TeV) # GeV->TeV
                data.mcheader.energy_range_max = (self.current_run['data'].mcheader_data[telescope]['sim_emax']).to(u.TeV) # GeV->TeV
                data.mcheader.spectral_index = self.current_run['data'].mcheader_data[telescope]['sim_eslope'] 
                data.mcheader.max_scatter_range = (self.current_run['data'].mcheader_data[telescope]['sim_max_impact']).to(u.m) # cm->m
                data.mcheader.max_viewcone_radius = (self.current_run['data'].mcheader_data[telescope]['sim_conesemiangle']).to(u.deg) # deg->deg
571

572

573
574
575
576
577
578
579
580
581
582
583
584
585
            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
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
586
587
588
                event_data = self.current_run['data'].get_mono_event_data(
                    event_i, telescope=telescope)

589
                data.meta = event_data['mars_meta']
590
591
592

                # Event counter
                data.count = counter
Moritz Huetten's avatar
Moritz Huetten committed
593
594
                data.index.obs_id = obs_id
                data.index.event_id = event_id
595
596
597

                # Setting up the R0 container
                data.r0.tel.clear()
598
                data.r0.tel[tel_i + 1].trigger_type = self.current_run['data'].event_data[telescope]['trigger_pattern'][event_order_number]
599
600
601

                # Setting up the R1 container
                data.r1.tel.clear()
602
                data.r1.tel[tel_i + 1].trigger_type = self.current_run['data'].event_data[telescope]['trigger_pattern'][event_order_number]
603
604
605

                # Setting up the DL0 container
                data.dl0.tel.clear()
606
                data.dl0.tel[tel_i + 1].trigger_type = self.current_run['data'].event_data[telescope]['trigger_pattern'][event_order_number]
607

Alessio Berti's avatar
Alessio Berti committed
608
609
610
                # Setting up the DL1 container
                data.dl1.tel.clear()

611
                # Creating the telescope pointing container
612
613
614
615
                pointing = PointingContainer()
                pointing_tel = TelescopePointingContainer()

                pointing_tel.azimuth = np.deg2rad(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
616
                    event_data['pointing_az']) * u.rad
617
                pointing_tel.altitude = np.deg2rad(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
618
                    90 - event_data['pointing_zd']) * u.rad
Moritz Huetten's avatar
Moritz Huetten committed
619
620
                #pointing.ra = np.deg2rad(event_data['pointing_ra']) * u.rad
                #pointing.dec = np.deg2rad(event_data['pointing_dec']) * u.rad
621
622
623
624
625
626
627
628
629
                
                pointing.tel[tel_i + 1] = pointing_tel
                
                pointing.array_azimuth = np.deg2rad(event_data['pointing_az']) * u.rad
                pointing.array_altitude = np.deg2rad(90 - event_data['pointing_zd']) * u.rad
                pointing.array_ra = np.deg2rad(event_data['pointing_ra']) * u.rad
                pointing.array_dec = np.deg2rad(90 - event_data['pointing_dec']) * u.rad
                
                data.pointing = pointing
630
631
632

                # Adding event charge and peak positions per pixel
                data.dl1.tel[tel_i + 1].image = event_data['image']
Moritz Huetten's avatar
Moritz Huetten committed
633
                data.dl1.tel[tel_i + 1].peak_time = event_data['pulse_time']
634

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
635
                if not self.is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
636
                    # Adding the event arrival time
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
637
638
                    time_tmp = Time(
                        event_data['mjd'], scale='utc', format='mjd')
Moritz Huetten's avatar
Moritz Huetten committed
639
                    data.trigger.time = Time(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
640
                        time_tmp, format='unix', scale='utc', precision=9)
Moritz Huetten's avatar
Moritz Huetten committed
641
642
                else:
                    data.mc.energy = event_data['true_energy'] * u.GeV
643
                    data.mc.alt = (np.pi/2 - event_data['true_zd']) * u.rad
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
644
645
646
647
648
                    # check meaning of 7deg transformation (I.Vovk)
                    data.mc.az = -1 * \
                        (event_data['true_az'] - np.deg2rad(180 - 7)) * u.rad
                    data.mc.shower_primary_id = 1 - \
                        event_data['true_shower_primary_id']
Moritz Huetten's avatar
Moritz Huetten committed
649
                    data.mc.h_first_int = event_data['true_h_first_int'] * u.cm
650
651
652
653
654
655

                    # adding a 7deg rotation between the orientation of corsika (x axis = magnetic north) and MARS (x axis = geographical north) frames
                    # magnetic north is 7 deg westward w.r.t. geographical north
                    rot_corsika = 7 *u.deg
                    data.mc.core_x = (event_data['true_core_x']*np.cos(rot_corsika) - event_data['true_core_y']*np.sin(rot_corsika))* u.cm
                    data.mc.core_y = (event_data['true_core_x']*np.sin(rot_corsika) + event_data['true_core_y']*np.cos(rot_corsika))* u.cm
656
657
658
659
660

                # 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
Moritz Huetten's avatar
Moritz Huetten committed
661
                data.trigger.tels_with_trigger = tels_with_data
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

                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
687
        data = EventAndMonDataContainer()
688
689
690
691
692

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

        if telescope not in tels_in_file:
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
693
694
            raise ValueError("Specified telescope {:s} is not in the allowed list {}".format(
                telescope, tels_in_file))
695
696
697
698
699

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

        # Loop over the available data runs
700
        for run_number in self.run_numbers:
701
702
703
704
705
706
707

            # 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
708
            self.current_run = self._set_active_run(run_number)
709

Moritz Huetten's avatar
Moritz Huetten committed
710
            monitoring_data = self.current_run['data'].monitoring_data
Moritz Huetten's avatar
Moritz Huetten committed
711

Moritz Huetten's avatar
Moritz Huetten committed
712
713
714
            monitoring_camera = MonitoringCameraContainer()
            pedestal_info = PedestalContainer()
            badpixel_info = PixelStatusContainer()
Moritz Huetten's avatar
Moritz Huetten committed
715

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
716
717
718
719
            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)
720
            pedestal_info.n_events = 500 # hardcoded number of pedestal events averaged over
Moritz Huetten's avatar
Moritz Huetten committed
721
            pedestal_info.charge_mean = []
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
722
723
724
725
726
727
            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'])
Moritz Huetten's avatar
Moritz Huetten committed
728
            pedestal_info.charge_std = []
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
729
730
731
732
733
734
735
736
737
738
739
740
            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'])

            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']
Moritz Huetten's avatar
Moritz Huetten committed
741
            badpixel_info.sample_time_range = t_range
Moritz Huetten's avatar
Moritz Huetten committed
742

Moritz Huetten's avatar
Moritz Huetten committed
743
744
745
746
747
748
            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

749
750
751
752
753
754
755
756
757
758
759
760
761
            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
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
762
763
764
                event_data = self.current_run['data'].get_pedestal_event_data(
                    event_i, telescope=telescope)

765
                data.meta = event_data['mars_meta']
766
767
768

                # Event counter
                data.count = counter
Moritz Huetten's avatar
Moritz Huetten committed
769
770
                data.index.obs_id = obs_id
                data.index.event_id = event_id
771

772
773
                # Setting up the R0 container
                data.r0.tel.clear()
774
                data.r0.tel[tel_i + 1].trigger_type = self.current_run['data'].event_data[telescope]['trigger_pattern'][event_order_number]
775
776
777

                # Setting up the R1 container
                data.r1.tel.clear()
778
                data.r1.tel[tel_i + 1].trigger_type = self.current_run['data'].event_data[telescope]['trigger_pattern'][event_order_number]
779
780
781

                # Setting up the DL0 container
                data.dl0.tel.clear()
782
                data.dl0.tel[tel_i + 1].trigger_type = self.current_run['data'].event_data[telescope]['trigger_pattern'][event_order_number]
783
784
785

                # Creating the telescope pointing container
                pointing = TelescopePointingContainer()
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
786
787
788
789
                pointing.azimuth = np.deg2rad(
                    event_data['pointing_az']) * u.rad
                pointing.altitude = np.deg2rad(
                    90 - event_data['pointing_zd']) * u.rad
Moritz Huetten's avatar
Moritz Huetten committed
790
791
                #pointing.ra = np.deg2rad(event_data['pointing_ra']) * u.rad
                #pointing.dec = np.deg2rad(event_data['pointing_dec']) * u.rad
792
793

                # Adding the pointing container to the event data
Moritz Huetten's avatar
Moritz Huetten committed
794
                data.pointing.tel[tel_i + 1] = pointing
795
796
797

                # Adding event charge and peak positions per pixel
                data.dl1.tel[tel_i + 1].image = event_data['image']
Moritz Huetten's avatar
Moritz Huetten committed
798
                data.dl1.tel[tel_i + 1].peak_time = event_data['pulse_time']
799
800
801

                # Adding the event arrival time
                time_tmp = Time(event_data['mjd'], scale='utc', format='mjd')
Moritz Huetten's avatar
Moritz Huetten committed
802
                data.trigger.time = Time(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
803
                    time_tmp, format='unix', scale='utc', precision=9)
804
805
806
807
808

                # 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
Moritz Huetten's avatar
Moritz Huetten committed
809
                data.trigger.tels_with_trigger = tels_with_data
810
811
812
813
814
815
816

                yield data
                counter += 1

        return


Moritz Huetten's avatar
Moritz Huetten committed
817
class MarsRun:
818
819
820
821
    """
    This class implements reading of the event data from a single MAGIC data run.
    """

Moritz Huetten's avatar
Moritz Huetten committed
822
    def __init__(self, run_file_mask, filter_list=None):
823
824
825
826
827
828
829
830
831
        """
        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.
832
833
834
        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.
835
836
        """

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
837
        self.n_camera_pixels = GEOM.n_pixels
838

839
840
841
842
        self.run_file_mask = run_file_mask

        # Preparing the lists of M1/2 data files
        file_list = glob.glob(run_file_mask)
843
844
845
846
847

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

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
848
849
850
851
        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))
852
        self.m1_file_list.sort()
853
854
855
        self.m2_file_list.sort()

        # Retrieving the list of run numbers corresponding to the data files
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
856
        run_info = list(
857
            map(MAGICEventSource.get_run_info_from_name, file_list))
Moritz Huetten's avatar
Moritz Huetten committed
858
        run_numbers = [i[0] for i in run_info]
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
859
        is_mc_runs = [i[1] for i in run_info]
860
861
862

        run_numbers = np.unique(run_numbers)
        is_mc_runs = np.unique(is_mc_runs)
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
863
        # Checking if run type (data/MC) is consistent:
864
        if len(is_mc_runs) > 1:
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
865
866
867
            raise ValueError(
                "Run type is not consistently data or MC: {}".format(is_mc_runs))

868
        self.is_mc = is_mc_runs[0]
869
870
871

        # Checking if a single run is going to be read
        if len(run_numbers) > 1:
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
872
873
            raise ValueError(
                "Run mask corresponds to more than one run: {}".format(run_numbers))
874

875
        # Reading the data
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
876
877
878
879
880
        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)

881
        # Getting the event data
882
        self.event_data = dict()
883
884
885
886
887
888
889
        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]
890

891
        # Getting the run-wise MC header data
892
        if self.is_mc:
893
894
895
            self.mcheader_data = dict()
            self.mcheader_data['M1'] = m1_data[2]
            self.mcheader_data['M2'] = m2_data[2]
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
932
        # 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()

    @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
933
    def load_events(file_list, is_mc, n_camera_pixels):
934
        """
935
        This method loads events and monitoring data from the pre-defiled file and returns them as a dictionary.
936
937
938
939
940

        Parameters
        ----------
        file_name: str
            Name of the MAGIC calibrated file to use.
941
942
943
944
        is_mc: boolean
            Specify whether Monte Carlo (True) or data (False) events are read
        n_camera_pixels: int
            Number of MAGIC camera pixels (not hardcoded, but specified solely via ctapipe.instrument.CameraGeometry)
945
946
947
948
949
950
951
952

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

        try:
Alessio Berti's avatar
Alessio Berti committed
953
            import uproot
954
955
956
957
958
959
960
961
        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'] = []
Alessio Berti's avatar
Alessio Berti committed
962
963
964
965
966
967
968
        event_data['trigger_pattern'] = np.array([], dtype=np.int32)
        event_data['stereo_event_number'] = np.array([], dtype=np.int32)
        event_data['pointing_zd'] = np.array([])
        event_data['pointing_az'] = np.array([])
        event_data['pointing_ra'] = np.array([])
        event_data['pointing_dec'] = np.array([])
        event_data['MJD'] = np.array([])
Moritz Huetten's avatar
Moritz Huetten committed
969
        event_data['mars_meta'] = []
970

971
972
        # monitoring information (updated from time to time)
        monitoring_data = dict()
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
973

Moritz Huetten's avatar
Moritz Huetten committed
974
975
        monitoring_data['badpixelinfo'] = []
        monitoring_data['badpixelinfoMJDrange'] = []
Alessio Berti's avatar
Alessio Berti committed
976
        monitoring_data['PedestalMJD'] = np.array([])
977
978
979
980
981
982
983
984
985
986
        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'] = []

987
988
        #MC Header information, dictionary always created, but filled only in case of MC run
        mcheader_data = dict()
989

990
991
        event_data['file_edges'] = [0]

992
993
994
995
996
        # if no file in the list (e.g. when reading mono information), then simply
        # return empty dicts/array
        if len(file_list) == 0:
            return event_data, monitoring_data, mcheader_data

997
998
999
1000
1001
1002
1003
        drive_data = dict()
        drive_data['mjd'] = np.array([])
        drive_data['zd']  = np.array([])
        drive_data['az']  = np.array([])
        drive_data['ra']  = np.array([])
        drive_data['dec'] = np.array([])

1004
1005
1006
1007
        degrees_per_hour = 15.0
        seconds_per_day = 86400.0
        seconds_per_hour = 3600.

Moritz Huetten's avatar
Moritz Huetten committed
1008
        evt_common_list = [
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1009
            'MCerPhotEvt.fPixels.fPhot',
Moritz Huetten's avatar
Moritz Huetten committed
1010
1011
            'MArrivalTime.fData',
            'MTriggerPattern.fPrescaled',
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1012
            'MRawEvtHeader.fStereoEvtNumber',
Moritz Huetten's avatar
Moritz Huetten committed
1013
            'MRawEvtHeader.fDAQEvtNumber',
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1014
1015
1016
        ]

        # Separately, because only used with pre-processed MARS data
Moritz Huetten's avatar
Moritz Huetten committed
1017
1018
        # to create MPointingPos container
        pointing_array_list = [
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1019
1020
1021
1022
            'MPointingPos.fZd',
            'MPointingPos.fAz',
            'MPointingPos.fRa',
            'MPointingPos.fDec',
Moritz Huetten's avatar
Moritz Huetten committed
1023
            'MPointingPos.fDevZd',
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1024
1025
            'MPointingPos.fDevAz',
            'MPointingPos.fDevHa',
Moritz Huetten's avatar
Moritz Huetten committed
1026
            'MPointingPos.fDevDec',
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1027
1028
        ]

Moritz Huetten's avatar
Moritz Huetten committed
1029
1030
1031
1032
        # Info only applicable for data:
        time_array_list = [
            'MTime.fMjd',
            'MTime.fTime.fMilliSec',
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1033
1034
1035
            'MTime.fNanoSec',
        ]

Moritz Huetten's avatar
Moritz Huetten committed
1036
1037
1038
1039
1040
1041
        drive_array_list = [
            'MReportDrive.fMjd',
            'MReportDrive.fCurrentZd',
            'MReportDrive.fCurrentAz',
            'MReportDrive.fRa',
            'MReportDrive.fDec'
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1042
        ]
Moritz Huetten's avatar
Moritz Huetten committed
1043

1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
        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
astyled    
Moritz Huetten committed
1054
        ]
1055

Moritz Huetten's avatar
Moritz Huetten committed
1056
1057
1058
1059
1060
1061
1062
1063
        # Info only applicable for MC:
        mc_list = [
            'MMcEvt.fEnergy',
            'MMcEvt.fTheta',
            'MMcEvt.fPhi',
            'MMcEvt.fPartId',
            'MMcEvt.fZFirstInteraction',
            'MMcEvt.fCoreX',
1064
            'MMcEvt.fCoreY'
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1065
        ]
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
        
        mcheader_list = [
            #'MMcRunHeader.fNumSimulatedShowers',
            'MMcRunHeader.fNumEvents',
            'MMcCorsikaRunHeader.fELowLim', #GeV
            'MMcCorsikaRunHeader.fEUppLim', #GeV
            'MMcCorsikaRunHeader.fSlopeSpec',
            'MMcRunHeader.fImpactMax', #cm
            #'MMcCorsikaRunHeader.fViewconeAngles',
            'MMcRunHeader.fRandomPointingConeSemiAngle' # deg
        ]
Moritz Huetten's avatar
Moritz Huetten committed
1077
1078
1079
1080
1081
1082
1083
1084
1085

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

1087
1088
1089
1090
        for file_name in file_list:

            input_file = uproot.open(file_name)

Alessio Berti's avatar
Alessio Berti committed
1091
            events = input_file['Events'].arrays(evt_common_list, library="np")
1092

1093
            # Reading the info common to MC and real data
Alessio Berti's avatar
Alessio Berti committed
1094
1095
1096
1097
            charge = events['MCerPhotEvt.fPixels.fPhot']
            arrival_time = events['MArrivalTime.fData']
            trigger_pattern = events['MTriggerPattern.fPrescaled']
            stereo_event_number = events['MRawEvtHeader.fStereoEvtNumber']
1098

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

Moritz Huetten's avatar
Moritz Huetten committed
1102
            mars_meta['is_simulation'] = is_mc
Moritz Huetten's avatar
Moritz Huetten committed
1103

1104
            if is_mc:
Alessio Berti's avatar
Alessio Berti committed
1105
1106
                mc_header_info = input_file['RunHeaders'].arrays(mcheader_list, library="np")
                mcheader_data['sim_nevents']=int(mc_header_info['MMcRunHeader.fNumEvents'][0]) #std: 5000
1107
                mcheader_data['sim_reuse']= 1 #this value is not written in the magic root file, but since the sim_events already include shower reuse we artificially set it to 1 (actually every shower reused 5 times for std MAGIC MC)
Alessio Berti's avatar
Alessio Berti committed
1108
1109
1110
1111
1112
                mcheader_data['sim_emin']=mc_header_info['MMcCorsikaRunHeader.fELowLim'][0]*u.GeV
                mcheader_data['sim_emax']=mc_header_info['MMcCorsikaRunHeader.fEUppLim'][0]*u.GeV
                mcheader_data['sim_eslope']=mc_header_info['MMcCorsikaRunHeader.fSlopeSpec'][0] #std: -1.6
                mcheader_data['sim_max_impact']=mc_header_info['MMcRunHeader.fImpactMax'][0]*u.cm
                mcheader_data['sim_conesemiangle']=mc_header_info['MMcRunHeader.fRandomPointingConeSemiAngle'][0]*u.deg #std: 2.5 deg, also corsika viewcone is defined by "half of the cone angle".
1113

Moritz Huetten's avatar
Moritz Huetten committed
1114
1115
            # Reading event timing information:
            if not is_mc:
Alessio Berti's avatar
Alessio Berti committed
1116
                event_times = input_file['Events'].arrays(time_array_list, library="np")
Moritz Huetten's avatar
Moritz Huetten committed
1117
                # Computing the event arrival time
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1118

Alessio Berti's avatar
Alessio Berti committed
1119
1120
1121
                event_mjd = event_times['MTime.fMjd']
                event_millisec = event_times['MTime.fTime.fMilliSec']
                event_nanosec = event_times['MTime.fNanoSec']
Moritz Huetten's avatar
Moritz Huetten committed
1122

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1123
1124
                event_mjd = event_mjd + \
                    (event_millisec / 1e3 + event_nanosec / 1e9) / seconds_per_day
Alessio Berti's avatar
Alessio Berti committed
1125
                event_data['MJD'] = np.concatenate(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1126
                    (event_data['MJD'], event_mjd))
Moritz Huetten's avatar
Moritz Huetten committed
1127

Moritz Huetten's avatar
Moritz Huetten committed
1128
            # try to read RunHeaders tree (soft fail if not present, to pass current tests)
Moritz Huetten's avatar
Moritz Huetten committed
1129
            try:
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1130
                meta_info = input_file['RunHeaders'].arrays(
Alessio Berti's avatar
Alessio Berti committed
1131
                    metainfo_array_list, library="np")
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1132

Moritz Huetten's avatar
Moritz Huetten committed
1133
1134
                mars_meta['origin'] = "MAGIC"
                mars_meta['input_url'] = file_name
Moritz Huetten's avatar
Moritz Huetten committed
1135

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1136
                mars_meta['number'] = int(
Alessio Berti's avatar
Alessio Berti committed
1137
                    meta_info['MRawRunHeader.fRunNumber'][0])
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1138
                mars_meta['number_subrun'] = int(
Alessio Berti's avatar
Alessio Berti committed
1139
1140
                    meta_info['MRawRunHeader.fSubRunIndex'][0])
                mars_meta['source_ra'] = meta_info['MRawRunHeader.fSourceRA'][0] / \
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1141
                    seconds_per_hour * degrees_per_hour * u.deg