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

updating docs

Browse Source
This commit is contained in:
maliakal_d 2023-11-10 16:02:21 +01:00
parent 41c5b75b10
commit 9c0dd0385d
2 changed files with 48 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/src/troubleshooting.rst
View File

@ -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 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. #. 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 .. code-block:: bash
# unsync, slaves command will fail as it is still in waiting state # unsync, slaves command will fail as it is still in waiting state

125
python/slsdet/detector.py
View File

@ -360,7 +360,8 @@ class Detector(CppDetectorApi):
@property @property
def settings(self): def settings(self):
""" """
Detector settings. Enum: detectorSettings Detector settings.
Enum: detectorSettings
Note Note
----- -----
@ -400,6 +401,9 @@ class Detector(CppDetectorApi):
def framesl(self): def framesl(self):
""" """
[Gotthard][Jungfrau][Moench][Mythen3][Gotthard2][CTB] Number of frames left in acquisition.\n [Gotthard][Jungfrau][Moench][Mythen3][Gotthard2][CTB] Number of frames left in acquisition.\n
Note
----
[Gotthard2] only in continuous auto mode. [Gotthard2] only in continuous auto mode.
:setter: Not Implemented :setter: Not Implemented
@ -475,7 +479,8 @@ class Detector(CppDetectorApi):
@element @element
def gaincaps(self): def gaincaps(self):
""" """
[Mythen3] Gain caps. Enum: M3_GainCaps \n [Mythen3] Gain caps.
Enum: M3_GainCaps
Note Note
---- ----
@ -573,8 +578,6 @@ class Detector(CppDetectorApi):
""" """
Period between frames, accepts either a value in seconds or datetime.timedelta Period between frames, accepts either a value in seconds or datetime.timedelta
Note
-----
:getter: always returns in seconds. To get in DurationWrapper, use getPeriod :getter: always returns in seconds. To get in DurationWrapper, use getPeriod
Example 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 [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 :getter: always returns in seconds. To get in DurationWrapper, use getDelayAfterTrigger
Example Example
@ -895,7 +895,8 @@ class Detector(CppDetectorApi):
@element @element
def rx_discardpolicy(self): def rx_discardpolicy(self):
""" """
Frame discard policy of receiver. Enum: frameDiscardPolicy Frame discard policy of receiver.
Enum: frameDiscardPolicy
Note Note
----- -----
@ -969,7 +970,8 @@ class Detector(CppDetectorApi):
@property @property
@element @element
def fformat(self): def fformat(self):
""" File format of data file in receiver. Enum: fileFormat """ File format of data file in receiver.
Enum: fileFormat
Note Note
----- -----
@ -1565,7 +1567,8 @@ class Detector(CppDetectorApi):
@property @property
@element @element
def status(self): def status(self):
"""Gets detector status. Enum: runStatus """Gets detector status.
Enum: runStatus
Note Note
----- -----
@ -1579,7 +1582,8 @@ class Detector(CppDetectorApi):
@property @property
@element @element
def rx_status(self): def rx_status(self):
"""Gets receiver listener status. Enum: runStatus """Gets receiver listener status.
Enum: runStatus
Note Note
----- -----
@ -1808,6 +1812,7 @@ class Detector(CppDetectorApi):
def daclist(self): def daclist(self):
""" """
List of enums/names for every dac for this detector List of enums/names for every dac for this detector
:setter: Only implemented for Chiptestboard :setter: Only implemented for Chiptestboard
""" """
@ -1820,9 +1825,7 @@ class Detector(CppDetectorApi):
@property @property
def adclist(self): def adclist(self):
""" """
List of names for every adc for this board. 32 adcs [Chiptestboard] List of names for every adc for this board. 32 adcs
:setter: Only implemented for Chiptestboard
""" """
return self.getAdcNames() return self.getAdcNames()
@ -1833,9 +1836,7 @@ class Detector(CppDetectorApi):
@property @property
def signallist(self): def signallist(self):
""" """
List of names for every io signal for this board. 64 signals [Chiptestboard] List of names for every io signal for this board. 64 signals
:setter: Only implemented for Chiptestboard
""" """
return self.getSignalNames() return self.getSignalNames()
@ -1846,8 +1847,7 @@ class Detector(CppDetectorApi):
@property @property
def powerlist(self): def powerlist(self):
""" """
List of names for every power for this board. 5 power supply [Chiptestboard] List of names for every power for this board. 5 power supply
:setter: Only implemented for Chiptestboard
""" """
return self.getPowerNames() return self.getPowerNames()
@ -1859,8 +1859,7 @@ class Detector(CppDetectorApi):
@property @property
def slowadclist(self): def slowadclist(self):
""" """
List of names for every slowadc for this board. 8 slowadc [Chiptestboard] List of names for every slowadc for this board. 8 slowadc
:setter: Only implemented for Chiptestboard
""" """
return self.getSlowADCNames() return self.getSlowADCNames()
@ -1879,7 +1878,7 @@ class Detector(CppDetectorApi):
@property @property
def powervalues(self): 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 { return {
power.name.lower(): element_if_equal(np.array(self.getPower(power))) power.name.lower(): element_if_equal(np.array(self.getPower(power)))
for power in self.getPowerList() for power in self.getPowerList()
@ -1887,7 +1886,7 @@ class Detector(CppDetectorApi):
@property @property
def slowadcvalues(self): 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 { return {
slowadc.name.lower(): element_if_equal(np.array(self.getSlowADC(slowadc))) slowadc.name.lower(): element_if_equal(np.array(self.getSlowADC(slowadc)))
for slowadc in self.getSlowADCList() for slowadc in self.getSlowADCList()
@ -2061,8 +2060,7 @@ class Detector(CppDetectorApi):
----- -----
To set default rate correction from trimbit file, use setDefaultRateCorrection To set default rate correction from trimbit file, use setDefaultRateCorrection
Known Issue Known Issue:
------------
:getter: Always give 0 due to the microseconds precision. :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 :setter: Use scientific notation to set custom rate correction, since timedelta resolution is 1 microseconds. \n
@ -2086,7 +2084,8 @@ class Detector(CppDetectorApi):
@element @element
def readoutspeed(self): def readoutspeed(self):
""" """
[Eiger][Jungfrau|Gotthard2] Readout speed of chip. Enum: speedLevel [Eiger][Jungfrau|Gotthard2] Readout speed of chip.
Enum: speedLevel
Note Note
----- -----
@ -2175,7 +2174,8 @@ class Detector(CppDetectorApi):
@element @element
def timing(self): def timing(self):
""" """
Set Timing Mode of detector. Enum: timingMode Set Timing Mode of detector.
Enum: timingMode
Note Note
----- -----
@ -2235,13 +2235,11 @@ class Detector(CppDetectorApi):
@property @property
@element @element
def type(self): def type(self):
""" Returns detector type. Enum: detectorType """ Returns detector type.
Enum: detectorType
Note [EIGER, JUNGFRAU, GOTTHARD, MOENCH, MYTHEN3, GOTTHARD2, CHIPTESTBOARD]
----
:setter: Not implemented :setter: Not implemented
Values: EIGER, JUNGFRAU, GOTTHARD, MOENCH, MYTHEN3, GOTTHARD2, CHIPTESTBOARD
""" """
return self.getDetectorType() return self.getDetectorType()
@ -2502,9 +2500,6 @@ class Detector(CppDetectorApi):
""" """
[Eiger] Measured sub frame period between last sub frame and previous one. [Eiger] Measured sub frame period between last sub frame and previous one.
Note
-----
:setter: Not implemented :setter: Not implemented
""" """
return ut.reduce_time(self.getMeasuredSubFramePeriod()) return ut.reduce_time(self.getMeasuredSubFramePeriod())
@ -2782,7 +2777,8 @@ class Detector(CppDetectorApi):
@property @property
def gainmode(self): def gainmode(self):
""" """
[Jungfrau] Detector gain mode. Enum: gainMode [Jungfrau] Detector gain mode.
Enum: gainMode
Note Note
----- -----
@ -2895,10 +2891,7 @@ class Detector(CppDetectorApi):
@property @property
def maxclkphaseshift(self): def maxclkphaseshift(self):
""" """
[Gotthard2][Mythen3] Absolute maximum Phase shift of clocks. [Gotthard2][Mythen3] Absolute maximum Phase shift of clocks.
Note
----
:setter: Not Implemented :setter: Not Implemented
@ -2917,7 +2910,8 @@ class Detector(CppDetectorApi):
@element @element
def timingsource(self): def timingsource(self):
""" """
[Gotthard2] Timing source. Enum: timingSourceType [Gotthard2] Timing source.
Enum: timingSourceType
Note Note
----- -----
@ -2961,7 +2955,8 @@ class Detector(CppDetectorApi):
@property @property
@element @element
def burstmode(self): def burstmode(self):
"""[Gotthard2] Burst mode of detector. Enum: burstMode """[Gotthard2] Burst mode of detector.
Enum: burstMode
Note Note
---- ----
@ -2979,9 +2974,6 @@ class Detector(CppDetectorApi):
""" """
[Gotthard2] Period between 2 bursts. Only in burst mode and auto timing mode. [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 :getter: always returns in seconds. To get in DurationWrapper, use getBurstPeriod
:setter: Not Implemented :setter: Not Implemented
@ -3104,7 +3096,8 @@ class Detector(CppDetectorApi):
@property @property
def vetoalg(self): def vetoalg(self):
"""[Gotthard2] Algorithm used for veto. Enum: vetoAlgorithm, streamingInterface """[Gotthard2] Algorithm used for veto.
Enum: vetoAlgorithm, streamingInterface
Note Note
---- ----
@ -3278,7 +3271,8 @@ class Detector(CppDetectorApi):
@element @element
def romode(self): def romode(self):
""" """
[CTB] Readout mode of detector. Enum: readoutMode [CTB] Readout mode of detector.
Enum: readoutMode
Note Note
------ ------
@ -3384,9 +3378,6 @@ class Detector(CppDetectorApi):
def maxdbitphaseshift(self): def maxdbitphaseshift(self):
"""[CTB][Jungfrau] Absolute maximum Phase shift of of the clock to latch digital bits. """[CTB][Jungfrau] Absolute maximum Phase shift of of the clock to latch digital bits.
Note
-----
:setter: Not Implemented :setter: Not Implemented
""" """
return self.getMaxDBITPhaseShift() return self.getMaxDBITPhaseShift()
@ -3431,9 +3422,6 @@ class Detector(CppDetectorApi):
def maxadcphaseshift(self): def maxadcphaseshift(self):
"""[Jungfrau][Moench][CTB] Absolute maximum Phase shift of ADC clock. """[Jungfrau][Moench][CTB] Absolute maximum Phase shift of ADC clock.
Note
-----
:setter: Not Implemented :setter: Not Implemented
""" """
return self.getMaxADCPhaseShift() return self.getMaxADCPhaseShift()
@ -3483,9 +3471,6 @@ class Detector(CppDetectorApi):
""" """
[Ctb] Sync clock in MHz. [Ctb] Sync clock in MHz.
Note
-----
:setter: Not implemented :setter: Not implemented
""" """
return self.getSYNCClock() return self.getSYNCClock()
@ -3494,9 +3479,6 @@ class Detector(CppDetectorApi):
def pattern(self): def pattern(self):
"""[Mythen3][Ctb] Loads ASCII pattern file directly to server (instead of executing line by line). """[Mythen3][Ctb] Loads ASCII pattern file directly to server (instead of executing line by line).
Note
----
:getter: Not Implemented :getter: Not Implemented
Example Example
@ -3925,9 +3907,6 @@ class Detector(CppDetectorApi):
def im_a(self): def im_a(self):
"""[Ctb] Measured current of power supply a in mA. """[Ctb] Measured current of power supply a in mA.
Note
-----
:setter: Not implemented :setter: Not implemented
""" """
return self.getMeasuredCurrent(dacIndex.I_POWER_A) return self.getMeasuredCurrent(dacIndex.I_POWER_A)
@ -3937,9 +3916,6 @@ class Detector(CppDetectorApi):
def im_b(self): def im_b(self):
"""[Ctb] Measured current of power supply b in mA. """[Ctb] Measured current of power supply b in mA.
Note
-----
:setter: Not implemented :setter: Not implemented
""" """
return self.getMeasuredCurrent(dacIndex.I_POWER_B) return self.getMeasuredCurrent(dacIndex.I_POWER_B)
@ -3949,9 +3925,6 @@ class Detector(CppDetectorApi):
def im_c(self): def im_c(self):
"""[Ctb] Measured current of power supply c in mA. """[Ctb] Measured current of power supply c in mA.
Note
-----
:setter: Not implemented :setter: Not implemented
""" """
return self.getMeasuredCurrent(dacIndex.I_POWER_C) return self.getMeasuredCurrent(dacIndex.I_POWER_C)
@ -3961,9 +3934,6 @@ class Detector(CppDetectorApi):
def im_d(self): def im_d(self):
"""[Ctb] Measured current of power supply d in mA. """[Ctb] Measured current of power supply d in mA.
Note
-----
:setter: Not implemented :setter: Not implemented
""" """
return self.getMeasuredCurrent(dacIndex.I_POWER_D) return self.getMeasuredCurrent(dacIndex.I_POWER_D)
@ -3973,9 +3943,6 @@ class Detector(CppDetectorApi):
def im_io(self): def im_io(self):
"""[Ctb] Measured current of power supply io in mA. """[Ctb] Measured current of power supply io in mA.
Note
-----
:setter: Not implemented :setter: Not implemented
""" """
return self.getMeasuredCurrent(dacIndex.I_POWER_IO) return self.getMeasuredCurrent(dacIndex.I_POWER_IO)
@ -4025,9 +3992,6 @@ class Detector(CppDetectorApi):
def exptimel(self): def exptimel(self):
"""[Gotthard] Exposure time left for current frame. """[Gotthard] Exposure time left for current frame.
Note
-----
:getter: always returns in seconds. To get in DurationWrapper, use getExptimeLeft :getter: always returns in seconds. To get in DurationWrapper, use getExptimeLeft
:setter: Not Implemented :setter: Not Implemented
@ -4062,9 +4026,6 @@ class Detector(CppDetectorApi):
""" """
[Gotthard2][Mythen3] Frequency of clock in Hz. [Gotthard2][Mythen3] Frequency of clock in Hz.
Note
----
:setter: Not implemented. Use clkdiv to set frequency :setter: Not implemented. Use clkdiv to set frequency
Example Example
@ -4084,7 +4045,9 @@ class Detector(CppDetectorApi):
@property @property
@element @element
def polarity(self): def polarity(self):
"""[Mythen3] Set positive or negative polarity. Enum: polarity""" """[Mythen3] Set positive or negative polarity.
Enum: polarity
"""
return self.getPolarity() return self.getPolarity()
@polarity.setter @polarity.setter