Inheritance diagram for trgtools.HDF5Reader.HDF5Reader:

Collaboration diagram for trgtools.HDF5Reader.HDF5Reader:

Public Member Functions
None	__init__ (self, str filename, int verbosity=0, bool batch_mode=False)

list[str]	get_fragment_paths (self)

None	set_fragment_paths (self, list[str] fragment_paths)

None	read_fragment (self, str fragment_path)

None	read_all_fragments (self)

None	clear_data (self)

None	reset_fragment_paths (self)

Public Attributes
	run_id = self._h5_file.get_int_attribute('run_number')

	file_index = self._h5_file.get_int_attribute('file_index')

Protected Member Functions
None	_filter_fragment_paths (self)

Protected Attributes
	_h5_file = HDF5RawDataFile(filename)

	_fragment_paths = self._h5_file.get_all_fragment_dataset_paths()

	_verbosity = verbosity

int	_num_empty = 0

	_batch_mode = batch_mode

Static Protected Attributes
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

Abstract reader class for HDF5 files.

Derived classes must complete all methods
decorated with @abc.abstractmethod.

Definition at line 10 of file HDF5Reader.py.

Constructor & Destructor Documentation

◆ init()

None trgtools.HDF5Reader.HDF5Reader.__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 in trgtools.TAReader.TAReader, trgtools.TCReader.TCReader, and trgtools.TPReader.TPReader.

Definition at line 25 of file HDF5Reader.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.
        """
        # Generic loading
        self._h5_file = HDF5RawDataFile(filename)
        self._fragment_paths = self._h5_file.get_all_fragment_dataset_paths()
        self.run_id = self._h5_file.get_int_attribute('run_number')
        self.file_index = self._h5_file.get_int_attribute('file_index')
 
        self._verbosity = verbosity
 
        self._filter_fragment_paths()  # Derived class must define this.
 
        self._num_empty = 0  # Counts the number of empty fragments.
 
        self._batch_mode = batch_mode
 
        return None
 

Member Function Documentation

◆ _filter_fragment_paths()

None trgtools.HDF5Reader.HDF5Reader._filter_fragment_paths ( self )

protected

Filter the fragment paths of interest.

This should be according to the derived reader's
data type of interest, e.g., filter for TriggerActivity.

Reimplemented in trgtools.TAReader.TAReader, trgtools.TCReader.TCReader, and trgtools.TPReader.TPReader.

Definition at line 52 of file HDF5Reader.py.

    def _filter_fragment_paths(self) -> None:
        """
        Filter the fragment paths of interest.
 
        This should be according to the derived reader's
        data type of interest, e.g., filter for TriggerActivity.
        """
        ...
 

◆ clear_data()

None trgtools.HDF5Reader.HDF5Reader.clear_data ( self )

 Clear the contents of the member data.

Reimplemented in trgtools.TAReader.TAReader, trgtools.TCReader.TCReader, and trgtools.TPReader.TPReader.

Definition at line 93 of file HDF5Reader.py.

    def clear_data(self) -> None:
        """ Clear the contents of the member data. """
        ...
 

◆ get_fragment_paths()

list[str] trgtools.HDF5Reader.HDF5Reader.get_fragment_paths ( self )

 Return the list of fragment paths.

Definition at line 61 of file HDF5Reader.py.

    def get_fragment_paths(self) -> list[str]:
        """ Return the list of fragment paths. """
        return list(self._fragment_paths)
 

◆ read_all_fragments()

None trgtools.HDF5Reader.HDF5Reader.read_all_fragments ( self )

 Read all fragments.

Definition at line 75 of file HDF5Reader.py.

    def read_all_fragments(self) -> None:
        """ Read all fragments. """
        for fragment_path in tqdm(self._fragment_paths, desc='Reading all the fragments', disable=self._batch_mode):
            _ = self.read_fragment(fragment_path)
 
        # self.read_fragment should increment self._num_empty.
        # Print how many were empty as a debug.
        if self._verbosity >= 1 and self._num_empty != 0:
            print(
                    self._FAIL_TEXT_COLOR
                    + self._BOLD_TEXT
                    + f"WARNING: Skipped {self._num_empty} frags."
                    + self._END_TEXT_COLOR
            )
 
        return None
 

◆ read_fragment()

None trgtools.HDF5Reader.HDF5Reader.read_fragment	(		self,
		str	fragment_path )

 Read one fragment from :fragment_path:.

Reimplemented in trgtools.TAReader.TAReader, trgtools.TCReader.TCReader, and trgtools.TPReader.TPReader.

Definition at line 71 of file HDF5Reader.py.

    def read_fragment(self, fragment_path: str) -> None:
        """ Read one fragment from :fragment_path:. """
        ...
 

◆ reset_fragment_paths()

None trgtools.HDF5Reader.HDF5Reader.reset_fragment_paths ( self )

 Reset the fragment paths to the initialized state.

Definition at line 97 of file HDF5Reader.py.

    def reset_fragment_paths(self) -> None:
        """ Reset the fragment paths to the initialized state. """
        self._fragment_paths = self._h5_file.get_all_fragment_dataset_paths()
        self._filter_fragment_paths()

◆ set_fragment_paths()

None trgtools.HDF5Reader.HDF5Reader.set_fragment_paths	(		self,
		list[str]	fragment_paths )

 Set the list of fragment paths.

Definition at line 65 of file HDF5Reader.py.

    def set_fragment_paths(self, fragment_paths: list[str]) -> None:
        """ Set the list of fragment paths. """
        self._fragment_paths = fragment_paths
        return None
 

Member Data Documentation

◆ _batch_mode

trgtools.HDF5Reader.HDF5Reader._batch_mode = batch_mode

protected

Definition at line 47 of file HDF5Reader.py.

◆ _BOLD_TEXT

str trgtools.HDF5Reader.HDF5Reader._BOLD_TEXT = '\033[1m'

staticprotected

Definition at line 21 of file HDF5Reader.py.

◆ _END_TEXT_COLOR

str trgtools.HDF5Reader.HDF5Reader._END_TEXT_COLOR = '\033[0m'

staticprotected

Definition at line 22 of file HDF5Reader.py.

◆ _FAIL_TEXT_COLOR

str trgtools.HDF5Reader.HDF5Reader._FAIL_TEXT_COLOR = '\033[91m'

staticprotected

Definition at line 19 of file HDF5Reader.py.

◆ _fragment_paths

trgtools.HDF5Reader.HDF5Reader._fragment_paths = self._h5_file.get_all_fragment_dataset_paths()

protected

Definition at line 37 of file HDF5Reader.py.

◆ _h5_file

trgtools.HDF5Reader.HDF5Reader._h5_file = HDF5RawDataFile(filename)

protected

Definition at line 36 of file HDF5Reader.py.

◆ _num_empty

int trgtools.HDF5Reader.HDF5Reader._num_empty = 0

protected

Definition at line 45 of file HDF5Reader.py.

◆ _verbosity

trgtools.HDF5Reader.HDF5Reader._verbosity = verbosity

protected

Definition at line 41 of file HDF5Reader.py.

◆ _WARNING_TEXT_COLOR

str trgtools.HDF5Reader.HDF5Reader._WARNING_TEXT_COLOR = '\033[93m'

staticprotected

Definition at line 20 of file HDF5Reader.py.

◆ file_index

trgtools.HDF5Reader.HDF5Reader.file_index = self._h5_file.get_int_attribute('file_index')

Definition at line 39 of file HDF5Reader.py.

◆ run_id

trgtools.HDF5Reader.HDF5Reader.run_id = self._h5_file.get_int_attribute('run_number')

Definition at line 38 of file HDF5Reader.py.

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

/github/workspace/dunedaq/sourcecode/trgtools/python/trgtools/HDF5Reader.py

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _filter_fragment_paths()

◆ clear_data()

◆ get_fragment_paths()

◆ read_all_fragments()

◆ read_fragment()

◆ reset_fragment_paths()

◆ set_fragment_paths()

Member Data Documentation

◆ _batch_mode

◆ _BOLD_TEXT

◆ _END_TEXT_COLOR

◆ _FAIL_TEXT_COLOR

◆ _fragment_paths

◆ _h5_file

◆ _num_empty

◆ _verbosity

◆ _WARNING_TEXT_COLOR

◆ file_index

◆ run_id

◆ init()