slsReceiver/ slsMultiReceiver

One has to start the slsReceiver before loading config file or using any receiver commands (prefix: rx_ )

For a Single Module

# default port 1954
slsReceiver

# custom port 2012
slsReceiver -t2012

For Multiple Modules

# each receiver (for each module) requires a unique tcp port (if all on same machine)

# using slsReceiver in multiple consoles
slsReceiver
slsReceiver -t1955

# slsMultiReceiver [starting port] [number of receivers]
slsMultiReceiver 2012 2

# slsMultiReceiver [starting port] [number of receivers] [print each frame header for debugging]
slsMultiReceiver 2012 2 1

Client Commands

One can remove udp_dstmac from the config file, as the slsReceiver fetches this from the udp_ip.

One can use “auto” for udp_dstip if one wants to use default ip of rx_hostname.

The first command to the receiver (rx_ commands) should be rx_hostname. The following are the different ways to establish contact.

# default receiver tcp port (1954)
rx_hostname xxx

# custom receiver port
rx_hostname xxx:1957

# custom receiver port
rx_tcpport 1954
rx_hostname xxx

# multi modules with custom ports
rx_hostname xxx:1955+xxx:1956+


# multi modules using increasing tcp ports when using multi detector command
rx_tcpport 1955
rx_hostname xxx

# or specify multi modules with custom ports on same rxr pc
0:rx_tcpport 1954
1:rx_tcpport 1955
2:rx_tcpport 1956
rx_hostname xxx

# multi modules with custom ports on different rxr pc
0:rx_tcpport 1954
0:rx_hostname xxx
1:rx_tcpport 1955
1:rx_hostname yyy

Example commands:

# to get a list of receiver commands (these dont include file commands)
sls_detector_get list | grep rx_

# some file commands are:
fwrite
foverwrite
findex
fpath
fname
fmaster
fformat

# to get help on a single commands
sls_detector_get -h rx_framescaught

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

{
    "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 here [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 here [From detector udp header]
detSpec3	See here [From detector udp header]
detSpec4	See here [From detector udp header]
detType detSpec3	Detector type enum See 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.

SLS Receiver Header Format

It is 112 bytes and consists of:

• 48 bytes of the SLS Detector Header (described in the current detector header)

• 64 bytes of packet mask

typedef struct {
    uint64_t frameNumber;
    uint32_t expLength;
    uint32_t packetNumber;
    uint64_t detSpec1;
    uint64_t timestamp;
    uint16_t modId;
    uint16_t row;
    uint16_t column;
    uint16_t detSpec2;
    uint32_t detSpec3;
    uint16_t detSpec4;
    uint8_t detType;
    uint8_t version;
} sls_detector_header;

struct sls_receiver_header {
    sls_detector_header detHeader; /**< is the detector header */
    sls_bitset packetsMask;        /**< is the packets caught bit mask */
};

Note

The packetNumber in the SLS Receiver Header will be modified to number of packets caught by receiver for that frame. For eg. Jungfrau will have 128 packets per frame. If it is less, then this is a partial frame due to missing packets.

Furthermore, the bit mask will specify which packets have been received.

File format

Master file is in json format.

The file name format is [fpath]/[fname]_dx_fy_[findex].raw, where x is module index and y is file index. fname is file name prefix and by default “run”. fpath is ‘/’ by default.

Each acquisition will have an increasing acquisition index or findex (if file write enabled). This can be retrieved by using findex command.

Each acquisition can have multiple files (the file index number y), with rx_framesperfile being the maximum number of frames per file. The default varies for each detector type.

Some file name examples:

# first file
path-to-file/run_d0_f0_0.raw

# second file after reaching max frames in first file
path-to-file/run_d0_f1_0.raw

# second acquisition, first file
path-to-file/run_d0_f0_1.raw

Each acquisition will create a master file that can be enabled/disabled using fmaster. This should have parameters relevant to the acquisition.

Binary file format

This is the default file format.

Each data file will consist of frames, each consisting of slsReceiver Header followed by data for 1 frame.

Master file is of ASCII format and will also include the format of the slsReceiver Header.

HDF5 file formats

1. Compile the package with HDF5 option enabled

   1. Using cmk script: ./cmk.sh -hj9 -d [path of hdf5 dir]

   2. Enable using cmake -DCMAKE_INSTALL_PREFIX=/path/to/hdf/installation and -DSLS_USE_HDF5=ON

2. Start Receiver process

3. Load config file

4. Set file format from client or in config file

   sls_detector_put fformat hdf5
   

For multiple, modules, a virtual file linking all the modules is created. Both the data files and virtual files are linked in the master file.

Performance

Please refer to Receiver PC Tuning options and slsReceiver Tuning under Troubleshooting.

Using Callbacks

One can get a callback in the receiver for each frame to:

• manipulate the data that will be written to file, or

• disable file writing in slsReceiver and take care of the data for each call back

When handling callbacks, the control should be returned as soon as possible, to prevent packet loss from fifo being full.

Example

• main cpp file

• cmake file.

• how to install the slsDetectorPackage with cmake is provided here.

• compile the example e4-rxr by:

  cmake ../path/to/your/source -DCMAKE_PREFIX_PATH=/path/to/sls/install
  make