Command line to Python¶
If you are already familiar with the command line interface to the slsDetectorSoftware here is a quick reference translating to Python commands
Note
Commands labeled Mythen only or Gotthard only are currently not implemented in the Python class. If you need this functionallity please contact the SLS Detector Group
Commands¶
| Command | Python | Implementation | Tests |
|---|---|---|---|
| sls_detector_acquire | Detector.acq() |
OK | OK |
| test | Deprecated/Internal | - | - |
| help | help(Detector.acq) | - | - |
| exitserver | Deprecated/Internal | - | - |
| exitreceiver | Deprecated/Internal | - | - |
| flippeddatay | Detector.flipped_data_y |
OK | - |
| digitest | Deprecated/Internal | - | - |
| bustest | Deprecated/Internal | - | - |
| digibittest | Which detector? | - | - |
| reg | Detector.register |
OK | - |
| adcreg | DetectorApi.writeAdcRegister() |
OK | - |
| setbit | DetectorApi.setBitInRegister() |
OK | - |
| clearbit | DetectorApi.clearBitInRegister() |
OK | - |
| getbit | Not implemented | - | - |
| r_compression | Not implemented in receiver | - | - |
| acquire | Detector.acq() |
OK | - |
| busy | Detector.busy |
OK | Partial |
| status | Detector.status |
OK (read only) | - |
| status start | Detector.start_detector() |
OK | - |
| status stop | Detector.stop_detector() |
OK | - |
| data | Deprecated/Internal | - | - |
| frame | Deprecated/Internal | - | - |
| readctr | Gotthard only | - | - |
| resetctr | Gotthard only | - | - |
| resmat | Eiger.eiger_matrix_reset |
OK | OK |
| free | Detector.free_shared_memory() |
OK | - |
| hostname | Detector.hostname |
OK | OK |
| add | Not implemented | - | - |
| replace | Not implemented | - | - |
| user | Not implemented | - | - |
| master | Not implemented | - | - |
| sync | Which detector? | - | - |
| online | Detector.online |
OK | - |
| checkonline | Not implemented | - | - |
| activate | Eiger.active |
- | - |
| nmod | Detector.n_modules |
OK | - |
| maxmod | Deprecated/Internal | - | - |
| dr | Detector.dynamic_range |
OK | OK |
| roi | Gotthard only | - | - |
| detsizechan | Detector.image_size |
OK | - |
| roimask | Not implemented | - | - |
| flippeddatax | Detector.flipped_data_x |
OK | - |
| tengiga | Eiger.tengiga |
OK | - |
| gappixels | Eiger.add_gappixels |
OK | - |
| flags | Detector.flags |
OK | - |
| extsig | Mythen and Gotthard only | - | - |
| programfpga | Jungfrau only | - | - |
| resetfpga | Jungfrau only | - | - |
| powerchip | Jungfrau.powerchip |
- | - |
| led | Not implemented | - | - |
| auto_comp_disable | Jungfrau only | - | - |
| pulse | Used in Eiger.pulse_all_pixels() |
OK | - |
| pulsenmove | Used in Eiger.pulse_all_pixels() |
OK | - |
| pulsechip | Eiger.pulse_chip() |
OK | - |
| checkdetversion | Detector.api_compatibility |
- | - |
| checkrecversion | Detector.api_compatibility |
- | - |
| moduleversion | Mythen only | - | - |
| detectornumber | Detector.detector_number |
OK | - |
| modulenumber | Mythen only | - | - |
| detectorversion | Detector.firmware_version |
OK | OK |
| softwareversion | Detector.server_version |
- | - |
| thisversion | Detector.client_version |
Reads date | - |
| receiverversion | Detector.receiver_version |
Reads date | - |
| timing | Detector.timing_mode |
OK | - |
| exptime | Detector.exposure_time |
OK | OK |
| subexptime | Detector.sub_exposure_time |
OK | OK |
| period | Detector.period |
OK | OK |
| subdeadtime | Eiger.sub_deadtime |
OK | OK |
| delay | Mythen and Gotthard only | - | - |
| gates | Mythen and Gotthard only | - | - |
| frames | Detector.n_frames |
OK | OK |
| cycles | Detector.n_cycles |
OK | - |
| probes | Mythen only | - | - |
| measurements | Detector.n_measurements |
OK | - |
| samples | Chip test board only (new?) | - | - |
| storagecells | Jungfrau only | - | - |
| storagecell_start | Jungfrau only | - | - |
| exptimel | Mythen and Gotthard only | - | - |
| periodl | Mythen and Gotthard only | - | - |
| delayl | Mythen and Gotthard only | - | - |
| gatesl | Mythen and Gotthard only | - | - |
| framesl | Mythen and Gotthard only | - | - |
| cyclesl | Mythen and Gotthard only | - | - |
| probesl | Mythen and Gotthard only | - | - |
| now | Not implemented | - | - |
| timestamp | Mythen only | - | - |
| nframes | Not implemented | - | - |
| measuredperiod | Detector.measured_period |
OK | - |
| measuredsubperiod | Detector.measured_subperiod |
- | - |
| clkdivider | Detector.readout_clock |
OK | OK |
| setlength | Mythen only | - | - |
| waitstates | Mythen only | - | - |
| totdivider | Mythen only | - | - |
| totdutycycle | Mythen only | - | - |
| phasestep | Gotthard only | - | - |
| oversampling | New chip test board only | - | - |
| adcclk | New chip test board only | - | - |
| adcphase | New chip test board only | - | - |
| adcpipeline | New chip test board only | - | - |
| dbitclk | New chip test board only | - | - |
| dbitphase | New chip test board only | - | - |
| dbitpipeline | New chip test board only | - | - |
| config | Detector.load_config() |
OK | - |
| rx_printconfig | Not implemented | - | - |
| parameters | Detector.load_parameters() |
OK | - |
| setup | Not implemented | - | - |
| flatfield | Not implemented | - | - |
| ffdir | Not implemented | - | - |
| ratecorr | Detector.rate_correction |
OK | - |
| badchannels | Not implemented | - | - |
| angconv | Mythen only | - | - |
| globaloff | Not implemented | - | - |
| fineoff | Not implemented | - | - |
| binsize | Not implemented | - | - |
| angdir | Not implemented | - | - |
| moveflag | Not implemented | - | - |
| samplex | Not implemented | - | - |
| sampley | Not implemented | - | - |
| threaded | Detector.threaded |
OK | - |
| darkimage | Not implemented | - | - |
| gainimage | Not implemented | - | - |
| settingsdir | Detector.settings_path |
OK | - |
| trimdir | Not implemented | - | - |
| caldir | Not implemented | - | - |
| trimen | Detector.trimmed_energies |
OK | - |
| settings | Detector.settings |
OK | - |
| threshold | Detector.threshold |
OK | - |
| thresholdnotb | Not implemented | - | - |
| trimbits | Detector.load_trimbits() |
OK | - |
| trim | Not implemented | - | - |
| trimval | Detector.trimbits |
OK | OK |
| pedestal | Not implemented | - | - |
| vthreshold | Detector.vthreshold |
OK | - |
| vcalibration | Not implemented | - | - |
| vtrimbit | Not implemented | - | - |
| vpreamp | Not implemented | - | - |
| vshaper1 | Not implemented | - | - |
| vshaper2 | Not implemented | - | - |
| vhighvoltage | Detector.high_voltage |
OK | - |
| vapower | Not implemented | - | - |
| vddpower | Not implemented | - | - |
| vshpower | Not implemented | - | - |
| viopower | Not implemented | - | - |
| vref_ds | Jungfrau.dacs.vref_ds |
OK | - |
| vcascn_pb | Not implemented | - | - |
| vcascp_pb | Not implemented | - | - |
| vout_cm | Not implemented | - | - |
| vcasc_out | Not implemented | - | - |
| vin_cm | Not implemented | - | - |
| vref_comp | Not implemented | - | - |
| ib_test_c | Not implemented | - | - |
| dac0 | Not implemented | - | - |
| dac1 | Not implemented | - | - |
| dac2 | Not implemented | - | - |
| dac3 | Not implemented | - | - |
| dac4 | Not implemented | - | - |
| dac5 | Not implemented | - | - |
| dac6 | Not implemented | - | - |
| dac7 | Not implemented | - | - |
| vsvp | Eiger.dacs.vsvp |
OK | - |
| vsvn | Eiger.dacs.vsvn |
OK | - |
| vtr | Eiger.dacs.vtr |
OK | - |
| vrf | Eiger.dacs.vrf |
OK | - |
| vrs | Eiger.dacs.vrs |
OK | - |
| vtgstv | Eiger.dacs.vtgstv |
OK | - |
| vcmp_ll | Eiger.dacs.vcmp_ll |
OK | - |
| vcmp_ll | Eiger.dacs.vcmp_ll |
OK | - |
| vcall | Eiger.dacs.vcall |
OK | - |
| vcmp_rl | Eiger.dacs.vcmp_rl |
OK | - |
| vcmp_rr | Eiger.dacs.vcmp_rr |
OK | - |
| rxb_rb | Eiger.dacs.rxb_rb |
OK | - |
| rxb_lb | Eiger.dacs.rxb_lb |
OK | - |
| vcp | Eiger.dacs.vcp |
OK | - |
| vcn | Eiger.dacs.vcn |
OK | - |
| vis | Eiger.dacs.vis |
OK | - |
| iodelay | Eiger.dacs.iodelay |
OK | - |
| dac | Not implemented | - | - |
| adcvpp | Not implemented | - | - |
| v_a | Not implemented | - | - |
| v_b | Not implemented | - | - |
| v_c | Not implemented | - | - |
| v_d | Not implemented | - | - |
| v_io | Not implemented | - | - |
| v_chip | Not implemented | - | - |
| v_limit | Not implemented | - | - |
| vIpre | Not implemented | - | - |
| VcdSh | Not implemented | - | - |
| Vth1 | Not implemented | - | - |
| Vth2 | Not implemented | - | - |
| Vth3 | Not implemented | - | - |
| VPL | Not implemented | - | - |
| Vtrim | Not implemented | - | - |
| vIbias | Not implemented | - | - |
| vIinSh | Not implemented | - | - |
| cas | Not implemented | - | - |
| casSh | Not implemented | - | - |
| vIbiasSh | Not implemented | - | - |
| vIcin | Not implemented | - | - |
| vIpreOut | Not implemented | - | - |
| temp_adc | Not implemented | - | - |
| temp_fpga | Detector.temp.fpga |
OK | - |
| temp_fpgaext | Detector.temp.fpgaext |
OK | - |
| temp_10ge | Detector.temp.t10ge |
OK | - |
| temp_dcdc | Detector.temp.dcdc |
OK | - |
| temp_sodl | Detector.temp.sodl |
OK | - |
| temp_sodr | Detector.temp.sodr |
OK | - |
| adc | Not implemented | - | - |
| temp_fpgafl | Detector.temp.fpgafl |
OK | - |
| temp_fpgafr | Detector.temp.fpgafr |
OK | - |
| i_a | Not implemented | - | - |
| i_b | Not implemented | - | - |
| i_c | Not implemented | - | - |
| i_d | Not implemented | - | - |
| i_io | Not implemented | - | - |
| vm_a | Not implemented | - | - |
| vm_b | Not implemented | - | - |
| vm_c | Not implemented | - | - |
| vm_d | Not implemented | - | - |
| vm_io | Not implemented | - | - |
| temp_threshold | Jungfrau.temperature_threshold |
- | - |
| temp_control | Jungfrau.temperature_control |
- | - |
| temp_event | Jungfrau.temperature_event |
- | - |
| outdir | Detector.file_path |
OK | OK |
| fname | Detector.file_name |
OK | OK |
| index | Detector.file_index |
OK | OK |
| enablefwrite | Detector.file_write |
OK | OK |
| overwrite | Detector.file_overwrite |
OK | - |
| currentfname | Not implemented | - | - |
| fileformat | Detector.file_format |
OK | - |
| positions | Deprecated/Internal | - | - |
| startscript | Deprecated/Internal | - | - |
| startscriptpar | Deprecated/Internal | - | - |
| stopscript | Deprecated/Internal | - | - |
| stopscriptpar | Deprecated/Internal | - | - |
| scriptbefore | Deprecated/Internal | - | - |
| scriptbeforepar | Deprecated/Internal | - | - |
| scriptafter | Deprecated/Internal | - | - |
| scriptafterpar | Deprecated/Internal | - | - |
| headerafter | Deprecated/Internal | - | - |
| headerbefore | Deprecated/Internal | - | - |
| headerbeforepar | Deprecated/Internal | - | - |
| headerafterpar | Deprecated/Internal | - | - |
| encallog | Deprecated/Internal | - | - |
| angcallog | Deprecated/Internal | - | - |
| scan0script | Deprecated/Internal | - | - |
| scan0par | Deprecated/Internal | - | - |
| scan0prec | Deprecated/Internal | - | - |
| scan0steps | Deprecated/Internal | - | - |
| scan0range | Deprecated/Internal | - | - |
| scan1script | Deprecated/Internal | - | - |
| scan1par | Deprecated/Internal | - | - |
| scan1prec | Deprecated/Internal | - | - |
| scan1steps | Deprecated/Internal | - | - |
| scan1range | Deprecated/Internal | - | - |
| rx_hostname | Detector.rx_hostname |
OK | - |
| rx_udpip | Detector.rx_udpip |
OK | - |
| rx_udpmac | Detector.rx_udpmac |
OK | - |
| rx_udpport | Detector.rx_udpport |
OK | - |
| rx_udpport2 | Detector.rx_udpport |
OK | - |
| rx_udpsocksize | Detector.rx_udpsocksize |
OK | - |
| rx_realudpsocksize | Detector.rx_realudpsocksize |
OK | |
| detectormac | Detector.detector_mac |
OK | - |
| detectorip | Detector.detector_ip |
OK | - |
| txndelay_left | Eiger.delay.left |
OK | - |
| txndelay_right | Eiger.delay.right |
OK | - |
| txndelay_frame | Eiger.delay.frame |
OK | - |
| flowcontrol_10g | Eiger.flowcontrol_10g |
OK | - |
| zmqport | Detector.client_zmqport |
Read | - |
| rx_zmqport | Detector.rx_zmqport |
Read | - |
| rx_datastream | Detector.rx_datastream |
OK | - |
| zmqip | Detector.client_zmqip |
OK | - |
| rx_zmqip | Detector.rx_zmqip |
Read | - |
| rx_jsonaddheader | Detector.rx_jsonaddheader |
OK | - |
| configuremac | Detector.config_network |
OK | - |
| rx_tcpport | Detector.rx_tcpport |
||
| port | Not implemented | - | - |
| stopport | Not implemented | - | - |
| lock | Detector.lock |
OK | - |
| lastclient | Detector.last_client_ip |
OK | - |
| receiver start | Detector.start_receiver() |
OK | - |
| receiver stop | Detector.stop_receiver() |
- | - |
| r_online | Detector.receiver_online |
OK | - |
| r_checkonline | Not implemented | - | - |
| framescaught | Detector.frames_caught |
OK | - |
| resetframescaught | Detector.reset_frames_caught() |
OK | - |
| frameindex | Detector.receiver_frame_index |
OK | - |
| r_lock | Detector.lock_receiver |
OK | - |
| r_lastclient | Detector.receiver_last_client_ip |
OK | - |
| r_readfreq | Not implemented | - | - |
| rx_fifodepth | |||
| r_silent | Not implemented | - | - |
| r_framesperfile | Detector.n_frames_per_file |
OK | - |
| r_discardpolicy | Detector.frame_discard_policy |
OK | - |
| r_padding | Detector.file_padding |
OK | - |
| adcinvert | Chip test board only | - | - |
| adcdisable | Chip test board only | - | - |
| pattern | Chip test board only | - | - |
| patword | Chip test board only | - | - |
| patioctrl | Chip test board only | - | - |
| patclkctrl | Chip test board only | - | - |
| patlimits | Chip test board only | - | - |
| patloop0 | Chip test board only | - | - |
| patnloop0 | Chip test board only | - | - |
| patwait0 | Chip test board only | - | - |
| patwaittime0 | Chip test board only | - | - |
| patloop1 | Chip test board only | - | - |
| patnloop1 | Chip test board only | - | - |
| patwait1 | Chip test board only | - | - |
| patwaittime1 | Chip test board only | - | - |
| patloop2 | Chip test board only | - | - |
| patnloop2 | Chip test board only | - | - |
| patwait2 | Chip test board only | - | - |
| patwaittime2 | Chip test board only | - | - |
| dut_clk | Chip test board only | - | - |