Skip to content
Snippets Groups Projects
Commit 42878e85 authored by Christian Bespin's avatar Christian Bespin
Browse files

Adjust variable names and add info on timestamp unit

parent 41353243
No related branches found
No related tags found
No related merge requests found
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
### Description ### Description
This module loads data from hdf5 files and adds it to the clipboard. The input file must have extension `.h5` without any compression filters and follow the structure below: This module loads data from hdf5 files and adds it to the clipboard. The input file must have extension `.h5` without any compression filters and follow the structure below:
| column | row | charge | timestamp | trigger_number | | column | row | charge | timestamp \[ns\] | trigger_number |
|:------:|:-----:|:------:|:--------------------:|:--------------:| |:------:|:-----:|:------:|:--------------------:|:--------------:|
| `int` | `int` | `int` | `unsigned long long` | `unsigned int` | | `int` | `int` | `int` | `unsigned long long` | `unsigned int` |
...@@ -21,8 +21,8 @@ The module is capable of defining an event as well as adding records based on ti ...@@ -21,8 +21,8 @@ The module is capable of defining an event as well as adding records based on ti
### Parameters ### Parameters
* `filename`: Input file name. * `filename`: Input file name.
* `dataset_name`: Name of the node in the hdf5 file. * `dataset_name`: Name of the node in the hdf5 file.
* `buffer_size`: Buffer size for chunking. * `buffer_depth`: Buffer size (entries) for chunking. Default is 100,000.
* `event_length`: Duration of the event if this module is the first event loader and defines the event. Ignored otherwise. * `event_length`: Duration of the event if this module is the first event loader and defines the event. Defaults to `1 us`.
* `sync_by_trigger`: Add records to the clipboard based on its trigger instead of timestamp. This requires an event definition with trigger information and can therefore not be used as first event loader. * `sync_by_trigger`: Add records to the clipboard based on its trigger instead of timestamp. This requires an event definition with trigger information and can therefore not be used as first event loader.
* `timestamp_shift`: Shift the timestamp of the record by the defined value in nanoseconds. * `timestamp_shift`: Shift the timestamp of the record by the defined value in nanoseconds.
* `trigger_shift`: Shift the trigger of the record by the defined value. * `trigger_shift`: Shift the trigger of the record by the defined value.
...@@ -37,6 +37,6 @@ The following plots are produced: ...@@ -37,6 +37,6 @@ The following plots are produced:
### Usage ### Usage
```toml ```toml
[EventLoaderHDF5] [EventLoaderHDF5]
input_directory = "path/to/file" filename = "path/to/file"
dataset_name = "Hits" dataset_name = "Hits"
``` ```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment