From f19799343e7f0ae29503d428ce118fe96cd628d7 Mon Sep 17 00:00:00 2001 From: Dhanya Thattil Date: Thu, 27 Aug 2020 17:58:15 +0200 Subject: [PATCH] WIP, doc --- python/slsdet/detector.py | 22 ++++++++++++++++++++++ slsDetectorSoftware/include/Detector.h | 7 +++++++ slsDetectorSoftware/src/CmdProxy.h | 12 ++++++------ 3 files changed, 35 insertions(+), 6 deletions(-) diff --git a/python/slsdet/detector.py b/python/slsdet/detector.py index de2010e4e..40fedea63 100755 --- a/python/slsdet/detector.py +++ b/python/slsdet/detector.py @@ -550,6 +550,12 @@ class Detector(CppDetectorApi): @property 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()) @rx_datastream.setter @@ -1286,6 +1292,22 @@ class Detector(CppDetectorApi): @property 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()) @rx_dbitlist.setter diff --git a/slsDetectorSoftware/include/Detector.h b/slsDetectorSoftware/include/Detector.h index 8374b29cf..e41429834 100644 --- a/slsDetectorSoftware/include/Detector.h +++ b/slsDetectorSoftware/include/Detector.h @@ -728,6 +728,13 @@ class Detector { Result 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 = {}); Result getRxZmqFrequency(Positions pos = {}) const; diff --git a/slsDetectorSoftware/src/CmdProxy.h b/slsDetectorSoftware/src/CmdProxy.h index a82c15212..29dd50221 100644 --- a/slsDetectorSoftware/src/CmdProxy.h +++ b/slsDetectorSoftware/src/CmdProxy.h @@ -1839,12 +1839,12 @@ class CmdProxy { INTEGER_COMMAND( rx_datastream, getRxZmqDataStream, setRxZmqDataStream, StringTo, - "[0, 1]\n\tData streaming from receiver enable (eg. to GUI ot another " - "process for further processing). 1 enables zmq data stream (creates " - "zmq streamer threads), 0 disables (destroys streamer threads). " - "Switching to Gui automatically enables data streaming in receiver. " - "Switching back to command line acquire will require disabling data " - "streaming in receiver for fast applications."); + "[0, 1]\n\tEnable/ disable data streaming from receiver via zmq (eg. " + "to GUI or to another process for further processing). This creates/ " + "destroys zmq streamer threads in receiver. \n\tSwitching to Gui " + "automatically enables data streaming in receiver. \n\tSwitching back " + "to command line acquire will require disabling data streaming in " + "receiver for fast applications. "); INTEGER_COMMAND( rx_readfreq, getRxZmqFrequency, setRxZmqFrequency, StringTo,