Updated documentation

Documentation/html/_w_r_e_b_test_8py.html

@@ -4,7 +4,7 @@
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.8.11"/>
-<title>WREB Test: WREBTest.py File Reference</title>
+<title>REB Functional Tests: WREBTest.py File Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
@@ -32,9 +32,10 @@
  <tr style="height: 56px;">
   <td id="projectlogo"><img alt="Logo" src="LSSTLogoSmall.jpg"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
-   <div id="projectname">WREB Test
+   <div id="projectname">REB Functional Tests
+   &#160;<span id="projectnumber">1.0</span>
    </div>
-   <div id="projectbrief">Suite of tests for the WREB CCD controller boards.</div>
+   <div id="projectbrief">Suite of tests for the WREB, GREB, and VST readout boards.</div>
   </td>
  </tr>
  </tbody>
@@ -128,6 +129,9 @@
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_r_e_b_test_1_1_a_s_p_i_ccomms_test.html">WREBTest.ASPICcommsTest</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests that the board can communicate with the ASPICS.  <a href="class_w_r_e_b_test_1_1_a_s_p_i_ccomms_test.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_r_e_b_test_1_1_sequencer_toggling.html">WREBTest.SequencerToggling</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Toggles the sequencer outputs for the PCK/SCK/RG rails systems, switching the polarity.  <a href="class_w_r_e_b_test_1_1_sequencer_toggling.html#details">More...</a><br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_r_e_b_test_1_1_c_s_gate.html">WREBTest.CSGate</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests the current source gate.  <a href="class_w_r_e_b_test_1_1_c_s_gate.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -161,9 +165,15 @@
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_r_e_b_test_1_1_temperature_logging.html">WREBTest.TemperatureLogging</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Requests temperature logs for WREB.Temp(1-6) and CCD since the test started from the board's database.  <a href="class_w_r_e_b_test_1_1_temperature_logging.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_r_e_b_test_1_1_parameter_logging.html">WREBTest.ParameterLogging</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Periodically records specified values over the course of the testing sequence.  <a href="class_w_r_e_b_test_1_1_parameter_logging.html#details">More...</a><br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_r_e_b_test_1_1_a_s_p_i_c_noise.html">WREBTest.ASPICNoise</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Measure noise distribution in ASPICs for the unclamped, clamped, and reset cases.  <a href="class_w_r_e_b_test_1_1_a_s_p_i_c_noise.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_r_e_b_test_1_1_a_s_p_i_c_logging.html">WREBTest.ASPICLogging</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Continuously measure noise distribution in ASPICs.  <a href="class_w_r_e_b_test_1_1_a_s_p_i_c_logging.html#details">More...</a><br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_r_e_b_test_1_1_summary.html">WREBTest.Summary</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_w_r_e_b_test_1_1_summary.html" title="Summary object containing the needed information for the cover page. ">Summary</a> object containing the needed information for the cover page.  <a href="class_w_r_e_b_test_1_1_summary.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -182,6 +192,15 @@
 <tr class="memitem:abc7cd7c86faa6126711ebd4b5242f794"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_w_r_e_b_test_8py.html#abc7cd7c86faa6126711ebd4b5242f794">WREBTest.exitScript</a> ()</td></tr>
 <tr class="memdesc:abc7cd7c86faa6126711ebd4b5242f794"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset settings and exit.  <a href="_w_r_e_b_test_8py.html#abc7cd7c86faa6126711ebd4b5242f794">More...</a><br /></td></tr>
 <tr class="separator:abc7cd7c86faa6126711ebd4b5242f794"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:adbfa8ad5a4a0a82ff1d41cce4e52b1c2"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_w_r_e_b_test_8py.html#adbfa8ad5a4a0a82ff1d41cce4e52b1c2">WREBTest.stepRange</a> (start, end, step)</td></tr>
+<tr class="memdesc:adbfa8ad5a4a0a82ff1d41cce4e52b1c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a range object that can take non-integer steps.  <a href="_w_r_e_b_test_8py.html#adbfa8ad5a4a0a82ff1d41cce4e52b1c2">More...</a><br /></td></tr>
+<tr class="separator:adbfa8ad5a4a0a82ff1d41cce4e52b1c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a41336a62ef3706e77de2da37e7a61b80"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_w_r_e_b_test_8py.html#a41336a62ef3706e77de2da37e7a61b80">WREBTest.voltsToDAC</a> (volt, Rfb, Rin)</td></tr>
+<tr class="memdesc:a41336a62ef3706e77de2da37e7a61b80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a DAC code to correspond to a desired voltage.  <a href="_w_r_e_b_test_8py.html#a41336a62ef3706e77de2da37e7a61b80">More...</a><br /></td></tr>
+<tr class="separator:a41336a62ef3706e77de2da37e7a61b80"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a89da8741c281e720d74c25973130f9a3"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_w_r_e_b_test_8py.html#a89da8741c281e720d74c25973130f9a3">WREBTest.voltsToShiftedDAC</a> (volt, shvolt, Rfb, Rin)</td></tr>
+<tr class="memdesc:a89da8741c281e720d74c25973130f9a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a shifted DAC code to correspond to a desired voltage in a rail system.  <a href="_w_r_e_b_test_8py.html#a89da8741c281e720d74c25973130f9a3">More...</a><br /></td></tr>
+<tr class="separator:a89da8741c281e720d74c25973130f9a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a0806fdf61e3889ec1967d3c834800adb"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_w_r_e_b_test_8py.html#a0806fdf61e3889ec1967d3c834800adb">WREBTest.voltsToRailDAC</a> (V, rf, ri)</td></tr>
 <tr class="memdesc:a0806fdf61e3889ec1967d3c834800adb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given a voltage, return a pair of voltage, shift DAC values.  <a href="_w_r_e_b_test_8py.html#a0806fdf61e3889ec1967d3c834800adb">More...</a><br /></td></tr>
 <tr class="separator:a0806fdf61e3889ec1967d3c834800adb"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -205,11 +224,27 @@
 <li>astropy</li>
 <li>numpy</li>
 <li>matplotlib</li>
+<li>Unix Dialogs installation (for GUI, optional)</li>
+</ul>
+<p>To run:</p><ul>
+<li>"python REBTest.py [options]" Initial crashing yielding a ValueError is likely due to a crRun or JythonConsole crashing or not being loaded.</li>
+</ul>
+<p>Tests are structured as classes with four required methods:</p><ul>
+<li><b>init</b> sets initial variables; minimum required variables are self.title and self.status.</li>
+<li>runTest is the body of the tests, running the code to execute the tests and storing the results to state variables.</li>
+<li>summarize writes summary information to the summary object passed to it; this is used in generating the cover page.</li>
+<li>report writes the portion of the pdf report that the test is responsible for. Tests are executed from a list of test objects defined in FunctionalTest().</li>
+</ul>
+<p>This program communicates directly with the Jython interpreter to manipulate the board, so it does not need to be loaded into the Jython exectuor.</p>
+<p>External dependencies:</p><ul>
+<li>astropy</li>
+<li>numpy</li>
+<li>matplotlib</li>
+<li>Unix Dialogs installation (for GUI, optional)</li>
 </ul>
 <p>To run:</p><ul>
 <li>Ensure Jython console is running (./JythonConsole or the bootstrapper program)</li>
-<li>Ensure crRun.sh is running</li>
-<li>Ensure DACs are loaded in the CCS console</li>
+<li>Ensure rebRun.sh w is running</li>
 <li>"python WREBTest.py [options]" Initial crashing yielding a ValueError is likely due to a crRun or JythonConsole crashing or not being loaded.</li>
 </ul>
 <p>Tests are structured as classes with four required methods:</p><ul>
@@ -404,6 +439,90 @@
   </dd>
 </dl>
 
+</div>
+</div>
+<a class="anchor" id="file_adbfa8ad5a4a0a82ff1d41cce4e52b1c2"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">def WREBTest.stepRange </td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>start</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>end</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>step</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Generate a range object that can take non-integer steps. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">start</td><td>Starting value </td></tr>
+    <tr><td class="paramname">end</td><td>Ending value </td></tr>
+    <tr><td class="paramname">step</td><td>Step size </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="file_a41336a62ef3706e77de2da37e7a61b80"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">def WREBTest.voltsToDAC </td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>volt</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>Rfb</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>Rin</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Generate a DAC code to correspond to a desired voltage. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">volt</td><td>Desired voltage level </td></tr>
+    <tr><td class="paramname">Rfb</td><td>Op-amp Rf </td></tr>
+    <tr><td class="paramname">Rin</td><td>Op-amp Ri </td></tr>
+  </table>
+  </dd>
+</dl>
+
 </div>
 </div>
 <a class="anchor" id="file_a0806fdf61e3889ec1967d3c834800adb"></a>
@@ -447,6 +566,55 @@
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>(voltage, shift voltage) </dd></dl>
 
+</div>
+</div>
+<a class="anchor" id="file_a89da8741c281e720d74c25973130f9a3"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">def WREBTest.voltsToShiftedDAC </td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>volt</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>shvolt</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>Rfb</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>Rin</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Generate a shifted DAC code to correspond to a desired voltage in a rail system. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">volt</td><td>Desired voltage level </td></tr>
+    <tr><td class="paramname">shvolt</td><td>Shifted voltage level </td></tr>
+    <tr><td class="paramname">Rfb</td><td>Op-amp Rf </td></tr>
+    <tr><td class="paramname">Rin</td><td>Op-amp Ri </td></tr>
+  </table>
+  </dd>
+</dl>
+
 </div>
 </div>
 </div><!-- contents -->