mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-06-06 18:10:40 +02:00
more changes to client docu. more coming up
This commit is contained in:
Dhanya Maliakal
parent
8e1a841b42
commit
f8060ef757
@ -1033,30 +1033,43 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
i++;
|
||||
|
||||
/*! \page settings
|
||||
- <b>settings [s]</b> 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
|
||||
- <b>threshold [eV] [sett] </b> 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
|
||||
- <b>thresholdnotb [eV] [sett] </b> 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
|
||||
- <b>trimbits [fname] </b> 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
|
||||
- <b>trim:[mode] [fname]</b> 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
|
||||
- <b>trimval [i]</b> sets all trimbits to i. Used in EIGER only.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="trimval"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSettings;
|
||||
i++;
|
||||
|
||||
/*! \page settings
|
||||
- <b>pedestal [i]</b> 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++;
|
||||
|
||||
@ -53,7 +53,25 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>settings [s]</b> sets/gets the settings of the detector. Options: <code>standard</code>, <code>fast</code>, <code>highgain</code>, <code>dynamicgain</code>, <code>lowgain</code>, <code>mediumgain</code>, <code>veryhighgain</code>, <code>lownoise</code>, <code>dynamichg0</code>, <code>fixgain1</code>, <code>fixgain2</code>, <code>forceswitchg1</code>, <code>forceswitchg2</code>. <br/>
|
||||
In Eiger, only sets in client shared memory. Use <code>threshold</code> or <code>threshold_notb</code> to pass to detector </li>
|
||||
In Eiger, only sets in client shared memory. Use <code>threshold</code> or <code>thresholdnotb</code> to pass to detector. Gets from detector.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>threshold [eV] [sett] </b> sets/gets the detector threshold in eV. sett is optional and if provided also sets the settings. Use this for Eiger instead of <code>settings</code>.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>thresholdnotb [eV] [sett] </b> 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 <code>settings</code>.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>trimbits [fname] </b> loads/stores the trimbits to/from the detector. If no extension is specified, the serial number of each module will be attached.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>trim:[mode] [fname]</b> trims the detector according to mode and saves resulting trimbits to file. Mode: noise, beam, improve, fix. Used in MYTHEN only. Only put!</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>trimval [i]</b> sets all trimbits to i. Used in EIGER only.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>pedestal [i]</b> starts acquisition for i frames, calculates pedestal and writes back to fpga. Used in GOTTHARD only. Only put! </li>
|
||||
</ul>
|
||||
</div>
|
||||
<!--- window showing the filter options -->
|
||||
|
||||
@ -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 ----------------
|
||||
|
||||
@ -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}
|
||||
|
||||
@ -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}
|
||||
Loading…
x
Reference in New Issue
Block a user