Commit ae0f0977 authored by Jens Kroeger's avatar Jens Kroeger
Browse files

EventLoaderATLASpix: adding documentation about legacy_data to README

parent 4976b32f
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
**Status**: Functional **Status**: Functional
### Description ### Description
This module reads in data for the ATLASpix device from an input file created by the CaRIBou readout system. It supports binary output format. This module reads in data for the ATLASpix device from an input file created by the Caribou readout system. It supports binary output format.
The module opens and reads one data file named `data.bin` in the specified input directory. For each hit it, stores the detectorID, row, column, and ToT. The module opens and reads one data file named `data.bin` in the specified input directory. For each hit it, stores the detectorID, row, column, and ToT.
...@@ -13,6 +13,7 @@ This module requires either another event loader of another detector type before ...@@ -13,6 +13,7 @@ This module requires either another event loader of another detector type before
### Parameters ### Parameters
* `input_directory`: Path to the directory containing the `data.bin` file. This path should lead to the directory above the ALTASpix directory, as this string is added to the input directory in the module. * `input_directory`: Path to the directory containing the `data.bin` file. This path should lead to the directory above the ALTASpix directory, as this string is added to the input directory in the module.
* `legacy_format`: Set `true` if using legacy data format of the Karlsruhe readout system. Default is `false`, corresponding the the format of the Caribou readout system.
* `clock_cycle`: Period of the clock used to count the trigger timestamps in, defaults to `6.25ns`. * `clock_cycle`: Period of the clock used to count the trigger timestamps in, defaults to `6.25ns`.
* `clkdivend2`: Value of clkdivend2 register in ATLASPix specifying the speed of TS2 counter. Default is `0`. * `clkdivend2`: Value of clkdivend2 register in ATLASPix specifying the speed of TS2 counter. Default is `0`.
......
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