Skip to content
Snippets Groups Projects
reader.py 5.21 KiB
Newer Older
Zineb Aly's avatar
Zineb Aly committed
import uproot

class AanetReader:

    def __init__(self, file_path: str):
        self.file_path = file_path
        self.data = uproot.open(self.file_path)['E']
        self.lazy_data = self.data.lazyarrays()
        self._valid_keys = None
        self._hits_keys = None
        self._tracks_keys = None

    def read_event(self, key: str):
        """event_reader function reads data stored in a branch of interest in an event tree.
        
        Parameters
        ----------
        key : str
            name of the branch of interest in event data.
        
        Returns
        -------
        lazyarray
            Lazyarray of all data stored in a branch of interest (in an event tree). A lazyarray is an array-like
            object that reads data on demand. Here, only the first and last chunks of data are 
            read in memory, and not all data in the array. The output of event_reader can be used
            with all `Numpy's universal functions <https://docs.scipy.org/doc/numpy/reference/ufuncs.html>`.
        
        Raises
        ------
        NameError
            Some branches in an Aanet file structure are "fake branches" and do not contain data. Therefore,
            the keys corresponding to these fake branches are not read.
        """
        evt_tree = self.data['Evt']
        evt_keys = self._event_keys(evt_tree)
        if key in evt_keys:
            evt_key_lazy = self.lazy_data[key]
            return evt_key_lazy
        else:
            raise KeyError(f"{key} could not be found or is a fake branch")

    def read_hits(self, key: str):
        """hits_reader function reads data stored in a branch of interest in hits tree from an Aanet
        event file.
        
        Parameters
        ----------
        hits_key : str
            name of the branch of interest in hits tree.
        
        Returns
        -------
        lazyarray
            Lazyarray of all data stored in a branch of interest (in hits tree). A lazyarray is an array-like
            object that reads data on demand. Here, only the first and last chunks of data are 
            read in memory, and not all data in the array. The output of event_reader can be used
            with all `Numpy's universal functions <https://docs.scipy.org/doc/numpy/reference/ufuncs.html>`.
        
        Raises
        ------
        NameError
            the hits.key stored in an Aanet file must be used to access the branch of interest
            from hits tree data.
        """
        hits_tree = self.data['Evt']['hits']
        keys = [key.decode('utf8') for key in hits_tree.keys()]
        if key in keys:
            hits_key_lazy = self.lazy_data[key]
            return hits_key_lazy
        else:
            raise KeyError(f"{key} is not a valid hits key")

    def read_tracks(self, key: str):
        """tracks_reader function reads data stored in a branch of interest in tracks tree
        from an Aanet event file.
        
        Parameters
        ----------
        tracks_key : str
            name of the branch of interest in tracks tree.
        
        Returns
        -------
        lazyarray
            Lazyarray of all data stored in a branch of interest (in tracks tree). A lazyarray is an array-like
            object that reads data on demand. Here, only the first and last chunks of data are 
            read in memory, and not all data in the array. The output of event_reader can be used
            with all `Numpy's universal functions <https://docs.scipy.org/doc/numpy/reference/ufuncs.html>`.
        
        Raises
        ------
        NameError
            the trks.key stored in an Aanet file must be used to access the branch of interest
            from tracks tree data.
        """
        tracks_tree = self.data['Evt']['trks']
        keys = [key.decode('utf8') for key in tracks_tree.keys()]
        if key in keys:
            tracks_key_lazy = self.lazy_data[key]
            return tracks_key_lazy
        else:
            raise KeyError(f"{key} is not a valid tracks key")

    @property
    def valid_keys(self, evt_tree):
        """_event_keys function returns a list of all the keys of interest
            for data analysis, and removes the keys of empty "fake branches" 
            found in Aanet event files. 
        
        Parameters
        ----------
        evt_tree : aanet event (Evt) tree.
        
        Returns
        -------
        list of str
            list of all the event keys.
        """
        if self._valid_keys is None:
            fake_branches = ['Evt', 'AAObject', 'TObject','t']
            t_baskets = ['t.fSec', 't.fNanoSec']
            self._valid_keys = [key.decode('utf-8') for key in evt_tree.keys() if key.decode('utf-8') not in fake_branches] + t_baskets
        return self._valid_keys

    @property
    def get_hits_keys(self):
Tamas Gal's avatar
Tamas Gal committed
        if self._hits_keys is None:
Zineb Aly's avatar
Zineb Aly committed
            hits_tree = self.data['Evt']['hits']
            self._hits_keys = [key.decode('utf8') for key in hits_tree.keys()]
        return self._hits_keys

    @property
    def get_tracks_keys(self):
Tamas Gal's avatar
Tamas Gal committed
        if self._tracks_keys is None:
Zineb Aly's avatar
Zineb Aly committed
            tracks_tree = self.data['Evt']['trks']
            self._tracks_keys = [key.decode('utf8') for key in tracks_tree.keys()]
        return self._tracks_keys