Commit b2b06d5c authored by Simon Spannagel's avatar Simon Spannagel
Browse files

Merge branch 'improve_eventloadereudaq2_readme' into 'master'

Improve EventLoaderEUDAQ2 README

See merge request !271
parents 222a7f2e af656aee
Pipeline #1530575 passed with stages
in 28 minutes and 34 seconds
......@@ -4,10 +4,10 @@
**Status**: Functional
### Description
This module allows data recorded by EUDAQ2 and stored in a EUDAQ2 binary file as raw detector data to be read into Corryvreckan.
For each detector type, the corresponding converter module in EUDAQ2 is used to transform the data into the `StandardPlane` event type before storing the individual `Pixel` objects on the Corryvreckan clipboard.
This module allows data recorded by [EUDAQ2](https://github.com/eudaq/eudaq/) and stored in a EUDAQ2 binary file as raw detector data to be read into Corryvreckan.
For each detector type, the corresponding converter module implemented in EUDAQ2 is used to transform the data into the `StandardPlane` event type before storing the individual `Pixel` objects on the Corryvreckan clipboard.
The detectors need to be named according to the following scheme: `<detector_type>_<plane_number>` where `detector_type` is the type specified in the detectors file and `<plane_number>` is an iterative number over the planes of the same type.
The detectors need to be named according to the following scheme: `<detector_type>_<plane_number>` where `<detector_type>` is the type specified in the detectors file and `<plane_number>` is an iterative number over the planes of the same type.
If the data of different detectors is stored in separate files, the parameters `name` or `type` can be used as shown in the usage example below.
It should be noted that the order of the detectors is crucial.
......@@ -26,13 +26,13 @@ If earlier, the next event is read until a matching event is found.
If later, the pointer to this event is kept and it continues with the next detector.
Data from detectors with both triggered readout and without timestamps are matched against trigger IDs stored in the currently defined Corryvreckan event.
In case of a match, the timestamp of the respective trigger is assigned to all pixels of the device.
If no timestamp is available for the individual pixels, the pixel timestamp is set as the centre of the EUDAQ2 event.
If no detector is capable of defining events, the `[Metronome]` model needs to be used.
If no detector is capable of defining events, the `[Metronome]` module needs to be used.
Tags stores in the EUDAQ2 event header are read, a conversion to a double value is attempted and, if successful, a profile with the value over the number of events in the respective run is automatically allocated and filled. This feature can e.g. be used to log temperatures of the devices during data taking, simply storing the temperature as event tags.
Tags stored in the EUDAQ2 event header are read, a conversion to a double value is attempted and, if successful, a profile with the value over the number of events in the respective run is automatically allocated and filled.
This feature can e.g. be used to log temperatures of the devices during data taking, simply storing the temperature as event tags.
### Requirements
This module requires an installation of [EUDAQ2](https://eudaq.github.io/). The installation path needs to be set to
......@@ -54,6 +54,9 @@ For instance, to allow decoding of Caribou data, the respective EUDAQ2 module ha
```bash
cmake -DUSER_CARIBOU_BUILD=ON ..
```
__Note:__
It is important to make sure that the same compiler version is used for the installation of Corryvreckan and all its dependencies such as EUDAQ2 (if enabled).
On `lxplus` this is achieved by running `source path/to/corryvreckan/etc/setup_lxplus.sh` before beginning the installation.
### Contract between EUDAQ Decoder and EventLoader
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment