trgtools.TPReader.TPReader Class Reference

Inheritance diagram for trgtools.TPReader.TPReader:

Collaboration diagram for trgtools.TPReader.TPReader:

Public Member Functions
None	__init__ (self, str filename, int verbosity=0, bool batch_mode=False)
NDArray[tp_dt]	__getitem__ (self, int|str key)
None	__setitem__ (self, int|str key, NDArray[tp_dt] value)
int	__len__ (self)
NDArray	read_fragment (self, str fragment_path)
None	clear_data (self)
Public Member Functions inherited from trgtools.HDF5Reader.HDF5Reader
list[str]	get_fragment_paths (self)
None	set_fragment_paths (self, list[str] fragment_paths)
None	read_all_fragments (self)
None	reset_fragment_paths (self)

Public Attributes
	tp_data = np.array([], dtype=self.tp_dt)
int	tp_data = 2:
Public Attributes inherited from trgtools.HDF5Reader.HDF5Reader
	run_id = self._h5_file.get_int_attribute('run_number')
	file_index = self._h5_file.get_int_attribute('file_index')

Static Public Attributes
	tp_dt

Protected Member Functions
None	_filter_fragment_paths (self)
Protected Member Functions inherited from trgtools.HDF5Reader.HDF5Reader

Protected Attributes
	_fragment_paths = []
Protected Attributes inherited from trgtools.HDF5Reader.HDF5Reader
	_h5_file = HDF5RawDataFile(filename)
	_fragment_paths = self._h5_file.get_all_fragment_dataset_paths()
	_verbosity = verbosity
int	_num_empty = 0
	_batch_mode = batch_mode

Additional Inherited Members
Static Protected Attributes inherited from trgtools.HDF5Reader.HDF5Reader
str	_FAIL_TEXT_COLOR = '\033[91m'
str	_WARNING_TEXT_COLOR = '\033[93m'
str	_BOLD_TEXT = '\033[1m'
str	_END_TEXT_COLOR = '\033[0m'

Detailed Description

Class that reads a given HDF5 data file and can
process the TP fragments within.

Loading fragments appends to :self.tp_data:. The
NumPy dtypes of :self.tp_data: is available as
:TPReader.tp_dt:.

TP reading can print information that is relevant about the
loading process by specifying the verbose level. 0 for errors
only. 1 for warnings. 2 for all information.

Definition at line 13 of file TPReader.py.

Constructor & Destructor Documentation

__init__()

None trgtools.TPReader.TPReader.__init__	(		self,
		str	filename,
		int	verbosity = 0,
		bool	batch_mode = False )

Loads a given HDF5 file.

Parameters:
    filename (str): HDF5 file to open.
    verbosity (int): Verbose level. 0: Only errors. 1: Warnings. 2: All.

Returns nothing.

Reimplemented from trgtools.HDF5Reader.HDF5Reader.

Definition at line 39 of file TPReader.py.

    def __init__(self, filename: str, verbosity: int = 0, batch_mode: bool = False) -> None:
        """
        Loads a given HDF5 file.
 
        Parameters:
            filename (str): HDF5 file to open.
            verbosity (int): Verbose level. 0: Only errors. 1: Warnings. 2: All.
 
        Returns nothing.
        """
        super().__init__(filename, verbosity, batch_mode)
        self.tp_data = np.array([], dtype=self.tp_dt)
        return None
 

Member Function Documentation

__getitem__()

NDArray[tp_dt] trgtools.TPReader.TPReader.__getitem__	(		self,
		int | str	key )

Definition at line 53 of file TPReader.py.

    def __getitem__(self, key: int | str) -> NDArray[tp_dt]:
        return self.tp_data[key]
 

__len__()

int trgtools.TPReader.TPReader.__len__

(

self

)

Definition at line 60 of file TPReader.py.

    def __len__(self) -> int:
        return len(self.tp_data)
 

__setitem__()

None trgtools.TPReader.TPReader.__setitem__	(		self,
		int | str	key,
		NDArray[tp_dt]	value )

Definition at line 56 of file TPReader.py.

    def __setitem__(self, key: int | str, value: NDArray[tp_dt]) -> None:
        self.tp_data[key] = value
        return
 

_filter_fragment_paths()

None trgtools.TPReader.TPReader._filter_fragment_paths ( self )

protected

 Filter the fragment paths for TAs. 

Reimplemented from trgtools.HDF5Reader.HDF5Reader.

Definition at line 63 of file TPReader.py.

    def _filter_fragment_paths(self) -> None:
        """ Filter the fragment paths for TAs. """
        fragment_paths = []
 
        # TA fragment paths contain their name in the path.
        for path in self._fragment_paths:
            if "Trigger_Primitive" in path:
                fragment_paths.append(path)
 
        self._fragment_paths = fragment_paths
        return None
 

clear_data()

None trgtools.TPReader.TPReader.clear_data

(

self

)

 Clear the contents of the member data. 

Reimplemented from trgtools.HDF5Reader.HDF5Reader.

Definition at line 128 of file TPReader.py.

    def clear_data(self) -> None:
        self.tp_data = np.array([], dtype=self.tp_dt)

read_fragment()

NDArray trgtools.TPReader.TPReader.read_fragment	(		self,
		str	fragment_path )

Read from the given data fragment path.

Returns a np.ndarray of the TPs that were read and appends to
:self.tp_data:.

Reimplemented from trgtools.HDF5Reader.HDF5Reader.

Definition at line 75 of file TPReader.py.

    def read_fragment(self, fragment_path: str) -> NDArray:
        """
        Read from the given data fragment path.
 
        Returns a np.ndarray of the TPs that were read and appends to
        :self.tp_data:.
        """
        if self._verbosity >= 2:
            print("="*60)
            print(f"INFO: Reading from the path\n{fragment_path}")
 
        fragment = self._h5_file.get_frag(fragment_path)
        fragment_data_size = fragment.get_data_size()
 
        if fragment_data_size == 0:
            self._num_empty += 1
            if self._verbosity >= 1:
                print(
                        self._FAIL_TEXT_COLOR
                        + self._BOLD_TEXT
                        + "WARNING: Empty fragment. Returning empty array."
                        + self._END_TEXT_COLOR
                )
                print("="*60)
            return np.array([], dtype=self.tp_dt)
 
        tp_size = trgdataformats.TriggerPrimitive.sizeof()
        num_tps = fragment_data_size // tp_size
        if self._verbosity >= 2:
            print(f"INFO: Loaded fragment with {num_tps} TPs.")
 
        np_tp_data = np.zeros((num_tps,), dtype=self.tp_dt)
        for idx, byte_idx in enumerate(range(0, fragment_data_size, tp_size)):  # Increment by TP size
            tp_datum = trgdataformats.TriggerPrimitive(fragment.get_data(byte_idx))
 
            np_tp_data[idx] = np.array([(
                                    tp_datum.adc_integral,
                                    tp_datum.adc_peak,
                                    tp_datum.channel,
                                    tp_datum.detid,
                                    tp_datum.flag,
                                    tp_datum.samples_over_threshold,
                                    tp_datum.samples_to_peak,
                                    tp_datum.time_start,
                                    tp_datum.version)],
                                    dtype=self.tp_dt)
        self.tp_data = np.hstack((self.tp_data, np_tp_data))
 
        if self._verbosity >= 2:
            print("INFO: Finished reading.")
            print("="*60)
        return np_tp_data
 

Member Data Documentation

_fragment_paths

trgtools.TPReader.TPReader._fragment_paths = []

protected

Definition at line 68 of file TPReader.py.

tp_data [1/2]

trgtools.TPReader.TPReader.tp_data = np.array([], dtype=self.tp_dt)

Definition at line 50 of file TPReader.py.

tp_data [2/2]

int trgtools.TPReader.TPReader.tp_data = 2:

Definition at line 121 of file TPReader.py.

tp_dt

trgtools.TPReader.TPReader.tp_dt

static

Initial value:

=  np.dtype([
                      ('adc_integral', np.uint32),
                      ('adc_peak', np.uint16),
                      ('channel', np.uint32),
                      ('detid', np.uint8),
                      ('flag', np.uint8),
                      ('samples_over_threshold', np.uint16),
                      ('samples_to_peak', np.uint16),
                      ('time_start', np.uint64),
                      ('version', np.uint8)
                     ])

Definition at line 27 of file TPReader.py.

---

The documentation for this class was generated from the following file:

• /github/workspace/dunedaq/sourcecode/trgtools/python/trgtools/TPReader.py