detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-04-19 18:40:01 +02:00
Code Issues Actions Packages Releases Activity

wip doc

Browse Source
This commit is contained in:
maliakal_d 2020-10-29 15:53:37 +01:00
parent c1d841abbc
commit a5c41d6b19
2 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/src/installation.rst
View File

@ -21,6 +21,8 @@
Installation
==============================================
.. _build from source using cmake:
Build from source using CMake
---------------------------------

15
docs/src/slsreceiver.rst
View File

@ -151,9 +151,20 @@ Please refer to Receiver PC Tuning options and slsReceiver Tuning under `Trouble
Using Callbacks
----------------
| One can get a callback in the receiver for each frame to:
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.
When handling callbacks, the control should be returned as soon as possible, to prevent packet loss from fifo being full.
**Example**
* `main cpp file <https://github.com/slsdetectorgroup/api-examples/blob/master/e4-receiver_callbacks.cpp>`_
* `cmake file <https://github.com/slsdetectorgroup/api-examples/blob/master/CMakeLists.txt>`_.
* how to install the slsDetectorPackage is provided :ref:`here <build from source using cmake>`.
* compile the example **e4-rxr** by:
.. code-block:: bash
cmake ../path/to/your/source -DCMAKE_PREFIX_PATH=/path/to/sls/install
make