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

WIP, doc

Browse Source
This commit is contained in:
maliakal_d
2020-08-27 17:58:15 +02:00
parent a1e06ca7a9
commit f19799343e
3 changed files with 35 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
python/slsdet/detector.py
View File

@ -550,6 +550,12 @@ class Detector(CppDetectorApi):
@property @property
def rx_datastream(self): def rx_datastream(self):
"""
Enable/ disable data streaming from receiver via zmq (eg. to GUI or to another process for further processing). \n
This creates/ destroys zmq streamer threads in receiver. \n
Switching to Gui automatically enables data streaming in receiver. \n
Switching back to command line acquire will require disabling data streaming in receiver for fast applications.
"""
return element_if_equal(self.getRxZmqDataStream()) return element_if_equal(self.getRxZmqDataStream())
@rx_datastream.setter @rx_datastream.setter
@ -1286,6 +1292,22 @@ class Detector(CppDetectorApi):
@property @property
def rx_dbitlist(self): def rx_dbitlist(self):
"""
[Ctb] List of digital signal bits read out.
Notes
-----
Each element in list can be 0 - 63 and must be non repetitive.
Examples
---------
>>> d.rxdbitlist = [0, 1, 61, 9]
>>> d.rxdbitlist
[0, 1, 61, 9]
>>> d.rxdbitlist = []
>>> d.rxdbitlist
[]
"""
return element_if_equal(self.getRxDbitList()) return element_if_equal(self.getRxDbitList())
@rx_dbitlist.setter @rx_dbitlist.setter

7
slsDetectorSoftware/include/Detector.h
View File

@ -728,6 +728,13 @@ class Detector {
Result<bool> getRxZmqDataStream(Positions pos = {}) const; Result<bool> getRxZmqDataStream(Positions pos = {}) const;
/** Enable/ disable data streaming from receiver via zmq (eg. to GUI or to
* another process for further processing). \n This creates/ destroys zmq
* streamer threads in receiver. \n Switching to Gui automatically enables
* data streaming in receiver. \n Switching back to command line or API
* acquire will require disabling data streaming in receiver for fast
* applications (if not needed for client data call backs).
*/
void setRxZmqDataStream(bool value, Positions pos = {}); void setRxZmqDataStream(bool value, Positions pos = {});
Result<int> getRxZmqFrequency(Positions pos = {}) const; Result<int> getRxZmqFrequency(Positions pos = {}) const;

12
slsDetectorSoftware/src/CmdProxy.h
View File

@ -1839,12 +1839,12 @@ class CmdProxy {
INTEGER_COMMAND( INTEGER_COMMAND(
rx_datastream, getRxZmqDataStream, setRxZmqDataStream, StringTo<int>, rx_datastream, getRxZmqDataStream, setRxZmqDataStream, StringTo<int>,
"[0, 1]\n\tData streaming from receiver enable (eg. to GUI ot another " "[0, 1]\n\tEnable/ disable data streaming from receiver via zmq (eg. "
"process for further processing). 1 enables zmq data stream (creates " "to GUI or to another process for further processing). This creates/ "
"zmq streamer threads), 0 disables (destroys streamer threads). " "destroys zmq streamer threads in receiver. \n\tSwitching to Gui "
"Switching to Gui automatically enables data streaming in receiver. " "automatically enables data streaming in receiver. \n\tSwitching back "
"Switching back to command line acquire will require disabling data " "to command line acquire will require disabling data streaming in "
"streaming in receiver for fast applications."); "receiver for fast applications. ");
INTEGER_COMMAND( INTEGER_COMMAND(
rx_readfreq, getRxZmqFrequency, setRxZmqFrequency, StringTo<int>, rx_readfreq, getRxZmqFrequency, setRxZmqFrequency, StringTo<int>,