detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-06-06 10:00:40 +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
Show Stats 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 :: .. note ::
| The streaming frequency (commmand: rx_zmqfreq) is set by default in the receiver to 1 (send every frame). | 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, 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. | 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 (Plotting frequency) or from the command line (rx_zmqfreq). | One can still change this setting in the gui in the Plot tab (ZMQ Streaming), from the command line or API.
| First frame is always streamed out, no matter if timer or frequency is used. | 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.

2
slsDetectorGui/forms/form_tab_plot.ui
View File

@ -2008,7 +2008,7 @@ Displays minimum, maximum and sum of values for each plot.
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Sets the pace at which the receiver streams out images. Images in between the timeout or frequency are not sent out.&lt;br/&gt;&lt;br/&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;Time Interval&lt;/span&gt;: Streaming time interval when an image should be streamed. &lt;br/&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;Every nth Image&lt;/span&gt;: Only every nth image is streamed. &lt;/p&gt;&lt;p&gt;&lt;br/&gt;&lt;/p&gt;&lt;p&gt;&lt;br/&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string> <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Sets the pace at which the receiver streams out images. Images in between the timeout or frequency are not sent out.&lt;br/&gt;&lt;br/&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;Time Interval&lt;/span&gt;: Streaming time interval when an image should be streamed. &lt;br/&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;Every nth Image&lt;/span&gt;: Only every nth image is streamed. &lt;/p&gt;&lt;p&gt;&lt;br/&gt;&lt;/p&gt;&lt;p&gt;&lt;br/&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
</property> </property>
<property name="title"> <property name="title">
<string>Receiver Streaming</string> <string>ZMQ Streaming</string>
</property> </property>
<property name="alignment"> <property name="alignment">
<set>Qt::AlignLeading|Qt::AlignLeft|Qt::AlignVCenter</set> <set>Qt::AlignLeading|Qt::AlignLeft|Qt::AlignVCenter</set>

4
slsSupportLib/include/versionAPI.h
View File

@ -1,5 +1,5 @@
/** API versions */ /** API versions */
#define GITBRANCH "5.0.0-rc2" #define GITBRANCH "developer"
#define APICTB 0x201008 #define APICTB 0x201008
#define APIGOTTHARD 0x201008 #define APIGOTTHARD 0x201008
#define APIGOTTHARD2 0x201008 #define APIGOTTHARD2 0x201008
@ -9,4 +9,4 @@
#define APIEIGER 0x201008 #define APIEIGER 0x201008
#define APILIB 0x201008 #define APILIB 0x201008
#define APIRECEIVER 0x201008 #define APIRECEIVER 0x201008
#define APIGUI 0x201008 #define APIGUI 0x201009