Commit eae7eb4d authored by Lennart Huth's avatar Lennart Huth
Browse files

working on the readme

parent ebee1079
......@@ -13,8 +13,16 @@ However, the converter only returns all pixels after the pivot pixel of the
first frame and those before the pivot pixel of the second frame.
Event definition example:
If a triggerID has a TLU event from 425.000us to 425.025us (default
25 ns events) and the pivot pixel-row is 512 the event will be defined as:
For a triggerID that has a TLU event from 425.000us to 425.025us (default
25 ns events)
and the pivot pixel-row is p the event will be defined as:
```
\math
begin = 425.0125 us - (p * (115.2 / 576)) us
end = begin + 230us
```
It should be noted that in about 1 permille of the cases, zero triggers per event are
observed, which should in principle not be possible.
......@@ -24,10 +32,6 @@ This causes that in about 1 permille of the cases, the "time before" and
"time after" a trigger spanning the event is not set correctly when the
pivot pixel is close to its roll-over.
```math
begin = 125.012.5us - (512 * (115.2 / 576)) us
end = begin + 230us
```
### Parameters
* `detector_event_time`: Specify the detector type used to define the event timestamp.
......@@ -37,7 +41,7 @@ end = begin + 230us
* `shift_triggers`: Shift the trigger ID of the `detector_event_time`. This allows to correct trigger ID offsets between different devices such as the TLU and MIMOSA26. Note that if using the module `EventLoaderEUDAQ2` the same value for `shift_triggers` needs to be passed in both cases. Defaults to `0`.
* `skip_time`: Time that can be skipped at the start of a run. All events with earlier timestamps are discarded. Default is `0ms`.
* `eudaq_loglevel`: Verbosity level of the EUDAQ logger instance of the converter module. Possible options are, in decreasing severity, `USER`, `ERROR`, `WARN`, `INFO`, `EXTRA` and `DEBUG`. The default level is `ERROR`. Please note that the EUDAQ verbosity can only be changed globally, i.e. when using instances of `EventLoaderEUDAQ2` below this module, the last occurrence will determine the (global) value of this parameter.
* `add_trigger`: Option to directly add the trigger of the TLU to the event. If this option is selected, the event length is defined to be 3*115.2us - with 115.2us before the trigger timestamp and 230.4us after it. Defaults to `false`
In addition, parameters can be forwarded to the EUDAQ2 event converters.
Please refer to the README of the `EventLoaderEUDAQ2` for more details.
......@@ -53,5 +57,6 @@ detector_event_time = TLU
file_timestamp = tlu_data.raw
file_duration = mimosa_data.raw
time_shift = 0
shift_triggers = -1
shift_triggers = 1
add_trigger = false
```
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