mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-05-03 11:20:03 +02:00
Dhanya Thattil
7b21ce34d6
* docs receiver formats rewrite * added documentation for all the receiver files, updated release notes, udpated help in commands help for timing, fixed by throwing exception for aa dividy by 0 error caused by not freeing memory (detsize) when switching between 1d and 2d detectors, removed unnecessary 'recevier up' printout, fixed dbit list 64 bit mask error in master json file (was not 64 bit before), fixed bug in reading gotthard1 data (needs to be tested) * generating commands help and formatting, also fix help for trimen command line * added ctb frame format documentation, added some links to some commands, added documentation about adding expat-devel in installation for rhel8 gui, fixed some indentation issues that screwed up command line help documentation * added ctb frame format documentation * updated documentation about zeromq-devel for <8.0.0 versions
138 lines
6.7 KiB
ReStructuredText
138 lines
6.7 KiB
ReStructuredText
ZMQ: Json Header Format
|
|
========================
|
|
|
|
|
|
**Change in field names from slsDetectorPackage v6.x.x to v7.0.0**
|
|
|
|
* detSpec1 <- bunchId
|
|
* detSpec2 <- reserved
|
|
* detSpec3 <- debug
|
|
* detSpec4 <- roundRNumber
|
|
|
|
|
|
**Format**
|
|
|
|
.. code-block:: bash
|
|
|
|
{
|
|
"jsonversion": unsigned int,
|
|
"bitmode": unsigned int,
|
|
"fileIndex": unsigned long int,
|
|
"detshape": [
|
|
unsigned int,
|
|
unsigned int
|
|
],
|
|
"shape": [
|
|
unsigned int,
|
|
unsigned int
|
|
],
|
|
"size": unsigned int,
|
|
"acqIndex": unsigned long int,
|
|
"frameIndex": unsigned long int,
|
|
"progress": double,
|
|
"fname": string,
|
|
"data": unsigned int,
|
|
"completeImage": unsigned int,
|
|
|
|
"frameNumber": unsigned long long int,
|
|
"expLength": unsigned int,
|
|
"packetNumber": unsigned int,
|
|
"detSpec1": unsigned long int,
|
|
"timestamp": unsigned long int,
|
|
"modId": unsigned int,
|
|
"row": unsigned int,
|
|
"column": unsigned int,
|
|
"detSpec2": unsigned int,
|
|
"detSpec3": unsigned int,
|
|
"detSpec4": unsigned int,
|
|
"detType": unsigned int,
|
|
"version": unsigned int,
|
|
|
|
"flipRows": unsigned int,
|
|
"quad": unsigned int,
|
|
"addJsonHeader": {
|
|
string : string
|
|
}
|
|
}
|
|
|
|
+--------------+----------------------------------------------+
|
|
| Field | Description |
|
|
+--------------+----------------------------------------------+
|
|
| jsonversion | Version of the json header. |
|
|
| | Value at 4 for v6.x.x and v7.x.x |
|
|
+--------------+----------------------------------------------+
|
|
| bitmode | Bits per pixel [4|8|16|32] |
|
|
+--------------+----------------------------------------------+
|
|
| fileIndex | Current file acquisition index |
|
|
+--------------+----------------------------------------------+
|
|
| detshape | Geometry of the entire detector |
|
|
+--------------+----------------------------------------------+
|
|
| shape | Geometry of the current port streamed out |
|
|
+--------------+----------------------------------------------+
|
|
| size | Size of image of current port in bytesout |
|
|
+--------------+----------------------------------------------+
|
|
| acqIndex | Frame number from the detector (redundant) |
|
|
+--------------+----------------------------------------------+
|
|
| frameIndex | Frame number of current acquisition |
|
|
| | (Starting at 0) |
|
|
+--------------+----------------------------------------------+
|
|
| progress | Progress of current acquisition in % |
|
|
+--------------+----------------------------------------------+
|
|
| fname | Current file name |
|
|
+--------------+----------------------------------------------+
|
|
| data | 1 if there is data following |
|
|
| | 0 if dummy header |
|
|
+--------------+----------------------------------------------+
|
|
| completeImage| 1 if no missing packets for this frame |
|
|
| | in this port, else 0 |
|
|
+--------------+----------------------------------------------+
|
|
| frameNumber | Frame number |
|
|
| | [From detector udp header] |
|
|
+--------------+----------------------------------------------+
|
|
| expLength | subframe number (32 bit eiger) |
|
|
| | or real time exposure time in 100ns (others) |
|
|
| | [From detector udp header] |
|
|
+--------------+----------------------------------------------+
|
|
| packetNumber | Number of packets caught for that frame |
|
|
+--------------+----------------------------------------------+
|
|
| detSpec1 | See :ref:`here<Detector Specific Fields>` |
|
|
| | [From detector udp header] |
|
|
+--------------+----------------------------------------------+
|
|
| timestamp | Timestamp with 10 MHz clock |
|
|
| | [From detector udp header] |
|
|
+--------------+----------------------------------------------+
|
|
| modId | Module Id |
|
|
| | [From detector udp header] |
|
|
+--------------+----------------------------------------------+
|
|
| row | Row number in detector |
|
|
| | [From detector udp header] |
|
|
+--------------+----------------------------------------------+
|
|
| column | Column number in detector |
|
|
| | [From detector udp header] |
|
|
+--------------+----------------------------------------------+
|
|
| detSpec2 | See :ref:`here<Detector Specific Fields>` |
|
|
| | [From detector udp header] |
|
|
+--------------+----------------------------------------------+
|
|
| detSpec3 | See :ref:`here<Detector Specific Fields>` |
|
|
| | [From detector udp header] |
|
|
+--------------+----------------------------------------------+
|
|
| detSpec4 | See :ref:`here<Detector Specific Fields>` |
|
|
| | [From detector udp header] |
|
|
+--------------+----------------------------------------------+
|
|
| detType | Detector type enum |
|
|
| detSpec3 | See :ref:`Detector enum<detector enum>` |
|
|
| | [From detector udp header] |
|
|
+--------------+----------------------------------------------+
|
|
| version | Detector header version. At 2 |
|
|
| | [From detector udp header] |
|
|
+--------------+----------------------------------------------+
|
|
| flipRows | 1 if rows should be flipped. |
|
|
| | Usually for Eiger bottom. |
|
|
+--------------+----------------------------------------------+
|
|
| quad | 1 if its an Eiger quad. |
|
|
+--------------+----------------------------------------------+
|
|
| addJsonHeader| Optional custom parameters that is required |
|
|
| | for processing code. |
|
|
+--------------+----------------------------------------------+
|
|
|