From f8060ef757e78974d34e3924e9963dc9a8a69ccc Mon Sep 17 00:00:00 2001 From: Dhanya Maliakal Date: Tue, 15 Aug 2017 18:29:07 +0200 Subject: [PATCH] more changes to client docu. more coming up --- .../slsDetector/slsDetectorCommand.cpp | 19 +++++++++-- .../slsDetectorClientDocs/html/settings.html | 20 +++++++++++- .../slsDetectorClientDocs/latex/doxygen.sty | 4 +-- .../slsDetectorClientDocs/latex/refman.tex | 2 +- .../slsDetectorClientDocs/latex/settings.tex | 32 ++++++++++++++++++- 5 files changed, 69 insertions(+), 8 deletions(-) diff --git a/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp b/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp index 2ab156fbb..e66294451 100644 --- a/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp +++ b/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp @@ -1033,30 +1033,43 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) { i++; /*! \page settings - - settings [s] sets/gets the settings of the detector. Options: \c standard, \c fast, \c highgain, \c dynamicgain, \c lowgain, \c mediumgain, \c veryhighgain, - \c lownoise, \c dynamichg0, \c fixgain1, \c fixgain2, \c forceswitchg1, \c forceswitchg2. - \n In Eiger, only sets in client shared memory. Use \c threshold or \c thresholdnotb to pass to detector + - threshold [eV] [sett] sets/gets the detector threshold in eV. sett is optional and if provided also sets the settings. Use this for Eiger instead of \c settings. */ descrToFuncMap[i].m_pFuncName="threshold"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSettings; i++; + /*! \page settings + - thresholdnotb [eV] [sett] sets/gets the detector threshold in eV without loading trimbits. sett is optional and if provided also sets the settings. Use this for Eiger instead of \c settings. + */ descrToFuncMap[i].m_pFuncName="thresholdnotb"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSettings; i++; + /*! \page settings + - trimbits [fname] loads/stores the trimbits to/from the detector. If no extension is specified, the serial number of each module will be attached. + */ descrToFuncMap[i].m_pFuncName="trimbits"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSettings; i++; + /*! \page settings + - trim:[mode] [fname] trims the detector according to mode and saves resulting trimbits to file. Mode: noise, beam, improve, fix. Used in MYTHEN only. Only put! + */ descrToFuncMap[i].m_pFuncName="trim"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSettings; i++; + /*! \page settings + - trimval [i] sets all trimbits to i. Used in EIGER only. + */ descrToFuncMap[i].m_pFuncName="trimval"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSettings; i++; + /*! \page settings + - pedestal [i] starts acquisition for i frames, calculates pedestal and writes back to fpga. Used in GOTTHARD only. Only put! + */ descrToFuncMap[i].m_pFuncName="pedestal"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSettings; i++; diff --git a/slsDetectorSoftware/slsDetectorClientDocs/html/settings.html b/slsDetectorSoftware/slsDetectorClientDocs/html/settings.html index 7380859a5..c3c418784 100644 --- a/slsDetectorSoftware/slsDetectorClientDocs/html/settings.html +++ b/slsDetectorSoftware/slsDetectorClientDocs/html/settings.html @@ -53,7 +53,25 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); + + + + + + diff --git a/slsDetectorSoftware/slsDetectorClientDocs/latex/doxygen.sty b/slsDetectorSoftware/slsDetectorClientDocs/latex/doxygen.sty index c953c0ef2..d94925b0c 100644 --- a/slsDetectorSoftware/slsDetectorClientDocs/latex/doxygen.sty +++ b/slsDetectorSoftware/slsDetectorClientDocs/latex/doxygen.sty @@ -24,9 +24,9 @@ \fancyplain{}{\bfseries\thepage}% } \rfoot[\fancyplain{}{\bfseries\scriptsize% - Generated on Tue Aug 15 17:35:40 2017 by Doxygen }]{} + Generated on Tue Aug 15 18:28:48 2017 by Doxygen }]{} \lfoot[]{\fancyplain{}{\bfseries\scriptsize% - Generated on Tue Aug 15 17:35:40 2017 by Doxygen }} + Generated on Tue Aug 15 18:28:48 2017 by Doxygen }} \cfoot{} %---------- Internal commands used in this style file ---------------- diff --git a/slsDetectorSoftware/slsDetectorClientDocs/latex/refman.tex b/slsDetectorSoftware/slsDetectorClientDocs/latex/refman.tex index 402177a1d..bb61fbe10 100644 --- a/slsDetectorSoftware/slsDetectorClientDocs/latex/refman.tex +++ b/slsDetectorSoftware/slsDetectorClientDocs/latex/refman.tex @@ -40,7 +40,7 @@ \vspace*{1cm} {\large Generated by Doxygen 1.6.1}\\ \vspace*{0.5cm} -{\small Tue Aug 15 17:35:40 2017}\\ +{\small Tue Aug 15 18:28:48 2017}\\ \end{center} \end{titlepage} \pagenumbering{roman} diff --git a/slsDetectorSoftware/slsDetectorClientDocs/latex/settings.tex b/slsDetectorSoftware/slsDetectorClientDocs/latex/settings.tex index ab67306c3..5655ee20c 100644 --- a/slsDetectorSoftware/slsDetectorClientDocs/latex/settings.tex +++ b/slsDetectorSoftware/slsDetectorClientDocs/latex/settings.tex @@ -23,5 +23,35 @@ Commands to setup the settings of the detector \begin{DoxyItemize} \item {\bfseries settings \mbox{[}s\mbox{]}} sets/gets the settings of the detector. Options: {\ttfamily standard}, {\ttfamily fast}, {\ttfamily highgain}, {\ttfamily dynamicgain}, {\ttfamily lowgain}, {\ttfamily mediumgain}, {\ttfamily veryhighgain}, {\ttfamily lownoise}, {\ttfamily dynamichg0}, {\ttfamily fixgain1}, {\ttfamily fixgain2}, {\ttfamily forceswitchg1}, {\ttfamily forceswitchg2}. \par - In Eiger, only sets in client shared memory. Use {\ttfamily threshold} or {\ttfamily threshold\_\-notb} to pass to detector + In Eiger, only sets in client shared memory. Use {\ttfamily threshold} or {\ttfamily thresholdnotb} to pass to detector. Gets from detector. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries threshold \mbox{[}eV\mbox{]} \mbox{[}sett\mbox{]} } sets/gets the detector threshold in eV. sett is optional and if provided also sets the settings. Use this for Eiger instead of {\ttfamily settings}. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries thresholdnotb \mbox{[}eV\mbox{]} \mbox{[}sett\mbox{]} } sets/gets the detector threshold in eV without loading trimbits. sett is optional and if provided also sets the settings. Use this for Eiger instead of {\ttfamily settings}. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries trimbits \mbox{[}fname\mbox{]} } loads/stores the trimbits to/from the detector. If no extension is specified, the serial number of each module will be attached. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries trim:\mbox{[}mode\mbox{]} \mbox{[}fname\mbox{]}} trims the detector according to mode and saves resulting trimbits to file. Mode: noise, beam, improve, fix. Used in MYTHEN only. Only put! +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries trimval \mbox{[}i\mbox{]}} sets all trimbits to i. Used in EIGER only. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries pedestal \mbox{[}i\mbox{]}} starts acquisition for i frames, calculates pedestal and writes back to fpga. Used in GOTTHARD only. Only put! \end{DoxyItemize} \ No newline at end of file