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

moved the output dir of slsdetectorClientDocs

Browse Source
This commit is contained in:
Dhanya Maliakal
2017-08-16 11:11:13 +02:00
parent 6a2c0ac86d
commit c489aeb9dc
38 changed files with 4397 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

126
manual/slsDetectorClientDocs/latex/actions.tex Normal file
View File

@ -0,0 +1,126 @@
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.
\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.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries startscriptpar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the startscript
\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.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries stopscriptpar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the stopscript
\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.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scriptbeforepar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the scriptbefore
\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.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scriptafterpar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the scriptafter
\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.
\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.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries headerbeforepar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the headerbefore script
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries headerafterpar \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the headerafter script
\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.
\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.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scan0script \mbox{[}s\mbox{]}} sets/gets the script to be executed for the scan 0 level. {\ttfamily none} unsets.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scan0par \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the scan0script
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scan0prec \mbox{[}i\mbox{]}} sets/gets number of digits to be used for the scan0 variable in the file name.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scan0steps \mbox{[}i \mbox{[}s0..sn-\/1\mbox{]}\mbox{]}} sets/gets number of steps (int) of the scan0 level and their values (float).
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scan0range \mbox{[}smin smax sstep\mbox{]}} sets scan0 min, max and step, returns the number of steps and their values as scan0steps.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scan1script \mbox{[}s\mbox{]}} sets/gets the script to be executed for the scan1 level. {\ttfamily none} unsets.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scan1par \mbox{[}s\mbox{]}} sets/gets a string to be passed as a parameter to the scan1script
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scan1prec \mbox{[}i\mbox{]}} sets/gets number of digits to be used for the scan1 variable in the file name.
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scan1steps \mbox{[}i \mbox{[}s0..sn-\/1\mbox{]}\mbox{]}} sets/gets number of steps (int) of the scan1 level and their values (float).
\end{DoxyItemize}
\begin{DoxyItemize}
\item {\bfseries scan1range \mbox{[}smin smax sstep\mbox{]}} sets scan1 min, max and step, returns the number of steps and their values as scan1steps.
\end{DoxyItemize}