Commit 8397ba82 authored by Jens Kroeger's avatar Jens Kroeger
Browse files

EventLoaderEUDAQ2: update README, improved module description, in particular...

EventLoaderEUDAQ2: update README, improved module description, in particular pointing out the naming scheme for planes: <type>_<number>
parent f9b3585f
......@@ -4,7 +4,25 @@
**Status**: under development
### Description
Correlate EUDAQ2 devices, based on time.
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.
TLU event are not converted into `StandardEvents` but their timestamps can be used directly without conversion.
The detectors need to be named according to the following scheme: `<detector_type>_<plane_number>` where `detector_type` is the type speciefied 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.
The first detector that appears in the configuration defines the event window to which the hits of all other detectors are compared.
In the example below this is the CLICpix2.
For each event, the algorithm checks for an event on the clipboard.
If none is available, the current event defines the event on the clipboard.
Otherwise, it is checked whether or not the current event lies within the clipboard event.
If yes, the corresponding pixels are added to the clipboard for this event.
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.
If no detector is capable of defining events, the `[Metronome]` modele needs to be used.
### Requirements
This module requires an installation of [EUDAQ2](https://eudaq.github.io/). The installation path needs to be set to
......
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