detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-06-05 17:40:40 +02:00
Code Issues Actions Packages Releases Activity

docs, auto_comp_disable->autocompdisable, comp_disable_time->compdisabletime (removing _ in commands)

Browse Source
This commit is contained in:
maliakal_d 2021-10-21 13:11:43 +02:00
parent 802bd27e50
commit 333a23c7e2
4 changed files with 193 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
RELEASE.txt
View File

@ -61,7 +61,7 @@ This document describes the differences between v6.0.0 and v5.1.0.
Set filter cell. Options: [0-12]. Advanced user command. Set filter cell. Options: [0-12]. Advanced user command.
8. [Jungfrau] Comparator disable time (only chipv1.1) 8. [Jungfrau] Comparator disable time (only chipv1.1)
Command line: comp_disable_time, API: getComparatorDisableTime/ Command line: compdisabletime, API: getComparatorDisableTime/
setComparatorDisableTime setComparatorDisableTime
One can customize the period to disable comparator. One can customize the period to disable comparator.
@ -169,13 +169,17 @@ This document describes the differences between v6.0.0 and v5.1.0.
[Eiger][Jungfrau] same as before. [Eiger][Jungfrau] same as before.
[Gotthard2] New command to set readout speed. Options: 108, 144 (in MHz) [Gotthard2] New command to set readout speed. Options: 108, 144 (in MHz)
27. [Eiger][Jungfrau] Flip rows 27. [Eiger][Jungfrau] Flip rows
Command line: fliprows, API: getFlipRows/ setFlipRows Command line: fliprows, API: getFlipRows/ setFlipRows
Previous command: flippeddatax, setBottom/ getBottom Previous command: flippeddatax, setBottom/ getBottom
[Jungfrau] Flips rows in detector only for HW v2.0. [Jungfrau] Flips rows in detector only for HW v2.0.
slsReceiver and slsDetectorGui will not flip them again. slsReceiver and slsDetectorGui will not flip them again.
[Eiger] same as before. [Eiger] same as before.
28. [Jungfrau]
Command line changes: autocompdisable, Previous command line: auto_comp_disable
Detector servers Detector servers
---------------- ----------------

184
python/slsdet/detector.py
View File

@ -124,7 +124,6 @@ class Detector(CppDetectorApi):
----- -----
Equivalent to config, but does not free shared memory. Equivalent to config, but does not free shared memory.
:getter: Not implemented :getter: Not implemented
:setter: loads parameters file :setter: loads parameters file
@ -146,6 +145,7 @@ class Detector(CppDetectorApi):
def hostname(self): def hostname(self):
"""Frees shared memory and sets hostname (or IP address) of all modules concatenated by + """Frees shared memory and sets hostname (or IP address) of all modules concatenated by +
Virtual servers can already use the port in hostname separated by ':' and ports incremented by 2 to accomodate the stop server as well. Virtual servers can already use the port in hostname separated by ':' and ports incremented by 2 to accomodate the stop server as well.
Example Example
------- -------
>>> d.hostname = 'beb031+beb032+' >>> d.hostname = 'beb031+beb032+'
@ -203,6 +203,7 @@ class Detector(CppDetectorApi):
def firmwareversion(self): def firmwareversion(self):
""" """
Fimware version of detector in format [0xYYMMDD] or an increasing 2 digit number for Eiger. Fimware version of detector in format [0xYYMMDD] or an increasing 2 digit number for Eiger.
Example Example
------- -------
>>> d.firmwareversion >>> d.firmwareversion
@ -215,6 +216,7 @@ class Detector(CppDetectorApi):
def detectorserverversion(self): def detectorserverversion(self):
""" """
On-board detector server software version in format [0xYYMMDD] On-board detector server software version in format [0xYYMMDD]
Example Example
------- -------
>>> d.detectorserverversion >>> d.detectorserverversion
@ -225,6 +227,7 @@ class Detector(CppDetectorApi):
@property @property
def clientversion(self): def clientversion(self):
"""Client software version in format [YYMMDD] """Client software version in format [YYMMDD]
Example Example
------- -------
>>> d.clientversion >>> d.clientversion
@ -247,6 +250,7 @@ class Detector(CppDetectorApi):
Note Note
----- -----
If no streamer yet or there is no second interface, it gives 0 in its place. If no streamer yet or there is no second interface, it gives 0 in its place.
:setter: Not Implemented :setter: Not Implemented
""" """
return self.getRxThreadIds() return self.getRxThreadIds()
@ -288,10 +292,12 @@ class Detector(CppDetectorApi):
def detsize(self): def detsize(self):
""" """
Sets the detector size in both dimensions (number of channels). Sets the detector size in both dimensions (number of channels).
Note Note
----- -----
This value is used to calculate row and column positions for each module and included into udp data packet header. \n This value is used to calculate row and column positions for each module and included into udp data packet header. \n
By default, it adds modules in y dimension for 2d detectors and in x dimension for 1d detectors. By default, it adds modules in y dimension for 2d detectors and in x dimension for 1d detectors.
Example Example
------- -------
>>> d.detsize >>> d.detsize
@ -312,6 +318,7 @@ class Detector(CppDetectorApi):
def settings(self): def settings(self):
""" """
Detector settings. Enum: detectorSettings Detector settings. Enum: detectorSettings
Note Note
----- -----
@ -351,6 +358,7 @@ class Detector(CppDetectorApi):
""" """
[Gotthard][Jungfrau][Mythen3][Gotthard2][CTB][Moench] Number of frames left in acquisition.\n [Gotthard][Jungfrau][Mythen3][Gotthard2][CTB][Moench] Number of frames left in acquisition.\n
[Gotthard2] only in continuous auto mode. [Gotthard2] only in continuous auto mode.
:setter: Not Implemented :setter: Not Implemented
""" """
return self.getNumberOfFramesLeft() return self.getNumberOfFramesLeft()
@ -360,9 +368,11 @@ class Detector(CppDetectorApi):
def framecounter(self): def framecounter(self):
""" """
[Jungfrau][Mythen3][Gotthard2][Moench][CTB] Number of frames from start run control. [Jungfrau][Mythen3][Gotthard2][Moench][CTB] Number of frames from start run control.
Note Note
----- -----
[Gotthard2] only in continuous mode. [Gotthard2] only in continuous mode.
:setter: Not Implemented :setter: Not Implemented
""" """
return self.getNumberOfFramesFromStart() return self.getNumberOfFramesFromStart()
@ -387,6 +397,7 @@ class Detector(CppDetectorApi):
def powerchip(self): def powerchip(self):
""" """
[Jungfrau][Mythen3][Gotthard2][Moench] Power the chip. [Jungfrau][Mythen3][Gotthard2][Moench] Power the chip.
Note Note
---- ----
[Moench] Default is disabled. \n [Moench] Default is disabled. \n
@ -479,11 +490,14 @@ class Detector(CppDetectorApi):
def periodl(self): def periodl(self):
""" """
[Gotthard][Jungfrau][CTB][Moench][Mythen3][Gotthard2] Period left for current frame. [Gotthard][Jungfrau][CTB][Moench][Mythen3][Gotthard2] Period left for current frame.
Note Note
----- -----
[Gotthard2] only in continuous mode. [Gotthard2] only in continuous mode.
:getter: always returns in seconds. To get in datetime.delta, use getPeriodLeft :getter: always returns in seconds. To get in datetime.delta, use getPeriodLeft
:setter: Not Implemented :setter: Not Implemented
Example Example
----------- -----------
>>> d.periodl >>> d.periodl
@ -501,6 +515,7 @@ class Detector(CppDetectorApi):
Note Note
----- -----
:getter: always returns in seconds. To get in datetime.delta, use getDelayAfterTrigger :getter: always returns in seconds. To get in datetime.delta, use getDelayAfterTrigger
Example Example
@ -527,8 +542,10 @@ class Detector(CppDetectorApi):
Note Note
----- -----
[Gotthard2] only in continuous mdoe. [Gotthard2] only in continuous mdoe.
:getter: always returns in seconds. To get in datetime.delta, use getDelayAfterTriggerLeft :getter: always returns in seconds. To get in datetime.delta, use getDelayAfterTriggerLeft
:setter: Not Implemented :setter: Not Implemented
Example Example
----------- -----------
>>> d.delayl >>> d.delayl
@ -576,6 +593,7 @@ class Detector(CppDetectorApi):
def txndelay_frame(self): def txndelay_frame(self):
""" """
[Eiger][Jungfrau][Mythen3] Transmission delay of first udp packet being streamed out of the module.\n [Eiger][Jungfrau][Mythen3] Transmission delay of first udp packet being streamed out of the module.\n
Note Note
---- ----
[Jungfrau] [0-31] Each value represents 1 ms. \n [Jungfrau] [0-31] Each value represents 1 ms. \n
@ -592,6 +610,7 @@ class Detector(CppDetectorApi):
@element @element
def txndelay_left(self): def txndelay_left(self):
"""[Eiger] Transmission delay of first packet in an image being streamed out of the module's left UDP port. """[Eiger] Transmission delay of first packet in an image being streamed out of the module's left UDP port.
Note Note
----- -----
Each value represents 10ns. Typical value is 50000. Each value represents 10ns. Typical value is 50000.
@ -607,6 +626,7 @@ class Detector(CppDetectorApi):
def txndelay_right(self): def txndelay_right(self):
""" """
[Eiger] Transmission delay of first packet in an image being streamed out of the module's right UDP port. [Eiger] Transmission delay of first packet in an image being streamed out of the module's right UDP port.
Note Note
---- ----
Each value represents 10ns. Typical value is 50000. Each value represents 10ns. Typical value is 50000.
@ -626,11 +646,13 @@ class Detector(CppDetectorApi):
@element @element
def rx_hostname(self): def rx_hostname(self):
""" Sets receiver hostname or IP address. Used for TCP control communication between client and receiver to configure receiver. Also updates receiver with detector parameters. """ Sets receiver hostname or IP address. Used for TCP control communication between client and receiver to configure receiver. Also updates receiver with detector parameters.
Note Note
----- -----
Also resets any prior receiver property (not on detector). \n Also resets any prior receiver property (not on detector). \n
Can concatenate receiver hostnames for every module. \n Can concatenate receiver hostnames for every module. \n
If port included, then its the receiver tcp port for every receiver hostname. If port included, then its the receiver tcp port for every receiver hostname.
Example Example
-------- --------
>>> d.rx_hostname >>> d.rx_hostname
@ -654,12 +676,14 @@ class Detector(CppDetectorApi):
def rx_tcpport(self): def rx_tcpport(self):
""" """
TCP port for client-receiver communication. TCP port for client-receiver communication.
Note Note
----- -----
Default is 1954. \n Default is 1954. \n
Must be different if multiple receivers on same pc. \n Must be different if multiple receivers on same pc. \n
Must be first command to set a receiver parameter to be able to communicate. \n Must be first command to set a receiver parameter to be able to communicate. \n
Multi command will automatically increment port for individual modules, which must be set via setRxPort. Multi command will automatically increment port for individual modules, which must be set via setRxPort.
Example Example
------- -------
>>> d.rx_tcpport >>> d.rx_tcpport
@ -698,6 +722,7 @@ class Detector(CppDetectorApi):
def rx_discardpolicy(self): def rx_discardpolicy(self):
""" """
Frame discard policy of receiver. Enum: frameDiscardPolicy Frame discard policy of receiver. Enum: frameDiscardPolicy
Note Note
----- -----
Options: NO_DISCARD, DISCARD_EMPTY_FRAMES, DISCARD_PARTIAL_FRAMES \n Options: NO_DISCARD, DISCARD_EMPTY_FRAMES, DISCARD_PARTIAL_FRAMES \n
@ -720,6 +745,7 @@ class Detector(CppDetectorApi):
@element @element
def rx_padding(self): def rx_padding(self):
"""Partial frames padding enable in the receiver. """Partial frames padding enable in the receiver.
Note Note
------ ------
Default: enabled \n Default: enabled \n
@ -753,6 +779,7 @@ class Detector(CppDetectorApi):
@element @element
def numinterfaces(self): def numinterfaces(self):
"""[Jungfrau][Gotthard2] Number of udp interfaces to stream data from detector. Default is 1. """[Jungfrau][Gotthard2] Number of udp interfaces to stream data from detector. Default is 1.
Note Note
----- -----
Also enables second interface in receiver for listening (Writes a file per interface if writing enabled). \n Also enables second interface in receiver for listening (Writes a file per interface if writing enabled). \n
@ -769,18 +796,18 @@ class Detector(CppDetectorApi):
@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
----- -----
Options: BINARY, HDF5 Options: BINARY, HDF5
Default: BINARY Default: BINARY
For HDF5, package must be compiled with HDF5 flags. Default is binary. For HDF5, package must be compiled with HDF5 flags. Default is binary.
Example Example
-------- --------
d.fformat = fileFormat.BINARY d.fformat = fileFormat.BINARY
""" """
return self.getFileFormat() return self.getFileFormat()
@fformat.setter @fformat.setter
@ -791,6 +818,7 @@ class Detector(CppDetectorApi):
@element @element
def findex(self): def findex(self):
"""File or Acquisition index in receiver. """File or Acquisition index in receiver.
Note Note
---- ----
File name: [file name prefix]_d[detector index]_f[sub file index]_[acquisition/file index].[raw/h5]. File name: [file name prefix]_d[detector index]_f[sub file index]_[acquisition/file index].[raw/h5].
@ -825,6 +853,7 @@ class Detector(CppDetectorApi):
@element @element
def fpath(self): def fpath(self):
"""Directory where output data files are written in receiver. Default is "/". """Directory where output data files are written in receiver. Default is "/".
Note Note
---- ----
If path does not exist, it will try to create it. If path does not exist, it will try to create it.
@ -906,6 +935,7 @@ class Detector(CppDetectorApi):
@element @element
def rx_zmqfreq(self): def rx_zmqfreq(self):
"""Frequency of frames streamed out from receiver via zmq. """Frequency of frames streamed out from receiver via zmq.
Note Note
----- -----
Default: 1, Means every frame is streamed out. \n Default: 1, Means every frame is streamed out. \n
@ -923,6 +953,7 @@ class Detector(CppDetectorApi):
def rx_zmqport(self): def rx_zmqport(self):
""" """
Zmq port for data to be streamed out of the receiver. Zmq port for data to be streamed out of the receiver.
Note Note
----- -----
Also restarts receiver zmq streaming if enabled. \n Also restarts receiver zmq streaming if enabled. \n
@ -957,12 +988,14 @@ class Detector(CppDetectorApi):
def zmqport(self): def zmqport(self):
""" """
Port number to listen to zmq data streamed out from receiver or intermediate process. Port number to listen to zmq data streamed out from receiver or intermediate process.
Note Note
----- -----
Also restarts client zmq streaming if enabled. \n Also restarts client zmq streaming if enabled. \n
Default connects to receiver zmq streaming out port (30001). \n Default connects to receiver zmq streaming out port (30001). \n
Must be different for every detector (and udp port). \n Must be different for every detector (and udp port). \n
Multi command will automatically increment for individual modules, use setClientZmqPort. Multi command will automatically increment for individual modules, use setClientZmqPort.
Example Example
-------- --------
>>> d.zmqport >>> d.zmqport
@ -989,6 +1022,7 @@ class Detector(CppDetectorApi):
def rx_zmqip(self): def rx_zmqip(self):
""" """
Zmq Ip Address from which data is to be streamed out of the receiver. Zmq Ip Address from which data is to be streamed out of the receiver.
Note Note
----- -----
Also restarts receiver zmq streaming if enabled. \n Also restarts receiver zmq streaming if enabled. \n
@ -1013,6 +1047,7 @@ class Detector(CppDetectorApi):
def zmqip(self): def zmqip(self):
""" """
Ip Address to listen to zmq data streamed out from receiver or intermediate process. Ip Address to listen to zmq data streamed out from receiver or intermediate process.
Note Note
----- -----
Also restarts client zmq streaming if enabled. \n Also restarts client zmq streaming if enabled. \n
@ -1063,10 +1098,12 @@ class Detector(CppDetectorApi):
def udp_dstip(self): def udp_dstip(self):
""" """
Ip address of the receiver (destination) udp interface. Ip address of the receiver (destination) udp interface.
Note Note
---- ----
If 'auto' used, then ip is set to ip of rx_hostname. \n If 'auto' used, then ip is set to ip of rx_hostname. \n
To set IPs for individual modules, use setDestinationUDPIP. To set IPs for individual modules, use setDestinationUDPIP.
Example Example
------ ------
>>> d.udp_dstip = '192.168.1.110' >>> d.udp_dstip = '192.168.1.110'
@ -1088,12 +1125,14 @@ class Detector(CppDetectorApi):
def udp_dstip2(self): def udp_dstip2(self):
""" """
[Jungfrau][Gotthard2] Ip address of the receiver (destination) udp interface 2. [Jungfrau][Gotthard2] Ip address of the receiver (destination) udp interface 2.
Note Note
---- ----
[Jungfrau] bottom half \n [Jungfrau] bottom half \n
[Gotthard2] veto debugging \n [Gotthard2] veto debugging \n
If 'auto' used, then ip is set to ip of rx_hostname. \n If 'auto' used, then ip is set to ip of rx_hostname. \n
To set IPs for individual modules, use setDestinationUDPIP2. To set IPs for individual modules, use setDestinationUDPIP2.
Example Example
------ ------
>>> d.udp_dstip2 = '10.1.1.185' >>> d.udp_dstip2 = '10.1.1.185'
@ -1114,10 +1153,12 @@ class Detector(CppDetectorApi):
def udp_dstmac(self): def udp_dstmac(self):
""" """
Mac address of the receiver (destination) udp interface. Mac address of the receiver (destination) udp interface.
Note Note
---- ----
Not mandatory to set as udp_dstip retrieves it from slsReceiver process but must be set if you use a custom receiver (not slsReceiver). \n Not mandatory to set as udp_dstip retrieves it from slsReceiver process but must be set if you use a custom receiver (not slsReceiver). \n
To set MACs for individual modules, use setDestinationUDPMAC. To set MACs for individual modules, use setDestinationUDPMAC.
Example Example
------- -------
>>> d.udp_dstmac = '00:1b:31:01:8a:de' >>> d.udp_dstmac = '00:1b:31:01:8a:de'
@ -1136,12 +1177,14 @@ class Detector(CppDetectorApi):
def udp_dstmac2(self): def udp_dstmac2(self):
""" """
[Jungfrau][Gotthard2] Mac address of the receiver (destination) udp interface 2. [Jungfrau][Gotthard2] Mac address of the receiver (destination) udp interface 2.
Note Note
---- ----
Not mandatory to set as udp_dstip2 retrieves it from slsReceiver process but must be set if you use a custom receiver (not slsReceiver). \n Not mandatory to set as udp_dstip2 retrieves it from slsReceiver process but must be set if you use a custom receiver (not slsReceiver). \n
To set MACs for individual modules, use setDestinationUDPMAC2. \n To set MACs for individual modules, use setDestinationUDPMAC2. \n
[Jungfrau] bottom half \n [Jungfrau] bottom half \n
[Gotthard2] veto debugging \n [Gotthard2] veto debugging \n
Example Example
------ ------
>>> d.udp_dstmac2 = '00:1b:31:01:8a:de' >>> d.udp_dstmac2 = '00:1b:31:01:8a:de'
@ -1160,10 +1203,12 @@ class Detector(CppDetectorApi):
def udp_srcmac(self): def udp_srcmac(self):
""" """
Mac address of the receiver (source) udp interface. Mac address of the receiver (source) udp interface.
Note Note
---- ----
[Eiger] Do not set as detector will replace with its own DHCP Mac (1G) or DHCP Mac + 1 (10G). \n [Eiger] Do not set as detector will replace with its own DHCP Mac (1G) or DHCP Mac + 1 (10G). \n
To set MACs for individual modules, use setSourceUDPMAC. To set MACs for individual modules, use setSourceUDPMAC.
Example Example
------- -------
>>> d.udp_srcmac = '00:1b:31:01:8a:de' >>> d.udp_srcmac = '00:1b:31:01:8a:de'
@ -1182,11 +1227,13 @@ class Detector(CppDetectorApi):
def udp_srcmac2(self): def udp_srcmac2(self):
""" """
[Jungfrau][Gotthard2] Mac address of the receiver (source) udp interface 2. [Jungfrau][Gotthard2] Mac address of the receiver (source) udp interface 2.
Note Note
---- ----
[Jungfrau] bottom half \n [Jungfrau] bottom half \n
[Gotthard2] veto debugging \n [Gotthard2] veto debugging \n
To set MACs for individual modules, use setSourceUDPMAC2. To set MACs for individual modules, use setSourceUDPMAC2.
Example Example
------- -------
>>> d.udp_srcmac2 = '00:1b:31:01:8a:de' >>> d.udp_srcmac2 = '00:1b:31:01:8a:de'
@ -1205,11 +1252,13 @@ class Detector(CppDetectorApi):
def udp_srcip(self): def udp_srcip(self):
""" """
Ip address of the detector (source) udp interface. Ip address of the detector (source) udp interface.
Note Note
----- -----
Must be same subnet as destination udp ip.\n Must be same subnet as destination udp ip.\n
[Eiger] Set only for 10G. For 1G, detector will replace with its own DHCP IP address. \n [Eiger] Set only for 10G. For 1G, detector will replace with its own DHCP IP address. \n
To set IPs for individual modules, use setSourceUDPIP. To set IPs for individual modules, use setSourceUDPIP.
Example Example
------- -------
>>> d.udp_srcip = '192.168.1.127' >>> d.udp_srcip = '192.168.1.127'
@ -1228,12 +1277,14 @@ class Detector(CppDetectorApi):
def udp_srcip2(self): def udp_srcip2(self):
""" """
[Jungfrau][Gotthard2] Ip address of the detector (source) udp interface 2. [Jungfrau][Gotthard2] Ip address of the detector (source) udp interface 2.
Note Note
----- -----
[Jungfrau] bottom half \n [Jungfrau] bottom half \n
[Gotthard2] veto debugging \n [Gotthard2] veto debugging \n
Must be same subnet as destination udp ip2.\n Must be same subnet as destination udp ip2.\n
To set IPs for individual modules, use setSourceUDPIP2. To set IPs for individual modules, use setSourceUDPIP2.
Example Example
------- -------
>>> d.udp_srcip2 = '192.168.1.127' >>> d.udp_srcip2 = '192.168.1.127'
@ -1252,6 +1303,7 @@ class Detector(CppDetectorApi):
def udp_dstport(self): def udp_dstport(self):
""" """
Port number of the receiver (destination) udp interface. Port number of the receiver (destination) udp interface.
Note Note
---- ----
Default is 50001. \n Default is 50001. \n
@ -1269,6 +1321,7 @@ class Detector(CppDetectorApi):
def udp_dstport2(self): def udp_dstport2(self):
""" """
Port number of the receiver (destination) udp interface. Port number of the receiver (destination) udp interface.
Note Note
---- ----
Default is 50002. \n Default is 50002. \n
@ -1323,6 +1376,7 @@ class Detector(CppDetectorApi):
@element @element
def status(self): def status(self):
"""Gets detector status. Enum: runStatus """Gets detector status. Enum: runStatus
Note Note
----- -----
Options: IDLE, ERROR, WAITING, RUN_FINISHED, TRANSMITTING, RUNNING, STOPPED \n Options: IDLE, ERROR, WAITING, RUN_FINISHED, TRANSMITTING, RUNNING, STOPPED \n
@ -1336,6 +1390,7 @@ class Detector(CppDetectorApi):
@element @element
def rx_status(self): def rx_status(self):
"""Gets receiver listener status. Enum: runStatus """Gets receiver listener status. Enum: runStatus
Note Note
----- -----
Options: IDLE, TRANSMITTING, RUNNING Options: IDLE, TRANSMITTING, RUNNING
@ -1364,10 +1419,13 @@ class Detector(CppDetectorApi):
def trimbits(self): def trimbits(self):
""" """
[Eiger][Mythen3] Loads custom trimbit file to detector. [Eiger][Mythen3] Loads custom trimbit file to detector.
Note Note
----- -----
If no extension specified, serial number of each module is attached. If no extension specified, serial number of each module is attached.
:getter: Not implemented :getter: Not implemented
Example Example
------- -------
>>> d.trimbits = '/path_to_file/noise' >>> d.trimbits = '/path_to_file/noise'
@ -1423,6 +1481,7 @@ class Detector(CppDetectorApi):
def rx_zmqstartfnum(self): def rx_zmqstartfnum(self):
""" """
The starting frame index to stream out. The starting frame index to stream out.
Note Note
---- ----
0 by default, which streams the first frame in an acquisition, and then depending on the rx zmq frequency/ timer. 0 by default, which streams the first frame in an acquisition, and then depending on the rx zmq frequency/ timer.
@ -1456,6 +1515,7 @@ class Detector(CppDetectorApi):
def slowadc(self): def slowadc(self):
""" """
[Ctb] Slow ADC channel in uV of all channels or specific ones from 0-7. [Ctb] Slow ADC channel in uV of all channels or specific ones from 0-7.
Example Example
------- -------
>>> d.slowadc >>> d.slowadc
@ -1524,6 +1584,7 @@ class Detector(CppDetectorApi):
@element @element
def adcinvert(self): def adcinvert(self):
"""[Ctb][Moench][Jungfrau] ADC Inversion Mask. """[Ctb][Moench][Jungfrau] ADC Inversion Mask.
Note Note
----- -----
[Jungfrau][Moench] Inversions on top of the default mask. [Jungfrau][Moench] Inversions on top of the default mask.
@ -1539,9 +1600,11 @@ class Detector(CppDetectorApi):
def triggersl(self): def triggersl(self):
""" """
[Gotthard][Jungfrau][Mythen3][Gotthard2][CTB][Moench] Number of triggers left in acquisition.\n [Gotthard][Jungfrau][Mythen3][Gotthard2][CTB][Moench] Number of triggers left in acquisition.\n
Note Note
---- ----
Only when external trigger used. Only when external trigger used.
:setter: Not Implemented :setter: Not Implemented
""" """
return self.getNumberOfTriggersLeft() return self.getNumberOfTriggersLeft()
@ -1550,6 +1613,7 @@ class Detector(CppDetectorApi):
@element @element
def frametime(self): def frametime(self):
"""[Jungfrau][Mythen3][Gotthard2][Moench][CTB] Timestamp at a frame start. """[Jungfrau][Mythen3][Gotthard2][Moench][CTB] Timestamp at a frame start.
Note Note
---- ----
[Gotthard2] not in burst and auto mode. [Gotthard2] not in burst and auto mode.
@ -1598,9 +1662,11 @@ class Detector(CppDetectorApi):
def virtual(self): def virtual(self):
""" """
Setup with n virtual servers running on localhost starting with control port p Setup with n virtual servers running on localhost starting with control port p
Note Note
---- ----
Every virtual server will have a stop port (control port + 1) Every virtual server will have a stop port (control port + 1)
Example Example
--------- ---------
>>> d.virtual = n, p >>> d.virtual = n, p
@ -1630,11 +1696,11 @@ class Detector(CppDetectorApi):
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
Or use setDefaultRateCorrection to set the default one from trimbit file Or use setDefaultRateCorrection to set the default one from trimbit file
Example Example
----------- -----------
>>> d.ratecorr = 10e-9 >>> d.ratecorr = 10e-9
@ -1654,6 +1720,7 @@ class Detector(CppDetectorApi):
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
----- -----
[Jungfrau] FULL_SPEED, HALF_SPEED (Default), QUARTER_SPEED [Jungfrau] FULL_SPEED, HALF_SPEED (Default), QUARTER_SPEED
@ -1672,11 +1739,13 @@ class Detector(CppDetectorApi):
def rx_jsonpara(self): def rx_jsonpara(self):
""" """
Set the receiver additional json parameter. Set the receiver additional json parameter.
Note Note
---- ----
Use only if to be processed by an intermediate user process listening to receiver zmq packets, such as Moench \n Use only if to be processed by an intermediate user process listening to receiver zmq packets, such as Moench \n
If not found, the pair is appended. Empty value deletes parameter. Max 20 characters for each key/value.\n If not found, the pair is appended. Empty value deletes parameter. Max 20 characters for each key/value.\n
On setting the value is automatically, it is converted to a string. On setting the value is automatically, it is converted to a string.
Example Example
----------- -----------
>>> d.rx_jsonpara['emin'] >>> d.rx_jsonpara['emin']
@ -1694,11 +1763,13 @@ class Detector(CppDetectorApi):
def rx_jsonaddheader(self): def rx_jsonaddheader(self):
""" """
Additional json header to be streamed out from receiver via zmq. Additional json header to be streamed out from receiver via zmq.
Note Note
----- -----
Default is empty. Max 20 characters for each key/value\n Default is empty. Max 20 characters for each key/value\n
Use only if to be processed by an intermediate user process listening to receiver zmq packets, such as Moench \n Use only if to be processed by an intermediate user process listening to receiver zmq packets, such as Moench \n
Empty value deletes header. Empty value deletes header.
Example Example
------- -------
>>> d.rx_jsonaddheader >>> d.rx_jsonaddheader
@ -1717,9 +1788,11 @@ class Detector(CppDetectorApi):
@element @element
def threshold(self): def threshold(self):
"""[Eiger] Threshold in eV """[Eiger] Threshold in eV
Note Note
---- ----
To change settings as well or set threshold without trimbits, use setThresholdEnergy. To change settings as well or set threshold without trimbits, use setThresholdEnergy.
:setter: It loads trim files from settingspath. :setter: It loads trim files from settingspath.
""" """
if self.type == detectorType.MYTHEN3: if self.type == detectorType.MYTHEN3:
@ -1735,6 +1808,7 @@ class Detector(CppDetectorApi):
def timing(self): def timing(self):
""" """
Set Timing Mode of detector. Enum: timingMode Set Timing Mode of detector. Enum: timingMode
Note Note
----- -----
Default: AUTO_TIMING \n Default: AUTO_TIMING \n
@ -1753,6 +1827,7 @@ class Detector(CppDetectorApi):
def trimen(self): def trimen(self):
""" """
[Eiger] List of trim energies, where corresponding default trim files exist in corresponding trim folders. [Eiger] List of trim energies, where corresponding default trim files exist in corresponding trim folders.
Example Example
------ ------
>>> d.trimen >>> d.trimen
@ -1772,6 +1847,7 @@ class Detector(CppDetectorApi):
def vthreshold(self): def vthreshold(self):
""" """
[Eiger][Mythen3] Detector threshold voltage for single photon counters in dac units. [Eiger][Mythen3] Detector threshold voltage for single photon counters in dac units.
Note Note
---- ----
[Eiger] Sets vcmp_ll, vcmp_lr, vcmp_rl, vcmp_rr and vcp to the same value. \n [Eiger] Sets vcmp_ll, vcmp_lr, vcmp_rl, vcmp_rr and vcp to the same value. \n
@ -1792,8 +1868,10 @@ class Detector(CppDetectorApi):
@element @element
def type(self): def type(self):
""" Returns detector type. Enum: detectorType """ Returns detector type. Enum: detectorType
Note Note
---- ----
:setter: Not implemented :setter: Not implemented
Values: EIGER, JUNGFRAU, GOTTHARD, MOENCH, MYTHEN3, GOTTHARD2, CHIPTESTBOARD Values: EIGER, JUNGFRAU, GOTTHARD, MOENCH, MYTHEN3, GOTTHARD2, CHIPTESTBOARD
""" """
@ -1846,9 +1924,11 @@ class Detector(CppDetectorApi):
def subexptime(self): def subexptime(self):
""" """
[Eiger] Exposure time of EIGER subframes in 32 bit mode. [Eiger] Exposure time of EIGER subframes in 32 bit mode.
Note Note
---- ----
Subperiod = subexptime + subdeadtime. Subperiod = subexptime + subdeadtime.
:getter: always returns in seconds. To get in datetime.delta, use getSubExptime :getter: always returns in seconds. To get in datetime.delta, use getSubExptime
Example Example
@ -1873,6 +1953,7 @@ class Detector(CppDetectorApi):
""" """
[Eiger] Number of rows to read out per half module starting from the centre. [Eiger] Number of rows to read out per half module starting from the centre.
[Jungfrau] Number of rows to read per module starting from the centre. [Jungfrau] Number of rows to read per module starting from the centre.
Note Note
---- ----
[Eiger] Options: 1 - 256. 256 is default. \n [Eiger] Options: 1 - 256. 256 is default. \n
@ -1890,9 +1971,11 @@ class Detector(CppDetectorApi):
def subdeadtime(self): def subdeadtime(self):
""" """
[Eiger] Dead time of EIGER subframes in 32 bit mode, accepts either a value in seconds or datetime.timedelta [Eiger] Dead time of EIGER subframes in 32 bit mode, accepts either a value in seconds or datetime.timedelta
Note Note
---- ----
Subperiod = subexptime + subdeadtime. Subperiod = subexptime + subdeadtime.
:getter: always returns in seconds. To get in datetime.delta, use getSubDeadTime :getter: always returns in seconds. To get in datetime.delta, use getSubDeadTime
Example Example
@ -1916,6 +1999,7 @@ class Detector(CppDetectorApi):
def parallel(self): def parallel(self):
""" """
[Eiger][Mythen3] Enable or disable the parallel readout mode of detector. [Eiger][Mythen3] Enable or disable the parallel readout mode of detector.
Note Note
---- ----
[Mythen3] If exposure time is too short, acquisition will return with an ERROR and take fewer frames than expected. [Mythen3] If exposure time is too short, acquisition will return with an ERROR and take fewer frames than expected.
@ -1930,6 +2014,7 @@ class Detector(CppDetectorApi):
@element @element
def partialreset(self): def partialreset(self):
"""[Eiger] Sets up detector to do partial or complete reset at start of acquisition. 0 complete reset, 1 partial reset. Default is complete reset. """[Eiger] Sets up detector to do partial or complete reset at start of acquisition. 0 complete reset, 1 partial reset. Default is complete reset.
Note Note
----- -----
Advanced Function! Advanced Function!
@ -1998,6 +2083,7 @@ class Detector(CppDetectorApi):
Note Note
----- -----
Can be measured with minimum 2 frames in an acquisition. Can be measured with minimum 2 frames in an acquisition.
:setter: Not implemented :setter: Not implemented
""" """
return ut.reduce_time(self.getMeasuredPeriod()) return ut.reduce_time(self.getMeasuredPeriod())
@ -2007,8 +2093,10 @@ class Detector(CppDetectorApi):
def measuredsubperiod(self): def measuredsubperiod(self):
""" """
[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 Note
----- -----
:setter: Not implemented :setter: Not implemented
""" """
return ut.reduce_time(self.getMeasuredSubFramePeriod()) return ut.reduce_time(self.getMeasuredSubFramePeriod())
@ -2033,7 +2121,7 @@ class Detector(CppDetectorApi):
@property @property
@element @element
def auto_comp_disable(self): def autocompdisable(self):
"""[Jungfrau] Enable or disable auto comparator disable mode. """[Jungfrau] Enable or disable auto comparator disable mode.
Note Note
@ -2043,33 +2131,34 @@ class Detector(CppDetectorApi):
""" """
return self.getAutoComparatorDisable() return self.getAutoComparatorDisable()
@auto_comp_disable.setter @autocompdisable.setter
def auto_comp_disable(self, value): def autocompdisable(self, value):
ut.set_using_dict(self.setAutoComparatorDisable, value) ut.set_using_dict(self.setAutoComparatorDisable, value)
@property @property
@element @element
def comp_disable_time(self): def compdisabletime(self):
"""[Jungfrau] Time before end of exposure when comparator is disabled. """[Jungfrau] Time before end of exposure when comparator is disabled.
Note Note
----- -----
It is only possible for chipv1.1. It is only possible for chipv1.1.
:getter: always returns in seconds. To get in datetime.delta, use getComparatorDisableTime :getter: always returns in seconds. To get in datetime.delta, use getComparatorDisableTime
Example Example
----------- -----------
>>> d.comp_disable_time = 1.05 >>> d.compdisabletime = 1.05
>>> d.comp_disable_time = datetime.timedelta(minutes = 3, seconds = 1.23) >>> d.compdisabletime = datetime.timedelta(minutes = 3, seconds = 1.23)
>>> d.comp_disable_time >>> d.compdisabletime
181.23 181.23
>>> d.getComparatorDisableTime() >>> d.getComparatorDisableTime()
[datetime.timedelta(seconds=181, microseconds=230000)] [datetime.timedelta(seconds=181, microseconds=230000)]
""" """
return ut.reduce_time(self.getComparatorDisableTime()) return ut.reduce_time(self.getComparatorDisableTime())
@comp_disable_time.setter @compdisabletime.setter
def comp_disable_time(self, value): def compdisabletime(self, value):
ut.set_time_using_dict(self.setComparatorDisableTime, value) ut.set_time_using_dict(self.setComparatorDisableTime, value)
@ -2077,6 +2166,7 @@ class Detector(CppDetectorApi):
@element @element
def runtime(self): def runtime(self):
"""[Jungfrau][Mythen3][Gotthard2][Moench][CTB] Time from detector start up. """[Jungfrau][Mythen3][Gotthard2][Moench][CTB] Time from detector start up.
Note Note
----- -----
[Gotthard2] not in burst and auto mode. [Gotthard2] not in burst and auto mode.
@ -2122,10 +2212,12 @@ class Detector(CppDetectorApi):
def storagecell_delay(self): def storagecell_delay(self):
""" """
[Jungfrau] Additional time delay between 2 consecutive exposures in burst mode, accepts either a value in seconds or datetime.timedelta [Jungfrau] Additional time delay between 2 consecutive exposures in burst mode, accepts either a value in seconds or datetime.timedelta
Note Note
----- -----
Only applicable for chipv1.0. For advanced users only \n Only applicable for chipv1.0. For advanced users only \n
Value: 0-1638375 ns (resolution of 25ns) \n Value: 0-1638375 ns (resolution of 25ns)
:getter: always returns in seconds. To get in datetime.delta, use getStorageCellDelay :getter: always returns in seconds. To get in datetime.delta, use getStorageCellDelay
Example Example
@ -2148,6 +2240,7 @@ class Detector(CppDetectorApi):
def temp_threshold(self): def temp_threshold(self):
""" """
[Jungfrau] Threshold temperature in degrees. [Jungfrau] Threshold temperature in degrees.
Note Note
----- -----
If temperature crosses threshold temperature and temperature control is enabled, power to chip will be switched off and temperature event occurs. \n If temperature crosses threshold temperature and temperature control is enabled, power to chip will be switched off and temperature event occurs. \n
@ -2164,10 +2257,12 @@ class Detector(CppDetectorApi):
def temp_event(self): def temp_event(self):
""" """
[Jungfrau] 1, if a temperature event occured. \n [Jungfrau] 1, if a temperature event occured. \n
Note Note
---- ----
If temperature crosses threshold temperature and temperature control is enabled, power to chip will be switched off and temperature event occurs. \n If temperature crosses threshold temperature and temperature control is enabled, power to chip will be switched off and temperature event occurs. \n
To power on chip again, temperature has to be less than threshold temperature and temperature event has to be cleared/reset. To power on chip again, temperature has to be less than threshold temperature and temperature event has to be cleared/reset.
:setter: To clear the event, set it to 0. :setter: To clear the event, set it to 0.
""" """
return self.getTemperatureEvent() return self.getTemperatureEvent()
@ -2190,6 +2285,7 @@ class Detector(CppDetectorApi):
def temp_control(self): def temp_control(self):
""" """
[Jungfrau] Temperature control enable. [Jungfrau] Temperature control enable.
Note Note
----- -----
Default is 0 (disabled). \n Default is 0 (disabled). \n
@ -2206,6 +2302,7 @@ class Detector(CppDetectorApi):
@element @element
def selinterface(self): def selinterface(self):
"""[Jungfrau] The udp interface to stream data from detector. """[Jungfrau] The udp interface to stream data from detector.
Note Note
----- -----
Effective only when number of interfaces is 1. Default: 0 (outer). Inner is 1. Effective only when number of interfaces is 1. Default: 0 (outer). Inner is 1.
@ -2270,9 +2367,11 @@ class Detector(CppDetectorApi):
def burstsl(self): def burstsl(self):
""" """
[Gotthard2] Number of bursts left in acquisition.\n [Gotthard2] Number of bursts left in acquisition.\n
Note Note
---- ----
Only in burst auto mode. Only in burst auto mode.
:setter: Not Implemented :setter: Not Implemented
""" """
return self.getNumberOfBurstsLeft() return self.getNumberOfBurstsLeft()
@ -2283,6 +2382,7 @@ class Detector(CppDetectorApi):
""" """
[Gotthard2][Jungfrau] Set filter resistor. Increasing values for increasing " [Gotthard2][Jungfrau] Set filter resistor. Increasing values for increasing "
"resistance. "resistance.
Note Note
---- ----
Advanced user command. Advanced user command.
@ -2300,6 +2400,7 @@ class Detector(CppDetectorApi):
def filtercells(self): def filtercells(self):
""" """
[Jungfrau] Set filter capacitor. [Jungfrau] Set filter capacitor.
Note Note
---- ----
[Jungfrau] Options: 0-12. Default: 0. Advanced user command. Only for chipv1.1. [Jungfrau] Options: 0-12. Default: 0. Advanced user command. Only for chipv1.1.
@ -2314,9 +2415,12 @@ class Detector(CppDetectorApi):
def maxclkphaseshift(self): def maxclkphaseshift(self):
""" """
[Gotthard2][Mythen3] Absolute maximum Phase shift of clocks. [Gotthard2][Mythen3] Absolute maximum Phase shift of clocks.
Note Note
---- ----
:setter: Not Implemented :setter: Not Implemented
Example Example
------- -------
>>> d.maxclkphaseshift >>> d.maxclkphaseshift
@ -2333,6 +2437,7 @@ class Detector(CppDetectorApi):
def timingsource(self): def timingsource(self):
""" """
[Gotthard2] Timing source. Enum: timingSourceType [Gotthard2] Timing source. Enum: timingSourceType
Note Note
----- -----
Options: TIMING_INTERNAL, TIMING_EXTERNAL \n Options: TIMING_INTERNAL, TIMING_EXTERNAL \n
@ -2350,6 +2455,7 @@ class Detector(CppDetectorApi):
def veto(self): def veto(self):
""" """
[Gotthard2] Enable or disable veto data from chip. [Gotthard2] Enable or disable veto data from chip.
Note Note
---- ----
Default is 0. Default is 0.
@ -2375,6 +2481,7 @@ class Detector(CppDetectorApi):
@element @element
def burstmode(self): def burstmode(self):
"""[Gotthard2] Burst mode of detector. Enum: burstMode """[Gotthard2] Burst mode of detector. Enum: burstMode
Note Note
---- ----
BURST_INTERNAL (default), BURST_EXTERNAL, CONTINUOUS_INTERNAL, CONTINUOUS_EXTERNAL BURST_INTERNAL (default), BURST_EXTERNAL, CONTINUOUS_INTERNAL, CONTINUOUS_EXTERNAL
@ -2389,8 +2496,10 @@ class Detector(CppDetectorApi):
def burstperiod(self): def burstperiod(self):
""" """
[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 Note
----- -----
:getter: always returns in seconds. To get in datetime.delta, use getBurstPeriod :getter: always returns in seconds. To get in datetime.delta, use getBurstPeriod
Example Example
@ -2435,10 +2544,13 @@ class Detector(CppDetectorApi):
""" """
[Gotthard2] Set veto reference for 128 channels for chip ichip according to reference file [Gotthard2] Set veto reference for 128 channels for chip ichip according to reference file
and #photons and energy in keV. and #photons and energy in keV.
Note Note
---- ----
Arguments: (chip_index, n_photons, photon_energy, fname) Arguments: (chip_index, n_photons, photon_energy, fname)
:getter: Not Implemented :getter: Not Implemented
Example Example
------- -------
>>> d.vetophoton = (2, 24, 2560, '/tmp/bla.txt') >>> d.vetophoton = (2, 24, 2560, '/tmp/bla.txt')
@ -2456,6 +2568,7 @@ class Detector(CppDetectorApi):
def vetoref(self): def vetoref(self):
""" """
[Gotthard2] Set veto reference for all 128 channels for all chips. [Gotthard2] Set veto reference for all 128 channels for all chips.
Example Example
---------- ----------
>>> d.vetoref = chip, value >>> d.vetoref = chip, value
@ -2473,6 +2586,7 @@ class Detector(CppDetectorApi):
@element @element
def vetostream(self): def vetostream(self):
"""[Gotthard2] Enabling/ disabling veto interface """[Gotthard2] Enabling/ disabling veto interface
Note Note
---- ----
Default: both off Default: both off
@ -2490,11 +2604,13 @@ 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
---- ----
Options: Options:
(vetoAlgorithm): ALG_HITS (default), ALG_RAW (vetoAlgorithm): ALG_HITS (default), ALG_RAW
(streamingInterface): ETHERNET_10GB, LOW_LATENCY_LINK (streamingInterface): ETHERNET_10GB, LOW_LATENCY_LINK
Example Example
---------- ----------
>>> d.vetoalg = defs.ALG_HITS, defs.ETHERNET_10GB >>> d.vetoalg = defs.ALG_HITS, defs.ETHERNET_10GB
@ -2704,6 +2820,7 @@ class Detector(CppDetectorApi):
@element @element
def dbitpipeline(self): def dbitpipeline(self):
"""[Ctb][Gotthard2] Pipeline of the clock for latching digital bits. """[Ctb][Gotthard2] Pipeline of the clock for latching digital bits.
Note Note
---- ----
[CTB] Options: 0 - 255 [CTB] Options: 0 - 255
@ -2719,8 +2836,10 @@ class Detector(CppDetectorApi):
@element @element
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 Note
----- -----
:setter: Not Implemented :setter: Not Implemented
""" """
return self.getMaxDBITPhaseShift() return self.getMaxDBITPhaseShift()
@ -2764,8 +2883,10 @@ class Detector(CppDetectorApi):
@element @element
def maxadcphaseshift(self): def maxadcphaseshift(self):
"""[Jungfrau][CTB][Moench] Absolute maximum Phase shift of ADC clock. """[Jungfrau][CTB][Moench] Absolute maximum Phase shift of ADC clock.
Note Note
----- -----
:setter: Not Implemented :setter: Not Implemented
""" """
return self.getMaxADCPhaseShift() return self.getMaxADCPhaseShift()
@ -2814,8 +2935,10 @@ class Detector(CppDetectorApi):
def syncclk(self): def syncclk(self):
""" """
[Ctb][Moench] Sync clock in MHz. [Ctb][Moench] Sync clock in MHz.
Note Note
----- -----
:setter: Not implemented :setter: Not implemented
""" """
return self.getSYNCClock() return self.getSYNCClock()
@ -2823,9 +2946,12 @@ class Detector(CppDetectorApi):
@property @property
def pattern(self): def pattern(self):
"""[Mythen3][Moench][Ctb] Loads ASCII pattern file directly to server (instead of executing line by line). """[Mythen3][Moench][Ctb] Loads ASCII pattern file directly to server (instead of executing line by line).
Note Note
---- ----
:getter: Not Implemented :getter: Not Implemented
Example Example
--------- ---------
>>> d.pattern = '/tmp/pat.txt' >>> d.pattern = '/tmp/pat.txt'
@ -3146,6 +3272,7 @@ class Detector(CppDetectorApi):
@element @element
def v_io(self): def v_io(self):
"""[Ctb] Voltage supply io in mV. Minimum 1200 mV. """[Ctb] Voltage supply io in mV. Minimum 1200 mV.
Note Note
---- ----
Must be the first power regulator to be set after fpga reset (on-board detector server start up). Must be the first power regulator to be set after fpga reset (on-board detector server start up).
@ -3176,6 +3303,7 @@ class Detector(CppDetectorApi):
Note Note
----- -----
:setter: Not implemented :setter: Not implemented
""" """
return self.getMeasuredCurrent(dacIndex.I_POWER_A) return self.getMeasuredCurrent(dacIndex.I_POWER_A)
@ -3187,6 +3315,7 @@ class Detector(CppDetectorApi):
Note Note
----- -----
:setter: Not implemented :setter: Not implemented
""" """
return self.getMeasuredCurrent(dacIndex.I_POWER_B) return self.getMeasuredCurrent(dacIndex.I_POWER_B)
@ -3198,6 +3327,7 @@ class Detector(CppDetectorApi):
Note Note
----- -----
:setter: Not implemented :setter: Not implemented
""" """
return self.getMeasuredCurrent(dacIndex.I_POWER_C) return self.getMeasuredCurrent(dacIndex.I_POWER_C)
@ -3209,6 +3339,7 @@ class Detector(CppDetectorApi):
Note Note
----- -----
:setter: Not implemented :setter: Not implemented
""" """
return self.getMeasuredCurrent(dacIndex.I_POWER_D) return self.getMeasuredCurrent(dacIndex.I_POWER_D)
@ -3220,6 +3351,7 @@ class Detector(CppDetectorApi):
Note Note
----- -----
:setter: Not implemented :setter: Not implemented
""" """
return self.getMeasuredCurrent(dacIndex.I_POWER_IO) return self.getMeasuredCurrent(dacIndex.I_POWER_IO)
@ -3229,6 +3361,7 @@ class Detector(CppDetectorApi):
def clkdiv(self): def clkdiv(self):
""" """
[Gotthard2][Mythen3] Clock Divider of all clocks. Must be greater than 1. [Gotthard2][Mythen3] Clock Divider of all clocks. Must be greater than 1.
Example Example
------- -------
>>> d.clkdiv[0] = 20 >>> d.clkdiv[0] = 20
@ -3250,10 +3383,13 @@ class Detector(CppDetectorApi):
@property @property
def exptimel(self): def exptimel(self):
"""[Gotthard] Exposure time left for current frame. """[Gotthard] Exposure time left for current frame.
Note Note
----- -----
:getter: always returns in seconds. To get in datetime.delta, use getExptimeLeft :getter: always returns in seconds. To get in datetime.delta, use getExptimeLeft
:setter: Not Implemented :setter: Not Implemented
Example Example
----------- -----------
>>> d.exptimel >>> d.exptimel
@ -3284,9 +3420,12 @@ class Detector(CppDetectorApi):
def clkfreq(self): def clkfreq(self):
""" """
[Gotthard2][Mythen3] Frequency of clock in Hz. [Gotthard2][Mythen3] Frequency of clock in Hz.
Note Note
----- -----
:setter: Not implemented. Use clkdiv to set frequency :setter: Not implemented. Use clkdiv to set frequency
Example Example
------- -------
>>> d.clkfreq[0] >>> d.clkfreq[0]
@ -3310,6 +3449,7 @@ class Detector(CppDetectorApi):
def initialchecks(self): def initialchecks(self):
""" """
Enable or disable intial compatibility and other checks at detector start up. Enable or disable intial compatibility and other checks at detector start up.
Note Note
---- ----
It is enabled by default. Must come before 'hostname' command to take effect. \n It is enabled by default. Must come before 'hostname' command to take effect. \n

12
slsDetectorSoftware/src/CmdProxy.h
View File

@ -726,6 +726,8 @@ class CmdProxy {
/* Jungfrau Specific */ /* Jungfrau Specific */
{"storagecells", "extrastoragecells"}, {"storagecells", "extrastoragecells"},
{"auto_comp_disable", "autocompdisable"},
{"comp_disable_time", "compdisabletime"},
/* Gotthard Specific */ /* Gotthard Specific */
/* Gotthard2 Specific */ /* Gotthard2 Specific */
@ -944,8 +946,8 @@ class CmdProxy {
{"temp_threshold", &CmdProxy::temp_threshold}, {"temp_threshold", &CmdProxy::temp_threshold},
{"temp_control", &CmdProxy::temp_control}, {"temp_control", &CmdProxy::temp_control},
{"temp_event", &CmdProxy::TemperatureEvent}, {"temp_event", &CmdProxy::TemperatureEvent},
{"auto_comp_disable", &CmdProxy::auto_comp_disable}, {"autocompdisable", &CmdProxy::autocompdisable},
{"comp_disable_time", &CmdProxy::comp_disable_time}, {"compdisabletime", &CmdProxy::compdisabletime},
{"extrastoragecells", &CmdProxy::extrastoragecells}, {"extrastoragecells", &CmdProxy::extrastoragecells},
{"storagecell_start", &CmdProxy::storagecell_start}, {"storagecell_start", &CmdProxy::storagecell_start},
{"storagecell_delay", &CmdProxy::storagecell_delay}, {"storagecell_delay", &CmdProxy::storagecell_delay},
@ -1907,18 +1909,18 @@ class CmdProxy {
"cleared."); "cleared.");
INTEGER_COMMAND_VEC_ID( INTEGER_COMMAND_VEC_ID(
auto_comp_disable, getAutoComparatorDisable, setAutoComparatorDisable, autocompdisable, getAutoComparatorDisable, setAutoComparatorDisable,
StringTo<int>, StringTo<int>,
"[0, 1]\n\t[Jungfrau] Auto comparator disable mode. By default, the " "[0, 1]\n\t[Jungfrau] Auto comparator disable mode. By default, the "
"on-chip gain switching is active during the entire exposure.This mode " "on-chip gain switching is active during the entire exposure.This mode "
"disables the on - chip gain switching comparator automatically after " "disables the on - chip gain switching comparator automatically after "
"93.75% (only for chipv1.0) of exposure time (only for longer than " "93.75% (only for chipv1.0) of exposure time (only for longer than "
"100us). It is possible to set the duration for chipv1.1 using " "100us). It is possible to set the duration for chipv1.1 using "
"comp_disable_time command.\n\tDefault is 0 or this mode " "compdisabletime command.\n\tDefault is 0 or this mode "
"disabled(comparator enabled throughout). 1 enables mode. 0 disables " "disabled(comparator enabled throughout). 1 enables mode. 0 disables "
"mode. "); "mode. ");
TIME_COMMAND(comp_disable_time, getComparatorDisableTime, TIME_COMMAND(compdisabletime, getComparatorDisableTime,
setComparatorDisableTime, setComparatorDisableTime,
"[duration] [(optional unit) ns|us|ms|s]\n\t[Jungfrau] Time " "[duration] [(optional unit) ns|us|ms|s]\n\t[Jungfrau] Time "
"before end of exposure when comparator is disabled. It is " "before end of exposure when comparator is disabled. It is "

36
slsDetectorSoftware/tests/test-CmdProxy-jungfrau.cpp
View File

@ -255,7 +255,7 @@ TEST_CASE("temp_event", "[.cmd]") {
} }
} }
TEST_CASE("auto_comp_disable", "[.cmd]") { TEST_CASE("autocompdisable", "[.cmd]") {
Detector det; Detector det;
CmdProxy proxy(&det); CmdProxy proxy(&det);
auto det_type = det.getDetectorType().squash(); auto det_type = det.getDetectorType().squash();
@ -263,29 +263,29 @@ TEST_CASE("auto_comp_disable", "[.cmd]") {
auto prev_val = det.getAutoComparatorDisable(); auto prev_val = det.getAutoComparatorDisable();
{ {
std::ostringstream oss; std::ostringstream oss;
proxy.Call("auto_comp_disable", {"0"}, -1, PUT, oss); proxy.Call("autocompdisable", {"0"}, -1, PUT, oss);
REQUIRE(oss.str() == "auto_comp_disable 0\n"); REQUIRE(oss.str() == "autocompdisable 0\n");
} }
{ {
std::ostringstream oss; std::ostringstream oss;
proxy.Call("auto_comp_disable", {"1"}, -1, PUT, oss); proxy.Call("autocompdisable", {"1"}, -1, PUT, oss);
REQUIRE(oss.str() == "auto_comp_disable 1\n"); REQUIRE(oss.str() == "autocompdisable 1\n");
} }
{ {
std::ostringstream oss; std::ostringstream oss;
proxy.Call("auto_comp_disable", {}, -1, GET, oss); proxy.Call("autocompdisable", {}, -1, GET, oss);
REQUIRE(oss.str() == "auto_comp_disable 1\n"); REQUIRE(oss.str() == "autocompdisable 1\n");
} }
for (int i = 0; i != det.size(); ++i) { for (int i = 0; i != det.size(); ++i) {
det.setAutoComparatorDisable(prev_val[i], {i}); det.setAutoComparatorDisable(prev_val[i], {i});
} }
} else { } else {
REQUIRE_THROWS(proxy.Call("auto_comp_disable", {}, -1, GET)); REQUIRE_THROWS(proxy.Call("autocompdisable", {}, -1, GET));
REQUIRE_THROWS(proxy.Call("auto_comp_disable", {"0"}, -1, PUT)); REQUIRE_THROWS(proxy.Call("autocompdisable", {"0"}, -1, PUT));
} }
} }
TEST_CASE("comp_disable_time", "[.cmd]") { TEST_CASE("compdisabletime", "[.cmd]") {
Detector det; Detector det;
CmdProxy proxy(&det); CmdProxy proxy(&det);
auto det_type = det.getDetectorType().squash(); auto det_type = det.getDetectorType().squash();
@ -294,25 +294,25 @@ TEST_CASE("comp_disable_time", "[.cmd]") {
auto prev_val = det.getComparatorDisableTime(); auto prev_val = det.getComparatorDisableTime();
{ {
std::ostringstream oss; std::ostringstream oss;
proxy.Call("comp_disable_time", {"125ns"}, -1, PUT, oss); proxy.Call("compdisabletime", {"125ns"}, -1, PUT, oss);
REQUIRE(oss.str() == "comp_disable_time 125ns\n"); REQUIRE(oss.str() == "compdisabletime 125ns\n");
} }
{ {
std::ostringstream oss; std::ostringstream oss;
proxy.Call("comp_disable_time", {}, -1, GET, oss); proxy.Call("compdisabletime", {}, -1, GET, oss);
REQUIRE(oss.str() == "comp_disable_time 125ns\n"); REQUIRE(oss.str() == "compdisabletime 125ns\n");
} }
{ {
std::ostringstream oss; std::ostringstream oss;
proxy.Call("comp_disable_time", {"0"}, -1, PUT, oss); proxy.Call("compdisabletime", {"0"}, -1, PUT, oss);
REQUIRE(oss.str() == "comp_disable_time 0\n"); REQUIRE(oss.str() == "compdisabletime 0\n");
} }
for (int i = 0; i != det.size(); ++i) { for (int i = 0; i != det.size(); ++i) {
det.setComparatorDisableTime(prev_val[i], {i}); det.setComparatorDisableTime(prev_val[i], {i});
} }
} else { } else {
REQUIRE_THROWS(proxy.Call("comp_disable_time", {}, -1, GET)); REQUIRE_THROWS(proxy.Call("compdisabletime", {}, -1, GET));
REQUIRE_THROWS(proxy.Call("comp_disable_time", {"0"}, -1, PUT)); REQUIRE_THROWS(proxy.Call("compdisabletime", {"0"}, -1, PUT));
} }
} }