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

command line doc. done

Browse Source
This commit is contained in:
Dhanya Maliakal
2017-08-17 17:08:55 +02:00
parent e2af1de83f
commit e0c29190a2
17 changed files with 345 additions and 290 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
manual/slsDetectorClientDocs/latex/actions.tex
View File

@ -2,77 +2,77 @@ Commands to define scripts to be executed during the acquisition flow
\begin{DoxyItemize}
\item {\bfseries positions \mbox{[}n \mbox{[}p0..pn-\/1\mbox{]}\mbox{]}} sets/gets number of angular position and positions to be acquired.
\item {\bfseries positions \mbox{[}n \mbox{[}p0..pn-\/1\mbox{]}\mbox{]}} sets/gets number of angular position and positions to be acquired.. {\ttfamily Returns} {\ttfamily }(int int..) n \mbox{[}p0..pn-\/1\mbox{]}
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries startscript \mbox{[}s\mbox{]}} sets/gets the script to be executed at the beginning of the acquisition. {\ttfamily none} unsets.
\item {\bfseries startscript \mbox{[}s\mbox{]}} sets/gets the script to be executed at the beginning of the acquisition. {\ttfamily none} unsets. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries startscriptpar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the startscript
\item {\bfseries startscriptpar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the startscript. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries stopscript \mbox{[}s\mbox{]}} sets/gets the script to be executed at the end of the acquisition. {\ttfamily none} unsets.
\item {\bfseries stopscript \mbox{[}s\mbox{]}} sets/gets the script to be executed at the end of the acquisition. {\ttfamily none} unsets. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries stopscriptpar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the stopscript
\item {\bfseries stopscriptpar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the stopscript. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scriptbefore \mbox{[}s\mbox{]}} sets/gets the script to be executed before starting the detector every time in the acquisition. {\ttfamily none} unsets.
\item {\bfseries scriptbefore \mbox{[}s\mbox{]}} sets/gets the script to be executed before starting the detector every time in the acquisition. {\ttfamily none} unsets. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scriptbeforepar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the scriptbefore
\item {\bfseries scriptbeforepar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the scriptbefore. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scriptafter \mbox{[}s\mbox{]}} sets/gets the script to be executed after the detector has finished every time in the acquisition. {\ttfamily none} unsets.
\item {\bfseries scriptafter \mbox{[}s\mbox{]}} sets/gets the script to be executed after the detector has finished every time in the acquisition. {\ttfamily none} unsets. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scriptafterpar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the scriptafter
\item {\bfseries scriptafterpar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the scriptafter. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries headerafter \mbox{[}s\mbox{]}} sets/gets the script to be executed for logging the detector parameters. {\ttfamily none} unsets.
\item {\bfseries headerafter \mbox{[}s\mbox{]}} sets/gets the script to be executed for logging the detector parameters. {\ttfamily none} unsets. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries headerbefore \mbox{[}s\mbox{]}} sets/gets the script to be executed for logging the detector parameters. {\ttfamily none} unsets.
\item {\bfseries headerbefore \mbox{[}s\mbox{]}} sets/gets the script to be executed for logging the detector parameters. {\ttfamily none} unsets. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries headerbeforepar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the headerbefore script
\item {\bfseries headerbeforepar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the headerbefore script. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries headerafterpar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the headerafter script
\item {\bfseries headerafterpar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the headerafter script. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries enacallog \mbox{[}i\mbox{]}} enables/disables logging of the parameters necessary for the energy calibration. 1 sets, 0 unsets.
\item {\bfseries enacallog \mbox{[}i\mbox{]}} enables/disables logging of the parameters necessary for the energy calibration. 1 sets, 0 unsets. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries angcallog \mbox{[}i\mbox{]}} enables/disables logging of the parameters necessary for the angular calibration. 1 sets, 0 unsets.
\item {\bfseries angcallog \mbox{[}i\mbox{]}} enables/disables logging of the parameters necessary for the angular calibration. 1 sets, 0 unsets. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}

122
manual/slsDetectorClientDocs/latex/config.tex
View File

@ -4,11 +4,8 @@ Commands to configure the detector. these commands are often left to the configu
\item \hyperlink{config_configstatus}{Status}: commands to configure detector status
\item \hyperlink{config_configsize}{Data Size}: commands to configure detector data size
\item \hyperlink{config_configflags}{Flags}: commands to configure detector flags
\item \hyperlink{config_configfpga}{FPGA}: commands to configure FPGA of the detector
\item \hyperlink{config_configchip}{Chip}: commands to configure chip of the detector
\item \hyperlink{config_configversions}{Versions}: commands to check version of each subsytem
\item \hyperlink{config_configtimers}{Timers}: commands to configure the timers of the detector
\item \hyperlink{config_configrotimers}{RO Timers}: commands to configure the read only timers of the detector
\item \hyperlink{config_configspeed}{Speed}: commands to configure speed of detector
\item \hyperlink{config_configsettings}{Detector Parameters}: commands to configure/retrieve configuration of detector
\end{DoxyItemize}\hypertarget{config_configstructure}{}\subsection{Data Structure}\label{config_configstructure}
@ -126,8 +123,7 @@ commands to configure detector flags
\begin{DoxyItemize}
\item {\bfseries extsig:\mbox{[}i\mbox{]} \mbox{[}flag\mbox{]}} sets/gets the mode of the external signal i. Options: {\ttfamily off}, {\ttfamily gate\_\-in\_\-active\_\-high}, {\ttfamily gate\_\-in\_\-active\_\-low}, {\ttfamily trigger\_\-in\_\-rising\_\-edge}, {\ttfamily trigger\_\-in\_\-falling\_\-edge}, {\ttfamily ro\_\-trigger\_\-in\_\-rising\_\-edge}, {\ttfamily ro\_\-trigger\_\-in\_\-falling\_\-edge}, {\ttfamily gate\_\-out\_\-active\_\-high}, {\ttfamily gate\_\-out\_\-active\_\-low}, {\ttfamily trigger\_\-out\_\-rising\_\-edge}, {\ttfamily trigger\_\-out\_\-falling\_\-edge}, {\ttfamily ro\_\-trigger\_\-out\_\-rising\_\-edge}, {\ttfamily ro\_\-trigger\_\-out\_\-falling\_\-edge}. \par
Used in MYTHEN, GOTTHARD, PROPIX only. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}\hypertarget{config_configfpga}{}\subsection{FPGA}\label{config_configfpga}
commands to configure FPGA of the detector
\end{DoxyItemize}
\begin{DoxyItemize}
@ -199,22 +195,6 @@ Commands to check versions of each subsystem
\begin{DoxyItemize}
\item {\bfseries receiverversion} Gets the software version of receiver. Only get! {\ttfamily Returns} {\ttfamily }(long int) in hexadecimal
\end{DoxyItemize}\hypertarget{config_configtimers}{}\subsection{Timers}\label{config_configtimers}
commands to configure the timers of the detector
\begin{DoxyItemize}
\item {\bfseries timing \mbox{[}mode\mbox{]}} sets/gets synchronization mode of the detector. Mode: auto, trigger, ro\_\-trigger, gating, triggered\_\-gating {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries exptime \mbox{[}i\mbox{]}} sets/gets exposure time in s. {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries subexptime \mbox{[}i\mbox{]}} sets/gets sub exposure time in s. Used in EIGER only in 32 bit mode. {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
@ -228,84 +208,8 @@ commands to configure the timers of the detector
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries gates \mbox{[}i\mbox{]}} sets/gets number of gates. Used in MYTHEN, GOTTHARD only. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries frames \mbox{[}i\mbox{]}} sets/gets number of frames. If {\ttfamily timing} is not {\ttfamily auto}, then it is the number of frames per cycle/trigger. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries cycles \mbox{[}i\mbox{]}} sets/gets number of triggers. Timing mode should be set appropriately. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries probes \mbox{[}i\mbox{]}} sets/gets number of probes to accumulate. When setting, max 3! cycles should be set to 1, frames to the number of pump-\/probe events. Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries measurements \mbox{[}i\mbox{]}} sets/gets number of measurements. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries samples \mbox{[}i\mbox{]}} sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}\hypertarget{config_configrotimers}{}\subsection{RO Timers}\label{config_configrotimers}
commands to configure the read only timers of the detector
\begin{DoxyItemize}
\item {\bfseries exptimel} gets exposure time left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries periodl} gets frame period left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries delayl} gets delay left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries gatesl} gets number of gates left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries framesl} gets number of frames left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries cyclesl} gets number of cylces left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries probesl} gets number of probes left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries now} ??? Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries timestamp} ??? Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries nframes} ??? Only get!
\end{DoxyItemize}\hypertarget{config_configspeed}{}\subsection{Speed}\label{config_configspeed}
commands to configure speed of detector
@ -316,62 +220,62 @@ commands to configure speed of detector
\begin{DoxyItemize}
\item {\bfseries clkdivider \mbox{[}i\mbox{]}} sets/gets length of set/reset signals (in clock cycles). Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(int)
\item {\bfseries setlength \mbox{[}i\mbox{]}} sets/gets length of set/reset signals (in clock cycles). Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries clkdivider \mbox{[}i\mbox{]}} sets/gets waitstates of the bus interface (in clock cycles). Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(int)
\item {\bfseries waitstates \mbox{[}i\mbox{]}} sets/gets waitstates of the bus interface (in clock cycles). Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries clkdivider \mbox{[}i\mbox{]}} sets/gets clock divider in tot mode. Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(int)
\item {\bfseries totdivider \mbox{[}i\mbox{]}} sets/gets clock divider in tot mode. Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries clkdivider \mbox{[}i\mbox{]}} sets/gets duty cycle of the tot clock. Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(int)
\item {\bfseries totdutycycle \mbox{[}i\mbox{]}} sets/gets duty cycle of the tot clock. Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries phasestep \mbox{[}i\mbox{]}} ???. {\ttfamily Returns} {\ttfamily }(int)
\item {\bfseries phasestep \mbox{[}i\mbox{]}} Only put for gotthard. Moves the phase of the ADC clock.{\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries oversampling \mbox{[}i\mbox{]}} ???. {\ttfamily Returns} {\ttfamily }(int)
\item {\bfseries oversampling \mbox{[}i\mbox{]}} Sets/gets the number of adcsamples per clock. For the new chiptestboard.{\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries adcclk \mbox{[}i\mbox{]}} ???. {\ttfamily Returns} {\ttfamily }(int)
\item {\bfseries adcclk \mbox{[}i\mbox{]}} sets/gets the ADC clock frequency in MHz. For the new chiptestboard!{\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries adcphase \mbox{[}i\mbox{]}} ??? Used in MYTHEN, JUNGFRAU only. {\ttfamily Returns} {\ttfamily }(int)
\item {\bfseries adcphase \mbox{[}i\mbox{]}} Sets/gets the ADC clock frequency in MHz. For the new chiptestboard!{\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries adcpipeline \mbox{[}i\mbox{]}} ??? {\ttfamily Returns} {\ttfamily }(int)
\item {\bfseries adcpipeline \mbox{[}i\mbox{]}} Sets/gets the pipeline of the ADC. For the new chiptestbaord!{\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries dbitclk \mbox{[}i\mbox{]}} ??? {\ttfamily Returns} {\ttfamily }(int)
\item {\bfseries dbitclk \mbox{[}i\mbox{]}} Sets/gets the clock frequency of the latching of the digital bits in MHz. For the new chiptestboard!{\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries dbitphase \mbox{[}i\mbox{]}} ??? {\ttfamily Returns} {\ttfamily }(int)
\item {\bfseries dbitphase \mbox{[}i\mbox{]}} Sets/gets the phase of the clock for latching of the digital bits. For the new chiptestboard!?{\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries dbitpipeline \mbox{[}i\mbox{]}} ??? {\ttfamily Returns} {\ttfamily }(int)
\item {\bfseries dbitpipeline \mbox{[}i\mbox{]}} Sets/gets the pipeline of the latching of the digital bits. For the new chiptestbaord!{\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}\hypertarget{config_configsettings}{}\subsection{Detector Parameters}\label{config_configsettings}
commands to configure/retrieve configuration of detector

4
manual/slsDetectorClientDocs/latex/doxygen.sty
View File

@ -24,9 +24,9 @@
\fancyplain{}{\bfseries\thepage}%
}
\rfoot[\fancyplain{}{\bfseries\scriptsize%
Generated on Thu Aug 17 16:49:34 2017 by Doxygen }]{}
Generated on Thu Aug 17 17:08:21 2017 by Doxygen }]{}
\lfoot[]{\fancyplain{}{\bfseries\scriptsize%
Generated on Thu Aug 17 16:49:34 2017 by Doxygen }}
Generated on Thu Aug 17 17:08:21 2017 by Doxygen }}
\cfoot{}
%---------- Internal commands used in this style file ----------------

1
manual/slsDetectorClientDocs/latex/index.tex
View File

@ -34,6 +34,7 @@ The commands are sudivided into different pages depending on their functionaliti
\begin{DoxyItemize}
\item \hyperlink{acquisition}{Acquisition}: commands to start/stop the acquisition and retrieve data
\item \hyperlink{config}{Configuration}: commands to configure the detector
\item \hyperlink{timing}{Timing}: commands to configure the detector timing
\item \hyperlink{data}{Data postprocessing}: commands to process the data -\/ mainly for MYTHEN except for rate corrections.
\item \hyperlink{settings}{Settings}: commands to define detector settings/threshold.
\item \hyperlink{output}{Output}: commands to define output file destination and format

36
manual/slsDetectorClientDocs/latex/network.tex
View File

@ -1,89 +1,89 @@
Commands to setup the network between client, detector and receiver
\begin{DoxyItemize}
\item {\bfseries rx\_\-hostname \mbox{[}s\mbox{]}} sets/gets the receiver hostname or IP address, configures detector mac with all network parameters and updates receiver with acquisition parameters. Normally used for single detectors (Can be multi-\/detector). {\ttfamily none} disables. If used, use as last network command in configuring detector MAC.
\item {\bfseries rx\_\-hostname \mbox{[}s\mbox{]}} sets/gets the receiver hostname or IP address, configures detector mac with all network parameters and updates receiver with acquisition parameters. Normally used for single detectors (Can be multi-\/detector). {\ttfamily none} disables. If used, use as last network command in configuring detector MAC. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries rx\_\-udpip \mbox{[}ip\mbox{]}} sets/gets the ip address of the receiver UDP interface where the data from the detector will be streamed to. Normally used for single detectors (Can be multi-\/detector). Used if different from eth0.
\item {\bfseries rx\_\-udpip \mbox{[}ip\mbox{]}} sets/gets the ip address of the receiver UDP interface where the data from the detector will be streamed to. Normally used for single detectors (Can be multi-\/detector). Used if different from eth0. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries rx\_\-udpmac \mbox{[}mac\mbox{]}} sets/gets the mac address of the receiver UDP interface where the data from the detector will be streamed to. Normally used for single detectors (Can be multi-\/detector).
\item {\bfseries rx\_\-udpmac \mbox{[}mac\mbox{]}} sets/gets the mac address of the receiver UDP interface where the data from the detector will be streamed to. Normally used for single detectors (Can be multi-\/detector). {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries rx\_\-udpport \mbox{[}port\mbox{]}} sets/gets the port of the receiver UDP interface where the data from the detector will be streamed to. Use single-\/detector command.
\item {\bfseries rx\_\-udpport \mbox{[}port\mbox{]}} sets/gets the port of the receiver UDP interface where the data from the detector will be streamed to. Use single-\/detector command. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries rx\_\-udpport2 \mbox{[}port\mbox{]}} sets/gets the second port of the receiver UDP interface where the data from the second half of the detector will be streamed to. Use single-\/detector command. Used for EIGER only.
\item {\bfseries rx\_\-udpport2 \mbox{[}port\mbox{]}} sets/gets the second port of the receiver UDP interface where the data from the second half of the detector will be streamed to. Use single-\/detector command. Used for EIGER only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries detectormac \mbox{[}mac\mbox{]}} sets/gets the mac address of the detector UDP interface from where the detector will stream data. Use single-\/detector command. Normally unused.
\item {\bfseries detectormac \mbox{[}mac\mbox{]}} sets/gets the mac address of the detector UDP interface from where the detector will stream data. Use single-\/detector command. Normally unused. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries detectorip \mbox{[}ip\mbox{]}} sets/gets the ip address of the detector UDP interface from where the detector will stream data. Use single-\/detector command. Keep in same subnet as rx\_\-udpip (if rx\_\-udpip specified).
\item {\bfseries detectorip \mbox{[}ip\mbox{]}} sets/gets the ip address of the detector UDP interface from where the detector will stream data. Use single-\/detector command. Keep in same subnet as rx\_\-udpip (if rx\_\-udpip specified). {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries txndelay\_\-left \mbox{[}delay\mbox{]}} sets/gets the transmission delay of first packet in an image being streamed out from the detector's left UDP port. Use single-\/detector command. Used for EIGER only.
\item {\bfseries txndelay\_\-left \mbox{[}delay\mbox{]}} sets/gets the transmission delay of first packet in an image being streamed out from the detector's left UDP port. Use single-\/detector command. Used for EIGER only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries txndelay\_\-right \mbox{[}delay\mbox{]}} sets/gets the transmission delay of first packet in an image being streamed out from the detector's right UDP port. Use single-\/detector command. Used for EIGER only.
\item {\bfseries txndelay\_\-right \mbox{[}delay\mbox{]}} sets/gets the transmission delay of first packet in an image being streamed out from the detector's right UDP port. Use single-\/detector command. Used for EIGER only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries txndelay\_\-frame \mbox{[}delay\mbox{]}} sets/gets the transmission frame period of entire frame being streamed out from the detector for both ports. Use single-\/detector command. Used for EIGER only.
\item {\bfseries txndelay\_\-frame \mbox{[}delay\mbox{]}} sets/gets the transmission frame period of entire frame being streamed out from the detector for both ports. Use single-\/detector command. Used for EIGER only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries flowcontrol\_\-10g \mbox{[}delay\mbox{]}} Enables/disables 10 GbE flow control. 1 enables, 0 disables. Used for EIGER only.
\item {\bfseries flowcontrol\_\-10g \mbox{[}delay\mbox{]}} Enables/disables 10 GbE flow control. 1 enables, 0 disables. Used for EIGER only. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries zmqport \mbox{[}port\mbox{]}} sets/gets the 0MQ (TCP) port of the receiver from where data is streamed to the client. Use single-\/detector command to set individually or multi-\/detector command to calculate based on {\ttfamily port} for the rest.
\item {\bfseries zmqport \mbox{[}port\mbox{]}} sets/gets the 0MQ (TCP) port of the receiver from where data is streamed to the client. Use single-\/detector command to set individually or multi-\/detector command to calculate based on {\ttfamily port} for the rest. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries configuremac \mbox{[}i\mbox{]}} configures the MAC of the detector with these parameters: detectorip, detectormac, rx\_\-udpip, rx\_\-udpmac, rx\_\-udpport, rx\_\-udpport2 (if applicable). Only put!
\item {\bfseries configuremac \mbox{[}i\mbox{]}} configures the MAC of the detector with these parameters: detectorip, detectormac, rx\_\-udpip, rx\_\-udpmac, rx\_\-udpport, rx\_\-udpport2 (if applicable). This command is already included in {\ttfamily rx\_\-hsotname}. Only put!. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries rx\_\-tcpport \mbox{[}port\mbox{]}} sets/gets the port of the client-\/receiver TCP interface. Use single-\/detector command. Is different for each detector if same {\ttfamily rx\_\-hostname} used. Must be first command to communicate with receiver.
\item {\bfseries rx\_\-tcpport \mbox{[}port\mbox{]}} sets/gets the port of the client-\/receiver TCP interface. Use single-\/detector command. Is different for each detector if same {\ttfamily rx\_\-hostname} used. Must be first command to communicate with receiver. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries port \mbox{[}port\mbox{]}} sets/gets the port of the client-\/detector control server TCP interface. Use single-\/detector command. Default value is 1952 for all detectors. Normally not changed.
\item {\bfseries port \mbox{[}port\mbox{]}} sets/gets the port of the client-\/detector control server TCP interface. Use single-\/detector command. Default value is 1952 for all detectors. Normally not changed. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries stopport \mbox{[}port\mbox{]}} sets/gets the port of the client-\/detector stop server TCP interface. Use single-\/detector command. Default value is 1953 for all detectors. Normally not changed.
\item {\bfseries stopport \mbox{[}port\mbox{]}} sets/gets the port of the client-\/detector stop server TCP interface. Use single-\/detector command. Default value is 1953 for all detectors. Normally not changed. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries lock \mbox{[}i\mbox{]}} Locks/Unlocks the detector to communicate with this client. 1 locks, 0 unlocks.
\item {\bfseries lock \mbox{[}i\mbox{]}} Locks/Unlocks the detector to communicate with this client. 1 locks, 0 unlocks. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries lastclient } Gets the last client communicating with the detector. Cannot put!
\item {\bfseries lastclient } Gets the last client communicating with the detector. Cannot put!. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}

14
manual/slsDetectorClientDocs/latex/output.tex
View File

@ -2,35 +2,35 @@ Commands to setup the file destination and format
\begin{DoxyItemize}
\item {\bfseries outdir \mbox{[}dir\mbox{]}} Sets/gets the file output directory (string)
\item {\bfseries outdir \mbox{[}dir\mbox{]}} Sets/gets the file output directory. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries fname \mbox{[}fn\mbox{]}} Sets/gets the root of the output file name (string)
\item {\bfseries fname \mbox{[}fn\mbox{]}} Sets/gets the root of the output file name {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries index \mbox{[}i\mbox{]}} Sets/gets the current file index (int)
\item {\bfseries index \mbox{[}i\mbox{]}} Sets/gets the current file index. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries enablefwrite \mbox{[}i\mbox{]}} Enables/disables file writing. 1 enables, 0 disables.
\item {\bfseries enablefwrite \mbox{[}i\mbox{]}} Enables/disables file writing. 1 enables, 0 disables. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries overwrite \mbox{[}i\mbox{]}} enables(1) /disables(0) file overwriting
\item {\bfseries overwrite \mbox{[}i\mbox{]}} enables(1) /disables(0) file overwriting. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries currentfname} gets the filename for the data without index and extension
\item {\bfseries currentfname} gets the filename for the data without index and extension. MYTHEN only. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries fileformat} sets/gets the file format for data in receiver. Options: \mbox{[}ascii, binary, hdf5\mbox{]}. Ascii is not implemented in Receiver.
\item {\bfseries fileformat} sets/gets the file format for data in receiver. Options: \mbox{[}ascii, binary, hdf5\mbox{]}. Ascii is not implemented in Receiver. {\ttfamily Returns} {\ttfamily }(string)
\end{DoxyItemize}

20
manual/slsDetectorClientDocs/latex/receiver.tex
View File

@ -2,50 +2,50 @@ Commands to configure the receiver. Not used in MYTHEN.
\begin{DoxyItemize}
\item {\bfseries receiver \mbox{[}s\mbox{]}} starts/stops the receiver to listen to detector packets. Gets status of receiver. Options: \mbox{[}start, stop\mbox{]}.
\item {\bfseries receiver \mbox{[}s\mbox{]}} starts/stops the receiver to listen to detector packets. Options: \mbox{[} {\ttfamily start}, {\ttfamily stop}\mbox{]}. {\ttfamily Returns} {\ttfamily }(string) status of receiver\mbox{[} {\ttfamily idle}, {\ttfamily running}\mbox{]}.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries r\_\-online \mbox{[}i\mbox{]}} sets/gets the receiver in online/offline mode. 1 is online, 0 is offline. Get is from shared memory.
\item {\bfseries r\_\-online \mbox{[}i\mbox{]}} sets/gets the receiver in online/offline mode. 1 is online, 0 is offline. Get is from shared memory. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries r\_\-checkonline} Checks the receiver if it is online/offline mode. Prints either 'All receiver online', '\mbox{[}List of all receiver hostname in offline mode\mbox{]} :Not all receiver online'. Only get!
\item {\bfseries r\_\-checkonline} Checks the receiver if it is online/offline mode. Only get! {\ttfamily Returns} (string) \char`\"{}All online\char`\"{} or \char`\"{}\mbox{[}list of offline hostnames\mbox{]} : Not online\char`\"{}.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries framescaught} gets the number of frames caught by receiver. Average of all for multi-\/detector command. Only get!
\item {\bfseries framescaught} gets the number of frames caught by receiver. Average of all for multi-\/detector command. Only get! {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries resetframescaught \mbox{[}i\mbox{]}} resets the number of frames caught to 0. i can be any number. Use this if using status start, instead of acquire (this command is included). Only put!
\item {\bfseries resetframescaught \mbox{[}i\mbox{]}} resets the number of frames caught to 0. i can be any number. Use this if using status start, instead of acquire (this command is included). Only put! {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries frameindex \mbox{[}i\mbox{]}} gets the current frame index of receiver. Average of all for multi-\/detector command. Only get!
\item {\bfseries frameindex \mbox{[}i\mbox{]}} gets the current frame index of receiver. Average of all for multi-\/detector command. Only get! {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries r\_\-lock \mbox{[}i\mbox{]}} locks/unlocks the receiver to communicate with only this client. 1 locks, 0 unlocks.
\item {\bfseries r\_\-lock \mbox{[}i\mbox{]}} locks/unlocks the receiver to communicate with only this client. 1 locks, 0 unlocks. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries r\_\-lastclient} gets the last client communicating with the receiver. Only get!
\item {\bfseries r\_\-lastclient} gets the last client communicating with the receiver. Only get! {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries r\_\-readfreq \mbox{[}i\mbox{]}} sets/gets the stream frequency of data from receiver to client. i $>$ 0 is the nth frame being streamed. 0 sets frequency to a default timer (200ms).
\item {\bfseries r\_\-readfreq \mbox{[}i\mbox{]}} sets/gets the stream frequency of data from receiver to client. i $>$ 0 is the nth frame being streamed. 0 sets frequency to a default timer (200ms). {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries rx\_\-fifodepth \mbox{[}i\mbox{]}} sets/gets receiver fifo (between Listener and Writer Threads) depth to i number of frames. Can improve listener packet loss, not if limited by writing.
\item {\bfseries rx\_\-fifodepth \mbox{[}i\mbox{]}} sets/gets receiver fifo (between Listener and Writer Threads) depth to i number of frames. Can improve listener packet loss (loss due to packet processing time in Listener threads), not if limited by writing. {\ttfamily Returns} {\ttfamily }(int)
\end{DoxyItemize}

6
manual/slsDetectorClientDocs/latex/refman.tex
View File

@ -40,7 +40,7 @@
\vspace*{1cm}
{\large Generated by Doxygen 1.6.1}\\
\vspace*{0.5cm}
{\small Thu Aug 17 16:49:34 2017}\\
{\small Thu Aug 17 17:08:21 2017}\\
\end{center}
\end{titlepage}
\pagenumbering{roman}
@ -61,6 +61,10 @@
\label{config}
\hypertarget{config}{}
\input{config}
\section{Timing commands}
\label{timing}
\hypertarget{timing}{}
\input{timing}
\section{Data processing commands}
\label{data}
\hypertarget{data}{}

93
manual/slsDetectorClientDocs/latex/timing.tex Normal file
View File

@ -0,0 +1,93 @@
Commands to setup the timing
\begin{DoxyItemize}
\item {\bfseries timing \mbox{[}mode\mbox{]}} sets/gets synchronization mode of the detector. Mode: auto, trigger, ro\_\-trigger, gating, triggered\_\-gating (string)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries exptime \mbox{[}i\mbox{]}} sets/gets exposure time in s. {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries subexptime \mbox{[}i\mbox{]}} sets/gets sub exposure time in s. Used in EIGER only in 32 bit mode. {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
/$\ast$!
\begin{DoxyItemize}
\item {\bfseries gates \mbox{[}i\mbox{]}} sets/gets number of gates. Used in MYTHEN, GOTTHARD only. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries frames \mbox{[}i\mbox{]}} sets/gets number of frames. If {\ttfamily timing} is not {\ttfamily auto}, then it is the number of frames per cycle/trigger. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries cycles \mbox{[}i\mbox{]}} sets/gets number of triggers. Timing mode should be set appropriately. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries probes \mbox{[}i\mbox{]}} sets/gets number of probes to accumulate. When setting, max 3! cycles should be set to 1, frames to the number of pump-\/probe events. Used in MYTHEN only. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries measurements \mbox{[}i\mbox{]}} sets/gets number of measurements. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries samples \mbox{[}i\mbox{]}} sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only. {\ttfamily Returns} {\ttfamily }(long long int)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries exptimel} gets exposure time left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries periodl} gets frame period left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries delayl} gets delay left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries gatesl} gets number of gates left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries cyclesl} gets number of cylces left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries probesl} gets number of probes left. Used in MYTHEN, GOTTHARD only. Only get! {\ttfamily Returns} {\ttfamily }(double with 9 decimal digits)
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries now} Actual time of the detector. Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries timestamp} Last frame timestamp for MYTHEN. Only get!
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries nframes} ??? Only get!
\end{DoxyItemize}