From 9bae97ec4c21ec32d35e103412caf0a7c1c98601 Mon Sep 17 00:00:00 2001 From: Dhanya Thattil Date: Wed, 19 Aug 2020 16:37:21 +0200 Subject: [PATCH] doc update, 1st trial --- python/slsdet/detector.py | 10 ++++++++++ slsDetectorSoftware/include/Detector.h | 8 +++++++- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/python/slsdet/detector.py b/python/slsdet/detector.py index 39dab3d70..3fa91f927 100755 --- a/python/slsdet/detector.py +++ b/python/slsdet/detector.py @@ -985,6 +985,14 @@ class Detector(CppDetectorApi): @property def adcphase(self): + """[Gotthard][Jungfrau][CTB][Moench] Sets phase shift of ADC clock. + + Note + ----- + | [Jungfrau] Absolute phase shift. Changing Speed also resets adcphase to recommended defaults. + | [Ctb][Moench] Absolute phase shift. Changing adcclk also resets adcphase and sets it to previous values. + | [Gotthard] Relative phase shift. + """ return element_if_equal(self.getADCPhase()) @adcphase.setter @@ -1001,6 +1009,8 @@ class Detector(CppDetectorApi): @property def adcclk(self): + """[Ctb][Moench] Sets ADC clock frequency in MHz. + """ return element_if_equal(self.getADCClock()) @adcclk.setter diff --git a/slsDetectorSoftware/include/Detector.h b/slsDetectorSoftware/include/Detector.h index 5b7bcc96f..b27467311 100644 --- a/slsDetectorSoftware/include/Detector.h +++ b/slsDetectorSoftware/include/Detector.h @@ -241,7 +241,13 @@ class Detector { /** [Gotthard][Jungfrau][CTB][Moench] */ Result getADCPhase(Positions pos = {}) const; - /** [Gotthard][Jungfrau][CTB][Moench] */ + /** [Gotthard][Jungfrau][CTB][Moench] + * [Jungfrau] Absolute phase shift. Changing Speed also resets adcphase to + * recommended defaults. \n + * [Ctb][Moench] Absolute phase shift. Changing adcclk also resets adcphase + * and sets it to previous values. \n + * [Gotthard] Relative phase shift + */ void setADCPhase(int value, Positions pos = {}); /** [Jungfrau][CTB][Moench] */