detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-06-11 04:17:15 +02:00
Code Issues Actions Packages Releases Activity

updated docs

Browse Source
This commit is contained in:
maliakal_d
2020-10-09 08:52:19 +02:00
parent 6053f2adff
commit 6fb2479178
3 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/src/quick_start_guide.rst
View File

@ -133,7 +133,8 @@ Compile with SLS_USE_GUI=ON in cmake or -g option in cmk.sh script. One can also
.. note ::
| The streaming frequency (commmand: rx_zmqfreq) is set by default in the receiver to 1 (send every frame).
| At Gui startup, this value is set to 0. It will set to use a timer of 500 ms. Hence, every frame will not be streamed to the gui. This is done to reduce the load for fast and large detectors for display purposes.
| One can still change this setting in the gui in the Plot tab (Plotting frequency) or from the command line (rx_zmqfreq).
| First frame is always streamed out, no matter if timer or frequency is used.
| The streaming high water mark (commmand: rx_zmqhwm) and the receiving high water mark (command: zmqhwm) is by default the lib zmq's default (currently 1000).
| At Gui startup, these values are set to 2. Hence, for very fast detectors, many frames will be dropped to be able to view the latest in the gui.
| One can still change this setting in the gui in the Plot tab (ZMQ Streaming), from the command line or API.
| Both hwm's can be set to a -1 to use the lib's default.
| Since the dummy end of acquisition packet streamed from receiver might also be lost, receiver restreams until gui acknowledges.