mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-04-23 23:10:02 +02:00
doc update, 1st trial
This commit is contained in:
parent
096b0c424d
commit
9bae97ec4c
@ -985,6 +985,14 @@ class Detector(CppDetectorApi):
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def adcphase(self):
|
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())
|
return element_if_equal(self.getADCPhase())
|
||||||
|
|
||||||
@adcphase.setter
|
@adcphase.setter
|
||||||
@ -1001,6 +1009,8 @@ class Detector(CppDetectorApi):
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def adcclk(self):
|
def adcclk(self):
|
||||||
|
"""[Ctb][Moench] Sets ADC clock frequency in MHz.
|
||||||
|
"""
|
||||||
return element_if_equal(self.getADCClock())
|
return element_if_equal(self.getADCClock())
|
||||||
|
|
||||||
@adcclk.setter
|
@adcclk.setter
|
||||||
|
@ -241,7 +241,13 @@ class Detector {
|
|||||||
/** [Gotthard][Jungfrau][CTB][Moench] */
|
/** [Gotthard][Jungfrau][CTB][Moench] */
|
||||||
Result<int> getADCPhase(Positions pos = {}) const;
|
Result<int> 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 = {});
|
void setADCPhase(int value, Positions pos = {});
|
||||||
|
|
||||||
/** [Jungfrau][CTB][Moench] */
|
/** [Jungfrau][CTB][Moench] */
|
||||||
|
Loading…
x
Reference in New Issue
Block a user