Public Member Functions |
Public Attributes |
Static Public Attributes |
Protected Member Functions |
Protected Attributes |
List of all members
trgtools.TAReader.TAReader Class Reference
Inheritance diagram for trgtools.TAReader.TAReader:
Collaboration diagram for trgtools.TAReader.TAReader:
Public Member Functions | |
| None | __init__ (self, str filename, int verbosity=0, bool batch_mode=False) |
| NDArray[ta_dt] | __getitem__ (self, int|str key) |
| None | __setitem__ (self, int|str key, NDArray[ta_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 | |
| ta_data = np.array([], dtype=self.ta_dt) | |
| list | tp_data = [] |
| 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 | |
| ta_dt | |
| 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 TA fragments within. Loading fragments appends to :self.ta_data: and :self.tp_data:. NumPy dtypes of :self.ta_data: and :self.tp_data: are available as :TAReader.ta_dt: and :TAReader.tp_dt:. TA 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 TAReader.py.
Constructor & Destructor Documentation
◆ __init__()
| None trgtools.TAReader.TAReader.__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 57 of file TAReader.py.
57 def __init__(self, filename: str, verbosity: int = 0, batch_mode: bool = False) -> None:
58 """
59 Loads a given HDF5 file.
60
61 Parameters:
62 filename (str): HDF5 file to open.
63 verbosity (int): Verbose level. 0: Only errors. 1: Warnings. 2: All.
64
65 Returns nothing.
66 """
67 super().__init__(filename, verbosity, batch_mode)
68 self.ta_data = np.array([], dtype=self.ta_dt)
69 self.tp_data = []
70 return None
71
Member Function Documentation
◆ __getitem__()
| NDArray[ta_dt] trgtools.TAReader.TAReader.__getitem__ | ( | self, | |
| int | str | key ) |
Definition at line 72 of file TAReader.py.
72 def __getitem__(self, key: int | str) -> NDArray[ta_dt]:
73 return self.ta_data[key]
74
◆ __len__()
| int trgtools.TAReader.TAReader.__len__ | ( | self | ) |
Definition at line 79 of file TAReader.py.
79 def __len__(self) -> int:
80 return len(self.ta_data)
81
◆ __setitem__()
| None trgtools.TAReader.TAReader.__setitem__ | ( | self, | |
| int | str | key, | ||
| NDArray[ta_dt] | value ) |
Definition at line 75 of file TAReader.py.
75 def __setitem__(self, key: int | str, value: NDArray[ta_dt]) -> None:
76 self.ta_data[key] = value
77 return
78
◆ _filter_fragment_paths()
|
protected |
Filter the fragment paths for TAs.
Reimplemented from trgtools.HDF5Reader.HDF5Reader.
Definition at line 82 of file TAReader.py.
82 def _filter_fragment_paths(self) -> None:
83 """ Filter the fragment paths for TAs. """
84 fragment_paths = []
85
86 # TA fragment paths contain their name in the path.
87 for path in self._fragment_paths:
88 if "Trigger_Activity" in path:
89 fragment_paths.append(path)
90
91 self._fragment_paths = fragment_paths
92 return None
93
◆ clear_data()
| None trgtools.TAReader.TAReader.clear_data | ( | self | ) |
Clear the contents of the member data.
Reimplemented from trgtools.HDF5Reader.HDF5Reader.
Definition at line 173 of file TAReader.py.
173 def clear_data(self) -> None:
174 self.ta_data = np.array([], dtype=self.ta_dt)
175 self.tp_data = []
◆ read_fragment()
| NDArray trgtools.TAReader.TAReader.read_fragment | ( | self, | |
| str | fragment_path ) |
Read from the given data fragment path. Returns a np.ndarray of the first TA that was read and appends all TAs in the fragment to :self.ta_data:.
Reimplemented from trgtools.HDF5Reader.HDF5Reader.
Definition at line 94 of file TAReader.py.
94 def read_fragment(self, fragment_path: str) -> NDArray:
95 """
96 Read from the given data fragment path.
97
98 Returns a np.ndarray of the first TA that was read and appends all TAs in the fragment to :self.ta_data:.
99 """
100 if self._verbosity >= 2:
101 print("="*60)
102 print(f"INFO: Reading from the path\n{fragment_path}")
103
104 fragment = self._h5_file.get_frag(fragment_path)
105 fragment_data_size = fragment.get_data_size()
106
107 if fragment_data_size == 0:
108 self._num_empty += 1
109 if self._verbosity >= 1:
110 print(
111 self._FAIL_TEXT_COLOR
112 + self._BOLD_TEXT
113 + "WARNING: Empty fragment. Returning empty array."
114 + self._END_TEXT_COLOR
115 )
116 print("="*60)
117 return np.array([], dtype=self.ta_dt)
118
119 ta_idx = 0 # Debugging output.
120 byte_idx = 0 # Variable TA sizing, must do while loop.
121 while byte_idx < fragment_data_size:
122 if self._verbosity >= 2:
123 print(f"INFO: Fragment Index: {ta_idx}.")
124 ta_idx += 1
125 print(f"INFO: Byte Index / Frag Size: {byte_idx} / {fragment_data_size}")
126
127 # Read TA data
128 ta_datum = trgdataformats.TriggerActivity(fragment.get_data(byte_idx))
129 np_ta_datum = np.array([(
130 ta_datum.data.adc_integral,
131 ta_datum.data.adc_peak,
132 ta_datum.data.algorithm,
133 ta_datum.data.channel_end,
134 ta_datum.data.channel_peak,
135 ta_datum.data.channel_start,
136 np.uint16(ta_datum.data.detid),
137 ta_datum.n_inputs(),
138 ta_datum.data.time_activity,
139 ta_datum.data.time_end,
140 ta_datum.data.time_peak,
141 ta_datum.data.time_start,
142 ta_datum.data.type,
143 np.uint16(ta_datum.data.version))],
144 dtype=self.ta_dt)
145
146 self.ta_data = np.hstack((self.ta_data, np_ta_datum))
147
148 byte_idx += ta_datum.sizeof()
149 if self._verbosity >= 2:
150 print(f"INFO: Upcoming byte index: {byte_idx}")
151
152 # Process TP data
153 np_tp_data = np.zeros(np_ta_datum['num_tps'], dtype=self.tp_dt)
154 for tp_idx, tp in enumerate(ta_datum):
155 np_tp_data[tp_idx] = np.array([(
156 tp.adc_integral,
157 tp.adc_peak,
158 tp.channel,
159 tp.detid,
160 tp.flag,
161 tp.samples_over_threshold,
162 tp.samples_to_peak,
163 tp.time_start,
164 tp.version)],
165 dtype=self.tp_dt)
166 self.tp_data.append(np_tp_data) # Jagged array
167
168 if self._verbosity >= 2:
169 print("INFO: Finished reading.")
170 print("="*60)
171 return np_ta_datum
172
Member Data Documentation
◆ _fragment_paths
|
protected |
Definition at line 87 of file TAReader.py.
◆ ta_data
| trgtools.TAReader.TAReader.ta_data = np.array([], dtype=self.ta_dt) |
Definition at line 68 of file TAReader.py.
◆ ta_dt
|
static |
Initial value:
= np.dtype([
('adc_integral', np.uint64),
('adc_peak', np.uint64),
('algorithm', trgdataformats.TriggerActivityData.Algorithm),
('channel_end', np.int32),
('channel_peak', np.int32),
('channel_start', np.int32),
('detid', np.uint16),
('num_tps', np.uint64), # Greedy
('time_activity', np.uint64),
('time_end', np.uint64),
('time_peak', np.uint64),
('time_start', np.uint64),
('type', trgdataformats.TriggerActivityData.Type),
('version', np.uint16)
])
Definition at line 27 of file TAReader.py.
◆ tp_data
| list trgtools.TAReader.TAReader.tp_data = [] |
Definition at line 69 of file TAReader.py.
◆ 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 45 of file TAReader.py.
The documentation for this class was generated from the following file:
- /github/workspace/dunedaq/sourcecode/trgtools/python/trgtools/TAReader.py
Generated on Sat Jun 28 2025 for DUNE-DAQ by
1.12.0