From 9c0dd0385d8bb243bc49f194c607047b2d2dc8c4 Mon Sep 17 00:00:00 2001 From: Dhanya Thattil Date: Fri, 10 Nov 2023 16:02:21 +0100 Subject: [PATCH] updating docs --- docs/src/troubleshooting.rst | 1 + python/slsdet/detector.py | 131 +++++++++++++---------------------- 2 files changed, 48 insertions(+), 84 deletions(-) diff --git a/docs/src/troubleshooting.rst b/docs/src/troubleshooting.rst index ee8904404..72a3814f8 100644 --- a/docs/src/troubleshooting.rst +++ b/docs/src/troubleshooting.rst @@ -433,6 +433,7 @@ Cannot stop slaves in sync mode #. If cabling is accessible, ensure termination board and flatband cable between the masters and the slaves are connnected properly. Then try to stop. #. If cabling is inaccessible, unsync first so that the slaves can get the stop directly from the client using the command. Then, don't use sync mode until the cabling is fixed. + .. code-block:: bash # unsync, slaves command will fail as it is still in waiting state diff --git a/python/slsdet/detector.py b/python/slsdet/detector.py index 36c5ed0cd..e53ab4295 100755 --- a/python/slsdet/detector.py +++ b/python/slsdet/detector.py @@ -360,7 +360,8 @@ class Detector(CppDetectorApi): @property def settings(self): """ - Detector settings. Enum: detectorSettings + Detector settings. + Enum: detectorSettings Note ----- @@ -400,6 +401,9 @@ class Detector(CppDetectorApi): def framesl(self): """ [Gotthard][Jungfrau][Moench][Mythen3][Gotthard2][CTB] Number of frames left in acquisition.\n + + Note + ---- [Gotthard2] only in continuous auto mode. :setter: Not Implemented @@ -475,7 +479,8 @@ class Detector(CppDetectorApi): @element def gaincaps(self): """ - [Mythen3] Gain caps. Enum: M3_GainCaps \n + [Mythen3] Gain caps. + Enum: M3_GainCaps Note ---- @@ -573,8 +578,6 @@ class Detector(CppDetectorApi): """ Period between frames, accepts either a value in seconds or datetime.timedelta - Note - ----- :getter: always returns in seconds. To get in DurationWrapper, use getPeriod Example @@ -641,9 +644,6 @@ class Detector(CppDetectorApi): """ [Gotthard][Jungfrau][Moench][CTB][Mythen3][Gotthard2] Delay after trigger, accepts either a value in seconds, DurationWrapper or datetime.timedelta - Note - ----- - :getter: always returns in seconds. To get in DurationWrapper, use getDelayAfterTrigger Example @@ -895,7 +895,8 @@ class Detector(CppDetectorApi): @element def rx_discardpolicy(self): """ - Frame discard policy of receiver. Enum: frameDiscardPolicy + Frame discard policy of receiver. + Enum: frameDiscardPolicy Note ----- @@ -969,7 +970,8 @@ class Detector(CppDetectorApi): @property @element def fformat(self): - """ File format of data file in receiver. Enum: fileFormat + """ File format of data file in receiver. + Enum: fileFormat Note ----- @@ -1565,7 +1567,8 @@ class Detector(CppDetectorApi): @property @element def status(self): - """Gets detector status. Enum: runStatus + """Gets detector status. + Enum: runStatus Note ----- @@ -1579,7 +1582,8 @@ class Detector(CppDetectorApi): @property @element def rx_status(self): - """Gets receiver listener status. Enum: runStatus + """Gets receiver listener status. + Enum: runStatus Note ----- @@ -1808,6 +1812,7 @@ class Detector(CppDetectorApi): def daclist(self): """ List of enums/names for every dac for this detector + :setter: Only implemented for Chiptestboard """ @@ -1820,9 +1825,7 @@ class Detector(CppDetectorApi): @property def adclist(self): """ - List of names for every adc for this board. 32 adcs - :setter: Only implemented for Chiptestboard - + [Chiptestboard] List of names for every adc for this board. 32 adcs """ return self.getAdcNames() @@ -1833,9 +1836,7 @@ class Detector(CppDetectorApi): @property def signallist(self): """ - List of names for every io signal for this board. 64 signals - :setter: Only implemented for Chiptestboard - + [Chiptestboard] List of names for every io signal for this board. 64 signals """ return self.getSignalNames() @@ -1846,8 +1847,7 @@ class Detector(CppDetectorApi): @property def powerlist(self): """ - List of names for every power for this board. 5 power supply - :setter: Only implemented for Chiptestboard + [Chiptestboard] List of names for every power for this board. 5 power supply """ return self.getPowerNames() @@ -1859,8 +1859,7 @@ class Detector(CppDetectorApi): @property def slowadclist(self): """ - List of names for every slowadc for this board. 8 slowadc - :setter: Only implemented for Chiptestboard + [Chiptestboard] List of names for every slowadc for this board. 8 slowadc """ return self.getSlowADCNames() @@ -1879,7 +1878,7 @@ class Detector(CppDetectorApi): @property def powervalues(self): - """Gets the power values for every power for this detector.""" + """[Chiptestboard] Gets the power values for every power for this detector.""" return { power.name.lower(): element_if_equal(np.array(self.getPower(power))) for power in self.getPowerList() @@ -1887,7 +1886,7 @@ class Detector(CppDetectorApi): @property def slowadcvalues(self): - """Gets the slow adc values for every slow adc for this detector.""" + """[Chiptestboard] Gets the slow adc values for every slow adc for this detector.""" return { slowadc.name.lower(): element_if_equal(np.array(self.getSlowADC(slowadc))) for slowadc in self.getSlowADCList() @@ -2061,8 +2060,7 @@ class Detector(CppDetectorApi): ----- To set default rate correction from trimbit file, use setDefaultRateCorrection - Known Issue - ------------ + Known Issue: :getter: Always give 0 due to the microseconds precision. :setter: Use scientific notation to set custom rate correction, since timedelta resolution is 1 microseconds. \n @@ -2086,7 +2084,8 @@ class Detector(CppDetectorApi): @element def readoutspeed(self): """ - [Eiger][Jungfrau|Gotthard2] Readout speed of chip. Enum: speedLevel + [Eiger][Jungfrau|Gotthard2] Readout speed of chip. + Enum: speedLevel Note ----- @@ -2175,7 +2174,8 @@ class Detector(CppDetectorApi): @element def timing(self): """ - Set Timing Mode of detector. Enum: timingMode + Set Timing Mode of detector. + Enum: timingMode Note ----- @@ -2235,13 +2235,11 @@ class Detector(CppDetectorApi): @property @element def type(self): - """ Returns detector type. Enum: detectorType - - Note - ---- + """ Returns detector type. + Enum: detectorType + [EIGER, JUNGFRAU, GOTTHARD, MOENCH, MYTHEN3, GOTTHARD2, CHIPTESTBOARD] :setter: Not implemented - Values: EIGER, JUNGFRAU, GOTTHARD, MOENCH, MYTHEN3, GOTTHARD2, CHIPTESTBOARD """ return self.getDetectorType() @@ -2502,9 +2500,6 @@ class Detector(CppDetectorApi): """ [Eiger] Measured sub frame period between last sub frame and previous one. - Note - ----- - :setter: Not implemented """ return ut.reduce_time(self.getMeasuredSubFramePeriod()) @@ -2782,7 +2777,8 @@ class Detector(CppDetectorApi): @property def gainmode(self): """ - [Jungfrau] Detector gain mode. Enum: gainMode + [Jungfrau] Detector gain mode. + Enum: gainMode Note ----- @@ -2895,11 +2891,8 @@ class Detector(CppDetectorApi): @property def maxclkphaseshift(self): """ - [Gotthard2][Mythen3] Absolute maximum Phase shift of clocks. - - Note - ---- - + [Gotthard2][Mythen3] Absolute maximum Phase shift of clocks. + :setter: Not Implemented Example @@ -2917,7 +2910,8 @@ class Detector(CppDetectorApi): @element def timingsource(self): """ - [Gotthard2] Timing source. Enum: timingSourceType + [Gotthard2] Timing source. + Enum: timingSourceType Note ----- @@ -2961,7 +2955,8 @@ class Detector(CppDetectorApi): @property @element def burstmode(self): - """[Gotthard2] Burst mode of detector. Enum: burstMode + """[Gotthard2] Burst mode of detector. + Enum: burstMode Note ---- @@ -2979,9 +2974,6 @@ class Detector(CppDetectorApi): """ [Gotthard2] Period between 2 bursts. Only in burst mode and auto timing mode. - Note - ----- - :getter: always returns in seconds. To get in DurationWrapper, use getBurstPeriod :setter: Not Implemented @@ -3104,7 +3096,8 @@ class Detector(CppDetectorApi): @property def vetoalg(self): - """[Gotthard2] Algorithm used for veto. Enum: vetoAlgorithm, streamingInterface + """[Gotthard2] Algorithm used for veto. + Enum: vetoAlgorithm, streamingInterface Note ---- @@ -3278,7 +3271,8 @@ class Detector(CppDetectorApi): @element def romode(self): """ - [CTB] Readout mode of detector. Enum: readoutMode + [CTB] Readout mode of detector. + Enum: readoutMode Note ------ @@ -3384,9 +3378,6 @@ class Detector(CppDetectorApi): def maxdbitphaseshift(self): """[CTB][Jungfrau] Absolute maximum Phase shift of of the clock to latch digital bits. - Note - ----- - :setter: Not Implemented """ return self.getMaxDBITPhaseShift() @@ -3431,9 +3422,6 @@ class Detector(CppDetectorApi): def maxadcphaseshift(self): """[Jungfrau][Moench][CTB] Absolute maximum Phase shift of ADC clock. - Note - ----- - :setter: Not Implemented """ return self.getMaxADCPhaseShift() @@ -3483,9 +3471,6 @@ class Detector(CppDetectorApi): """ [Ctb] Sync clock in MHz. - Note - ----- - :setter: Not implemented """ return self.getSYNCClock() @@ -3493,10 +3478,7 @@ class Detector(CppDetectorApi): @property def pattern(self): """[Mythen3][Ctb] Loads ASCII pattern file directly to server (instead of executing line by line). - - Note - ---- - + :getter: Not Implemented Example @@ -3924,10 +3906,7 @@ class Detector(CppDetectorApi): @element def im_a(self): """[Ctb] Measured current of power supply a in mA. - - Note - ----- - + :setter: Not implemented """ return self.getMeasuredCurrent(dacIndex.I_POWER_A) @@ -3937,9 +3916,6 @@ class Detector(CppDetectorApi): def im_b(self): """[Ctb] Measured current of power supply b in mA. - Note - ----- - :setter: Not implemented """ return self.getMeasuredCurrent(dacIndex.I_POWER_B) @@ -3949,9 +3925,6 @@ class Detector(CppDetectorApi): def im_c(self): """[Ctb] Measured current of power supply c in mA. - Note - ----- - :setter: Not implemented """ return self.getMeasuredCurrent(dacIndex.I_POWER_C) @@ -3961,9 +3934,6 @@ class Detector(CppDetectorApi): def im_d(self): """[Ctb] Measured current of power supply d in mA. - Note - ----- - :setter: Not implemented """ return self.getMeasuredCurrent(dacIndex.I_POWER_D) @@ -3973,9 +3943,6 @@ class Detector(CppDetectorApi): def im_io(self): """[Ctb] Measured current of power supply io in mA. - Note - ----- - :setter: Not implemented """ return self.getMeasuredCurrent(dacIndex.I_POWER_IO) @@ -4025,9 +3992,6 @@ class Detector(CppDetectorApi): def exptimel(self): """[Gotthard] Exposure time left for current frame. - Note - ----- - :getter: always returns in seconds. To get in DurationWrapper, use getExptimeLeft :setter: Not Implemented @@ -4062,9 +4026,6 @@ class Detector(CppDetectorApi): """ [Gotthard2][Mythen3] Frequency of clock in Hz. - Note - ---- - :setter: Not implemented. Use clkdiv to set frequency Example @@ -4084,7 +4045,9 @@ class Detector(CppDetectorApi): @property @element def polarity(self): - """[Mythen3] Set positive or negative polarity. Enum: polarity""" + """[Mythen3] Set positive or negative polarity. + Enum: polarity + """ return self.getPolarity() @polarity.setter