from __future__ import absolute_import, division, print_function, unicode_literals
from NuRadioReco.modules.base.module import register_run
from NuRadioReco.modules.io import NuRadioRecoio
import logging
logger = logging.getLogger('NuRadioReco.eventReader')
[docs]
class eventReader:
"""
read events from file
"""
def __init__(self):
self.__fin = None
[docs]
def begin(self, filename, read_detector=False, log_level=logging.NOTSET):
"""
Setup function for the eventReader module
Parameters
----------
filename: array if strings
names of the input files
read_detector: boolean
If True, the eventReader will parse the detector description and event event headers
in the event files. This is necessary to use the get_detector functions
log_level: logging enum
"""
self.__fin = NuRadioRecoio.NuRadioRecoio(filename, parse_header=read_detector, log_level=log_level)
[docs]
@register_run()
def run(self):
return self.__fin.get_events()
[docs]
def close(self):
""" Close all input files. Safe to call multiple times and before ``begin()``. """
if self.__fin is not None:
self.__fin.close_files()
[docs]
def end(self):
self.close()
[docs]
def get_detector(self):
"""
If read_detector was set True in the begin() function, this function return
the detector description (assuming there is one in the files). If several
files with different detectors are read, the detector for the last returned
event is given.
"""
return self.__fin.get_detector()