__init__.py 76.4 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
from ctapipe.io.datalevels import DataLevel

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

27
from ctapipe.containers import ArrayEventContainer
28
from ctapipe.containers import PointingContainer, TelescopePointingContainer
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
29
30
31
32
33
34
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
35
from ctapipe.instrument import CameraDescription
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
36

37
38
39

__all__ = ['MAGICEventSource']

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

Ievgen Vovk's avatar
Ievgen Vovk committed
42

43
# MAGIC telescope positions in m wrt. to the center of CTA simulations
44
45
46
47
48
49
#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
50
MAGIC_TEL_POSITIONS = {
51
52
    1: [31.80, -28.10, 0.00] * u.m,
    2: [-31.80, 28.10, 0.00] * u.m
53
}
54

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

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

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

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

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

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

84
85
86
87
88
89
90
91
92
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

Alessio Berti's avatar
Alessio Berti committed
93
    def __init__(self, input_url=None, config=None, parent=None, **kwargs):
94
95
96
97
98
99
100
101
102
        """
        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.
103
        parent : ctapipe.core.Tool
104
105
106
107
108
109
110
111
112
            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.
        """

113
        super().__init__(input_url=input_url, config=config, parent=parent, **kwargs)
114
115

        # Retrieving the list of run numbers corresponding to the data files
116
117
118
        run_info = self.get_run_info_from_name(input_url)
        run_numbers = run_info[0]
        is_mc_runs = run_info[1]
Moritz Huetten's avatar
Moritz Huetten committed
119
120

        self.run_numbers, indices = np.unique(run_numbers, return_index=True)
121
122
        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
123

124
125
        # Checking if runt type (data/MC) is consistent:
        if len(is_mc_runs) > 1:
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
126
127
            raise ValueError(
                "Loaded files contain data and MC runs. Please load only data OR Monte Carlos.")
128
        self.is_mc = is_mc_runs[0]
129

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

133
134
135
136
        # # 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
137
138
        self._subarray_info = SubarrayDescription(
            'MAGIC', MAGIC_TEL_POSITIONS, MAGIC_TEL_DESCRIPTIONS)
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

    @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
165
                import uproot
166
167
168
169
170
171
172
173
174
175

                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
176
                if re.match(r'.+_m\d_.+root', file_path.lower()) is None:
177
178
179
180
181
                    is_magic_root_file = False

        return is_magic_root_file

    @staticmethod
182
    def get_run_info_from_name(file_name):
183
        """
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
184
        This internal method extracts the run number and
Moritz Huetten's avatar
Moritz Huetten committed
185
        type (data/MC) from the specified file name.
186
187
188
189
190
191
192
193
194
195
196
197

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

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

Moritz Huetten's avatar
Moritz Huetten committed
198
        mask_data = r".*\d+_M\d+_(\d+)\.\d+_Y_.*"
Moritz Huetten's avatar
Moritz Huetten committed
199
200
        mask_mc = r".*_M\d_za\d+to\d+_\d_(\d+)_Y_.*"
        mask_mc_alt = r".*_M\d_\d_(\d+)_.*"
201
        if re.findall(mask_data, file_name):
Moritz Huetten's avatar
Moritz Huetten committed
202
203
            parsed_info = re.findall(mask_data, file_name)
            is_mc = False
204
        elif re.findall(mask_mc, file_name):
Moritz Huetten's avatar
Moritz Huetten committed
205
206
207
208
209
            parsed_info = re.findall(mask_mc, file_name)
            is_mc = True
        else:
            parsed_info = re.findall(mask_mc_alt, file_name)
            is_mc = True
210
211
212
213

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

Moritz Huetten's avatar
Moritz Huetten committed
218
        return run_number, is_mc
219

Moritz Huetten's avatar
Moritz Huetten committed
220
    def _set_active_run(self, run_number):
221
222
223
224
225
226
227
228
229
230
        """
        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
231
        MarsRun:
Moritz Huetten's avatar
Moritz Huetten committed
232
            The run to use
233
        """
Moritz Huetten's avatar
Moritz Huetten committed
234

235
236
237
        run = dict()
        run['number'] = run_number
        run['read_events'] = 0
238
        run['data'] = MarsRun(run_file_mask=self.input_url)
239
240
241

        return run

242
243
244
245
    @property
    def subarray(self):
        return self._subarray_info

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
246
247
248
249
250
251
252
253
254
255
256
257
    @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

258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
    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
283
        data = ArrayEventContainer()
284
285
286
287
288
289

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

        # Loop over the available data runs
290
        for run_number in self.run_numbers:
291
292
293
294
295
296

            # 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
297
            # Setting the new active run (class MarsRun object)
Moritz Huetten's avatar
Moritz Huetten committed
298
            self.current_run = self._set_active_run(run_number)
299
            
300
301
            # Set monitoring data:
            if not self.is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
302

303
                monitoring_data = self.current_run['data'].monitoring_data
Moritz Huetten's avatar
Moritz Huetten committed
304

305
306
307
                for tel_i, tel_id in enumerate(tels_in_file):
                    monitoring_camera = MonitoringCameraContainer()
                    pedestal_info = PedestalContainer()
308
                    badpixel_info = PixelStatusContainer()
Moritz Huetten's avatar
Moritz Huetten committed
309

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
310
311
312
313
314
315
                    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
316
                    pedestal_info.charge_mean = []
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
317
318
319
320
321
322
                    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'])
323
                    pedestal_info.charge_std = []
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
324
325
326
327
328
329
330
331
332
333
334
335
                    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
336
                    badpixel_info.sample_time_range = t_range
337

338
                    monitoring_camera.pedestal = pedestal_info
339
                    monitoring_camera.pixel_status = badpixel_info
340
341

                    data.mon.tels_with_data = {1, 2}
342
                    data.mon.tel[tel_i + 1] = monitoring_camera
343
            else:
344
345
                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']
346
                data.mcheader.shower_reuse = self.current_run['data'].mcheader_data['M1']['sim_reuse']
347
348
349
350
351
352
353
                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
354
                else:
355
356
                    data.mcheader.diffuse = False
                    
357

358
359
360
361
362
363
364
365
            # 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
366
367
368
                event_data = self.current_run['data'].get_stereo_event_data(
                    event_i)

369
                data.meta = event_data['mars_meta']
370
371
372

                # Event counter
                data.count = counter
Moritz Huetten's avatar
Moritz Huetten committed
373
374
                data.index.obs_id = obs_id
                data.index.event_id = event_id
375
376
377
378
379
380
381
382
383
384

                # 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
385
386
387
                # Setting up the DL1 container
                data.dl1.tel.clear()

388
                pointing = PointingContainer()
389
390
391
                # Filling the DL1 container with the event data
                for tel_i, tel_id in enumerate(tels_in_file):
                    # Creating the telescope pointing container
392
393
394
                    pointing_tel = TelescopePointingContainer()
                    
                    pointing_tel.azimuth = np.deg2rad(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
395
                        event_data['{:s}_pointing_az'.format(tel_id)]) * u.rad
396
397
                    
                    pointing_tel.altitude = np.deg2rad(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
398
                        90 - event_data['{:s}_pointing_zd'.format(tel_id)]) * u.rad
399
                    
400
                    # pointing.ra = np.deg2rad(
Moritz Huetten's avatar
Moritz Huetten committed
401
                    #    event_data['{:s}_pointing_ra'.format(tel_id)]) * u.rad
402
                    # pointing.dec = np.deg2rad(
Moritz Huetten's avatar
Moritz Huetten committed
403
                    #    event_data['{:s}_pointing_dec'.format(tel_id)]) * u.rad
404

405
                    pointing.tel[tel_i + 1] = pointing_tel
406

Moritz Huetten's avatar
Moritz Huetten committed
407
408
409
410
411
                    # 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]

412
                    # Adding event charge and peak positions per pixel
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
413
414
415
                    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
416
                                 1].peak_time = event_data['{:s}_pulse_time'.format(tel_id)]
417
418
419
420
421
422
                
                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
423

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
424
                if not self.is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
425
                    # Adding the event arrival time
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
426
427
                    time_tmp = Time(
                        event_data['mjd'], scale='utc', format='mjd')
Moritz Huetten's avatar
Moritz Huetten committed
428
                    data.trigger.time = Time(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
429
                        time_tmp, format='unix', scale='utc', precision=9)
Moritz Huetten's avatar
Moritz Huetten committed
430
431
                else:
                    data.mc.energy = event_data['true_energy'] * u.GeV
432
                    data.mc.alt = (np.pi/2 - event_data['true_zd']) * u.rad
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
433
434
435
436
437
                    # 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
438
                    data.mc.h_first_int = event_data['true_h_first_int'] * u.cm
439
440
441
442
443
444
                    
                    # 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
445
446
447
448
449

                # 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
450
                data.trigger.tels_with_trigger = tels_with_data
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

                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
476
        data = ArrayEventContainer()
477
478
479
480
481

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

        if telescope not in tels_in_file:
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
482
483
            raise ValueError("Specified telescope {:s} is not in the allowed list {}".format(
                telescope, tels_in_file))
484
485
486
487
488

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

        # Loop over the available data runs
489
        for run_number in self.run_numbers:
490
491
492
493
494
495
496

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

Moritz Huetten's avatar
Moritz Huetten committed
499
500
            # Set monitoring data:
            if not self.is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
501

Moritz Huetten's avatar
Moritz Huetten committed
502
                monitoring_data = self.current_run['data'].monitoring_data
Moritz Huetten's avatar
Moritz Huetten committed
503

Moritz Huetten's avatar
Moritz Huetten committed
504
505
506
                monitoring_camera = MonitoringCameraContainer()
                pedestal_info = PedestalContainer()
                badpixel_info = PixelStatusContainer()
Moritz Huetten's avatar
Moritz Huetten committed
507

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
508
509
510
511
                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)
512
                pedestal_info.n_events = 500 # hardcoded number of pedestal events averaged over
Moritz Huetten's avatar
Moritz Huetten committed
513
                pedestal_info.charge_mean = []
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
514
515
516
517
518
519
                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
520
                pedestal_info.charge_std = []
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
521
522
523
524
525
526
527
528
529
530
531
532
                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
533
                badpixel_info.sample_time_range = t_range
Moritz Huetten's avatar
Moritz Huetten committed
534

Moritz Huetten's avatar
Moritz Huetten committed
535
536
537
538
539
540
                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

541
             #fdp (mono version not fully tested)
542
543
            else:
                data.mcheader.num_showers = self.current_run['data'].mcheader_data[telescope]['sim_nevents'] # total, including reuse
544
                data.mcheader.shower_reuse = self.current_run['data'].mcheader_data[telescope]['sim_reuse']
545
546
547
548
549
                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
550

551

552
553
554
555
556
557
558
559
560
561
562
563
564
            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
565
566
567
                event_data = self.current_run['data'].get_mono_event_data(
                    event_i, telescope=telescope)

568
                data.meta = event_data['mars_meta']
569
570
571

                # Event counter
                data.count = counter
Moritz Huetten's avatar
Moritz Huetten committed
572
573
                data.index.obs_id = obs_id
                data.index.event_id = event_id
574
575
576

                # Setting up the R0 container
                data.r0.tel.clear()
577
                data.r0.tel[tel_i + 1].trigger_type = self.current_run['data'].event_data[telescope]['trigger_pattern'][event_order_number]
578
579
580

                # Setting up the R1 container
                data.r1.tel.clear()
581
                data.r1.tel[tel_i + 1].trigger_type = self.current_run['data'].event_data[telescope]['trigger_pattern'][event_order_number]
582
583
584

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

Alessio Berti's avatar
Alessio Berti committed
587
588
589
                # Setting up the DL1 container
                data.dl1.tel.clear()

590
                # Creating the telescope pointing container
591
592
593
594
                pointing = PointingContainer()
                pointing_tel = TelescopePointingContainer()

                pointing_tel.azimuth = np.deg2rad(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
595
                    event_data['pointing_az']) * u.rad
596
                pointing_tel.altitude = np.deg2rad(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
597
                    90 - event_data['pointing_zd']) * u.rad
Moritz Huetten's avatar
Moritz Huetten committed
598
599
                #pointing.ra = np.deg2rad(event_data['pointing_ra']) * u.rad
                #pointing.dec = np.deg2rad(event_data['pointing_dec']) * u.rad
600
601
602
603
604
605
606
607
608
                
                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
609
610
611

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

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
614
                if not self.is_mc:
Moritz Huetten's avatar
Moritz Huetten committed
615
                    # Adding the event arrival time
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
616
617
                    time_tmp = Time(
                        event_data['mjd'], scale='utc', format='mjd')
Moritz Huetten's avatar
Moritz Huetten committed
618
                    data.trigger.time = Time(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
619
                        time_tmp, format='unix', scale='utc', precision=9)
Moritz Huetten's avatar
Moritz Huetten committed
620
621
                else:
                    data.mc.energy = event_data['true_energy'] * u.GeV
622
                    data.mc.alt = (np.pi/2 - event_data['true_zd']) * u.rad
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
623
624
625
626
627
                    # 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
628
                    data.mc.h_first_int = event_data['true_h_first_int'] * u.cm
629
630
631
632
633
634

                    # 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
635
636
637
638
639

                # 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
640
                data.trigger.tels_with_trigger = tels_with_data
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665

                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
666
        data = EventAndMonDataContainer()
667
668
669
670
671

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

        if telescope not in tels_in_file:
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
672
673
            raise ValueError("Specified telescope {:s} is not in the allowed list {}".format(
                telescope, tels_in_file))
674
675
676
677
678

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

        # Loop over the available data runs
679
        for run_number in self.run_numbers:
680
681
682
683
684
685
686

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

Moritz Huetten's avatar
Moritz Huetten committed
689
            monitoring_data = self.current_run['data'].monitoring_data
Moritz Huetten's avatar
Moritz Huetten committed
690

Moritz Huetten's avatar
Moritz Huetten committed
691
692
693
            monitoring_camera = MonitoringCameraContainer()
            pedestal_info = PedestalContainer()
            badpixel_info = PixelStatusContainer()
Moritz Huetten's avatar
Moritz Huetten committed
694

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
695
696
697
698
            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)
699
            pedestal_info.n_events = 500 # hardcoded number of pedestal events averaged over
Moritz Huetten's avatar
Moritz Huetten committed
700
            pedestal_info.charge_mean = []
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
701
702
703
704
705
706
            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
707
            pedestal_info.charge_std = []
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
708
709
710
711
712
713
714
715
716
717
718
719
            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
720
            badpixel_info.sample_time_range = t_range
Moritz Huetten's avatar
Moritz Huetten committed
721

Moritz Huetten's avatar
Moritz Huetten committed
722
723
724
725
726
727
            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

728
729
730
731
732
733
734
735
736
737
738
739
740
            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
741
742
743
                event_data = self.current_run['data'].get_pedestal_event_data(
                    event_i, telescope=telescope)

744
                data.meta = event_data['mars_meta']
745
746
747

                # Event counter
                data.count = counter
Moritz Huetten's avatar
Moritz Huetten committed
748
749
                data.index.obs_id = obs_id
                data.index.event_id = event_id
750

751
752
                # Setting up the R0 container
                data.r0.tel.clear()
753
                data.r0.tel[tel_i + 1].trigger_type = self.current_run['data'].event_data[telescope]['trigger_pattern'][event_order_number]
754
755
756

                # Setting up the R1 container
                data.r1.tel.clear()
757
                data.r1.tel[tel_i + 1].trigger_type = self.current_run['data'].event_data[telescope]['trigger_pattern'][event_order_number]
758
759
760

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

                # Creating the telescope pointing container
                pointing = TelescopePointingContainer()
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
765
766
767
768
                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
769
770
                #pointing.ra = np.deg2rad(event_data['pointing_ra']) * u.rad
                #pointing.dec = np.deg2rad(event_data['pointing_dec']) * u.rad
771
772

                # Adding the pointing container to the event data
Moritz Huetten's avatar
Moritz Huetten committed
773
                data.pointing.tel[tel_i + 1] = pointing
774
775
776

                # 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
777
                data.dl1.tel[tel_i + 1].peak_time = event_data['pulse_time']
778
779
780

                # Adding the event arrival time
                time_tmp = Time(event_data['mjd'], scale='utc', format='mjd')
Moritz Huetten's avatar
Moritz Huetten committed
781
                data.trigger.time = Time(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
782
                    time_tmp, format='unix', scale='utc', precision=9)
783
784
785
786
787

                # 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
788
                data.trigger.tels_with_trigger = tels_with_data
789
790
791
792
793
794
795

                yield data
                counter += 1

        return


Moritz Huetten's avatar
Moritz Huetten committed
796
class MarsRun:
797
798
799
800
    """
    This class implements reading of the event data from a single MAGIC data run.
    """

Moritz Huetten's avatar
Moritz Huetten committed
801
    def __init__(self, run_file_mask, filter_list=None):
802
803
804
805
806
807
808
809
810
        """
        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.
811
812
813
        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.
814
815
        """

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
816
        self.n_camera_pixels = GEOM.n_pixels
817

818
819
820
821
        self.run_file_mask = run_file_mask

        # Preparing the lists of M1/2 data files
        file_list = glob.glob(run_file_mask)
822
823
824
825
826

        # 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
827
828
829
830
        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))
831
        self.m1_file_list.sort()
832
833
834
        self.m2_file_list.sort()

        # Retrieving the list of run numbers corresponding to the data files
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
835
        run_info = list(
836
            map(MAGICEventSource.get_run_info_from_name, file_list))
Moritz Huetten's avatar
Moritz Huetten committed
837
        run_numbers = [i[0] for i in run_info]
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
838
        is_mc_runs = [i[1] for i in run_info]
839
840
841

        run_numbers = np.unique(run_numbers)
        is_mc_runs = np.unique(is_mc_runs)
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
842
        # Checking if run type (data/MC) is consistent:
843
        if len(is_mc_runs) > 1:
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
844
845
846
            raise ValueError(
                "Run type is not consistently data or MC: {}".format(is_mc_runs))

847
        self.is_mc = is_mc_runs[0]
848
849
850

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

854
        # Reading the data
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
855
856
857
858
859
        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)

860
        # Getting the event data
861
        self.event_data = dict()
862
863
864
865
866
867
868
        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]
869

870
        # Getting the run-wise MC header data
871
        if self.is_mc:
872
873
874
            self.mcheader_data = dict()
            self.mcheader_data['M1'] = m1_data[2]
            self.mcheader_data['M2'] = m2_data[2]
875

876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
        # 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
912
    def load_events(file_list, is_mc, n_camera_pixels):
913
        """
914
        This method loads events and monitoring data from the pre-defiled file and returns them as a dictionary.
915
916
917
918
919

        Parameters
        ----------
        file_name: str
            Name of the MAGIC calibrated file to use.
920
921
922
923
        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)
924
925
926
927
928
929
930
931

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

        try:
Alessio Berti's avatar
Alessio Berti committed
932
            import uproot
933
934
935
936
937
938
939
940
        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
941
942
943
944
945
946
947
        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
948
        event_data['mars_meta'] = []
949

950
951
        # monitoring information (updated from time to time)
        monitoring_data = dict()
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
952

Moritz Huetten's avatar
Moritz Huetten committed
953
954
        monitoring_data['badpixelinfo'] = []
        monitoring_data['badpixelinfoMJDrange'] = []
Alessio Berti's avatar
Alessio Berti committed
955
        monitoring_data['PedestalMJD'] = np.array([])
956
957
958
959
960
961
962
963
964
965
        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'] = []

966
967
        #MC Header information, dictionary always created, but filled only in case of MC run
        mcheader_data = dict()
968

969
970
        event_data['file_edges'] = [0]

971
972
973
974
975
        # 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

976
977
978
979
980
981
982
        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([])

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

Moritz Huetten's avatar
Moritz Huetten committed
987
        evt_common_list = [
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
988
            'MCerPhotEvt.fPixels.fPhot',
Moritz Huetten's avatar
Moritz Huetten committed
989
990
            'MArrivalTime.fData',
            'MTriggerPattern.fPrescaled',
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
991
            'MRawEvtHeader.fStereoEvtNumber',
Moritz Huetten's avatar
Moritz Huetten committed
992
            'MRawEvtHeader.fDAQEvtNumber',
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
993
994
995
        ]

        # Separately, because only used with pre-processed MARS data
Moritz Huetten's avatar
Moritz Huetten committed
996
997
        # to create MPointingPos container
        pointing_array_list = [
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
998
999
1000
1001
            'MPointingPos.fZd',
            'MPointingPos.fAz',
            'MPointingPos.fRa',
            'MPointingPos.fDec',
Moritz Huetten's avatar
Moritz Huetten committed
1002
            'MPointingPos.fDevZd',
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1003
1004
            'MPointingPos.fDevAz',
            'MPointingPos.fDevHa',
Moritz Huetten's avatar
Moritz Huetten committed
1005
            'MPointingPos.fDevDec',
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1006
1007
        ]

Moritz Huetten's avatar
Moritz Huetten committed
1008
1009
1010
1011
        # Info only applicable for data:
        time_array_list = [
            'MTime.fMjd',
            'MTime.fTime.fMilliSec',
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1012
1013
1014
            'MTime.fNanoSec',
        ]

Moritz Huetten's avatar
Moritz Huetten committed
1015
1016
1017
1018
1019
1020
        drive_array_list = [
            'MReportDrive.fMjd',
            'MReportDrive.fCurrentZd',
            'MReportDrive.fCurrentAz',
            'MReportDrive.fRa',
            'MReportDrive.fDec'
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1021
        ]
Moritz Huetten's avatar
Moritz Huetten committed
1022

1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
        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
1033
        ]
1034

Moritz Huetten's avatar
Moritz Huetten committed
1035
1036
1037
1038
1039
1040
1041
1042
        # Info only applicable for MC:
        mc_list = [
            'MMcEvt.fEnergy',
            'MMcEvt.fTheta',
            'MMcEvt.fPhi',
            'MMcEvt.fPartId',
            'MMcEvt.fZFirstInteraction',
            'MMcEvt.fCoreX',
1043
            'MMcEvt.fCoreY'
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1044
        ]
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
        
        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
1056
1057
1058
1059
1060
1061
1062
1063
1064

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

1066
1067
1068
1069
        for file_name in file_list:

            input_file = uproot.open(file_name)

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

1072
            # Reading the info common to MC and real data
Alessio Berti's avatar
Alessio Berti committed
1073
1074
1075
1076
            charge = events['MCerPhotEvt.fPixels.fPhot']
            arrival_time = events['MArrivalTime.fData']
            trigger_pattern = events['MTriggerPattern.fPrescaled']
            stereo_event_number = events['MRawEvtHeader.fStereoEvtNumber']
1077

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

Moritz Huetten's avatar
Moritz Huetten committed
1081
            mars_meta['is_simulation'] = is_mc
Moritz Huetten's avatar
Moritz Huetten committed
1082

1083
            if is_mc:
Alessio Berti's avatar
Alessio Berti committed
1084
1085
                mc_header_info = input_file['RunHeaders'].arrays(mcheader_list, library="np")
                mcheader_data['sim_nevents']=int(mc_header_info['MMcRunHeader.fNumEvents'][0]) #std: 5000
1086
                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
1087
1088
1089
1090
1091
                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".
1092

Moritz Huetten's avatar
Moritz Huetten committed
1093
1094
            # Reading event timing information:
            if not is_mc:
Alessio Berti's avatar
Alessio Berti committed
1095
                event_times = input_file['Events'].arrays(time_array_list, library="np")
Moritz Huetten's avatar
Moritz Huetten committed
1096
                # Computing the event arrival time
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1097

Alessio Berti's avatar
Alessio Berti committed
1098
1099
1100
                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
1101

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1102
1103
                event_mjd = event_mjd + \
                    (event_millisec / 1e3 + event_nanosec / 1e9) / seconds_per_day
Alessio Berti's avatar
Alessio Berti committed
1104
                event_data['MJD'] = np.concatenate(
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1105
                    (event_data['MJD'], event_mjd))
Moritz Huetten's avatar
Moritz Huetten committed
1106

Moritz Huetten's avatar
Moritz Huetten committed
1107
            # try to read RunHeaders tree (soft fail if not present, to pass current tests)
Moritz Huetten's avatar
Moritz Huetten committed
1108
            try:
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1109
                meta_info = input_file['RunHeaders'].arrays(
Alessio Berti's avatar
Alessio Berti committed
1110
                    metainfo_array_list, library="np")
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1111

Moritz Huetten's avatar
Moritz Huetten committed
1112
1113
                mars_meta['origin'] = "MAGIC"
                mars_meta['input_url'] = file_name
Moritz Huetten's avatar
Moritz Huetten committed
1114

Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1115
                mars_meta['number'] = int(
Alessio Berti's avatar
Alessio Berti committed
1116
                    meta_info['MRawRunHeader.fRunNumber'][0])
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1117
                mars_meta['number_subrun'] = int(
Alessio Berti's avatar
Alessio Berti committed
1118
1119
                    meta_info['MRawRunHeader.fSubRunIndex'][0])
                mars_meta['source_ra'] = meta_info['MRawRunHeader.fSourceRA'][0] / \
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1120
                    seconds_per_hour * degrees_per_hour * u.deg
Alessio Berti's avatar
Alessio Berti committed
1121
                mars_meta['source_dec'] = meta_info['MRawRunHeader.fSourceDEC'][0] / \
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1122
                    seconds_per_hour * u.deg
Moritz Huetten's avatar
Moritz Huetten committed
1123

Alessio Berti's avatar
Alessio Berti committed
1124
                is_mc_check = int(meta_info['MRawRunHeader.fRunType'][0])
Moritz Huetten's avatar
Moritz Huetten committed
1125
1126
1127
1128
                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
1129
1130
                else:
                    msg = "Run type (Data or MC) of MAGIC data file not recognised."
Moritz Huetten's avatar
astyled    
Moritz Huetten committed
1131
                    LOGGER.error(msg)