More user guide udpates

therandomfactory · Mar 7, 2021 · c7e8bed · c7e8bed
1 parent 34f47d0
commit c7e8bed
Show file tree

Hide file tree

Showing 420 changed files with 6,627 additions and 3,993 deletions.
diff --git a/andor/andor_tcl.c b/andor/andor_tcl.c
@@ -131,7 +131,7 @@ void copyline (int *tobuf, int *frombuf, int count, int offset);
 void create_fits_header(fitsfile *fptr);
 
 /** 
- * \brief Store iamge data to FITS file
+ * \brief Store image data to FITS file
  * \param cameraId Andor camera number , 0 or 1
  * \param filename Name of FITS file
  * \param iexp Number of frame (for Kinetics acquisition)
@@ -157,7 +157,7 @@ int cAndorDisplaySingle(int cameraId, int ifft);
 
 
 /** 
- * \brief Store iamge data to FITS file, support ROI and binning
+ * \brief Store image data to FITS file, support ROI and binning
  * \param cameraId Andor camera number , 0 or 1
  * \param filename Name of FITS file
  * \param iexp Number of frame (for Kinetics acquisition)

diff --git a/cleanRestart.geminiN b/cleanRestart.geminiN
@@ -4,6 +4,9 @@
 #  hardware and software
 #
 export INSTRUMENT alopeke
+pkill -9 wish
+pkill -9 ds9red
+pkill -9 ds9blue
 tclsh $HOME/speckle-control/gui-scripts/powerControl.tcl cleanRestart
 $HOME/speckle-control/setDevicePermissions
 $HOME/speckle-control/startspeckle2
diff --git a/cleanRestart.geminiS b/cleanRestart.geminiS
@@ -4,6 +4,9 @@
 #  hardware and software
 #
 export INSTRUMENT zorro
+pkill -9 wish
+pkill -9 ds9red
+pkill -9 ds9blue
 tclsh $HOME/speckle-control/gui-scripts/powerControl.tcl cleanRestart
 $HOME/speckle-control/setDevicePermissions
 $HOME/speckle-control/startspeckle2
diff --git a/cleanRestart.wiyn b/cleanRestart.wiyn
@@ -4,6 +4,9 @@
 #  hardware and software
 #
 export INSTRUMENT wiyn
+pkill -9 wish
+pkill -9 ds9red
+pkill -9 ds9blue
 tclsh $HOME/speckle-control/gui-scripts/powerControl.tcl cleanRestart
 $HOME/speckle-control/setDevicePermissions
 $HOME/speckle-control/startspeckle2
diff --git a/doc/.~lock.user-guide.odt# b/doc/.~lock.user-guide.odt#
@@ -0,0 +1 @@
+,rfactory,localhost.localdomain,07.03.2021 14:34,file:///home/rfactory/.config/libreoffice/4;
diff --git a/doc/Andor SIF API.pdf b/doc/Andor SIF API.pdf
diff --git a/doc/Software Development Kit.pdf b/doc/Software Development Kit.pdf
diff --git a/doc/code/html/_gen_one_linux_u_s_b_8cpp.html b/doc/code/html/_gen_one_linux_u_s_b_8cpp.html
@@ -201,7 +201,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_28e1bb8382970ac72e8ae3b23df4a891.html">temp</a></li><li class="navelem"><a class="el" href="_gen_one_linux_u_s_b_8cpp.html">GenOneLinuxUSB.cpp</a></li>
-    <li class="footer">Generated on Thu Feb 25 2021 12:22:18 for Speckle by
+    <li class="footer">Generated on Sun Mar 7 2021 14:37:28 for Speckle by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
   </ul>

diff --git a/doc/code/html/_gen_one_linux_u_s_b_8cpp_source.html b/doc/code/html/_gen_one_linux_u_s_b_8cpp_source.html
@@ -347,7 +347,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_28e1bb8382970ac72e8ae3b23df4a891.html">temp</a></li><li class="navelem"><a class="el" href="_gen_one_linux_u_s_b_8cpp.html">GenOneLinuxUSB.cpp</a></li>
-    <li class="footer">Generated on Thu Feb 25 2021 12:22:17 for Speckle by
+    <li class="footer">Generated on Sun Mar 7 2021 14:37:27 for Speckle by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
   </ul>

diff --git a/doc/code/html/_gen_one_linux_u_s_b_8h.html b/doc/code/html/_gen_one_linux_u_s_b_8h.html
@@ -136,7 +136,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_28e1bb8382970ac72e8ae3b23df4a891.html">temp</a></li><li class="navelem"><a class="el" href="_gen_one_linux_u_s_b_8h.html">GenOneLinuxUSB.h</a></li>
-    <li class="footer">Generated on Thu Feb 25 2021 12:22:18 for Speckle by
+    <li class="footer">Generated on Sun Mar 7 2021 14:37:28 for Speckle by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
   </ul>

diff --git a/doc/code/html/_gen_one_linux_u_s_b_8h_source.html b/doc/code/html/_gen_one_linux_u_s_b_8h_source.html
@@ -180,7 +180,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_28e1bb8382970ac72e8ae3b23df4a891.html">temp</a></li><li class="navelem"><a class="el" href="_gen_one_linux_u_s_b_8h.html">GenOneLinuxUSB.h</a></li>
-    <li class="footer">Generated on Thu Feb 25 2021 12:22:17 for Speckle by
+    <li class="footer">Generated on Sun Mar 7 2021 14:37:27 for Speckle by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
   </ul>

diff --git a/doc/code/html/_get_relative_image_times_8cpp.html b/doc/code/html/_get_relative_image_times_8cpp.html
@@ -156,7 +156,7 @@ <h2 class="groupheader">Function Documentation</h2>
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_28e1bb8382970ac72e8ae3b23df4a891.html">temp</a></li><li class="navelem"><a class="el" href="_get_relative_image_times_8cpp.html">GetRelativeImageTimes.cpp</a></li>
-    <li class="footer">Generated on Thu Feb 25 2021 12:22:18 for Speckle by
+    <li class="footer">Generated on Sun Mar 7 2021 14:37:28 for Speckle by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
   </ul>

diff --git a/doc/code/html/_get_relative_image_times_8cpp_source.html b/doc/code/html/_get_relative_image_times_8cpp_source.html
@@ -228,7 +228,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_28e1bb8382970ac72e8ae3b23df4a891.html">temp</a></li><li class="navelem"><a class="el" href="_get_relative_image_times_8cpp.html">GetRelativeImageTimes.cpp</a></li>
-    <li class="footer">Generated on Thu Feb 25 2021 12:22:17 for Speckle by
+    <li class="footer">Generated on Sun Mar 7 2021 14:37:27 for Speckle by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
   </ul>

diff --git a/doc/code/html/andor_8tcl.html b/doc/code/html/andor_8tcl.html
@@ -191,7 +191,7 @@
  ACQREGION - ROI properties xs,xe,ys,ye<br/>
  ANDOR_CFG - Andor camera properties </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00537">537</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00549">549</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -212,7 +212,7 @@
  SCOPE - Array of telescope settings<br/>
  STATUS - Array of exposure statuses </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00562">562</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00574">574</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -232,7 +232,7 @@
  SCOPE - Array of telescope settings<br/>
  STATUS - Array of exposure statuses </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00585">585</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00597">597</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -267,7 +267,7 @@
  ANDOR_SOCKET - Array of (2) socket file handles<br/>
  SCOPE - Array of telescope settings </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00203">203</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00215">215</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -299,7 +299,7 @@
 <p>Send command to both cameras if clone setting is selected</p>
 <p>Globals : INSTRUMENT - Array of instrument settings </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00265">265</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00277">277</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -318,7 +318,7 @@
  ANDOR_SOCKET - Array of (2) socket file handles<br/>
  INSTRUMENT - Array of instrument settings </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00159">159</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00171">171</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -340,7 +340,7 @@
  CAMSTATUS - Array of camera current settings retrieved from Andor servers<br/>
  ANDOR_CFG - Andor camera properties </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00365">365</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00377">377</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -356,7 +356,7 @@
 <p>Documented proc <code>commandAndor</code> . Flush the Andor communication sockets</p>
 <p>Globals : ANDOR_SOCKET - Array of (2) socket file handles </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00244">244</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00256">256</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -390,7 +390,7 @@
  SPECKLE_DIR - Directory path to speckle software installation<br/>
  DS9 - Name of a ds9 executable for XPA control (ds9red or ds9blue) </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00125">125</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00137">137</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -421,7 +421,7 @@
 <p>Globals : ANDOR_CFG - Array of camera configuration items</p>
 <p>This function initializes all the items of the ANDOR_CFG global array to a default value of ? to ensure that we can easily see when they are assigned actual values via the Andor library wrapped calls. </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00053">53</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00065">65</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -437,7 +437,7 @@
 <p>Documented proc <code>initControl</code> .</p>
 <p>Set inital default values in the SharedMem2 shared memory area which is used for high speed data sharing with the Andor camera servers </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00512">512</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00524">524</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -469,7 +469,7 @@
 </dl>
 <p>Globals : SPECKLE_DIR - Directory path to speckle software installation </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00098">98</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00110">110</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -490,7 +490,7 @@
  STATUS - Array of exposure statuses<br/>
  ACQREGION - ROI properties xs,xe,ys,ye </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00285">285</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00297">297</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -521,7 +521,7 @@
 </dl>
 <p>Globals : ANDOR_CFG - Array of camera configuration items </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00083">83</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00095">95</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -551,7 +551,7 @@
 </dl>
 <p>Globals : ANDOR_CFG - Array of camera configuration items </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00067">67</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00079">79</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -583,7 +583,7 @@
 <p>This function uses XPA to start a refresh cycle in a ds9</p>
 <p>Globals : DS9 - Name of a ds9 executable for XPA control (ds9red or ds9blue) </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00143">143</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00155">155</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -614,7 +614,7 @@
 </dl>
 <p>This function uses XPA to start a refresh cycle in ds9 </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00111">111</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00123">123</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -645,7 +645,7 @@
  ACQREGION - ROI properties xs,xe,ys,ye<br/>
 </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00606">606</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00618">618</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -674,7 +674,7 @@
  ANDOR_SOCKET - Array of (2) socket file handles<br/>
  ACQREGION - ROI properties xs,xe,ys,ye </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00641">641</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00653">653</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -690,7 +690,7 @@
 <p>Documented proc <code>showControl</code> .</p>
 <p>Print contents of SharedMem2 shared memory area which is used for high speed data sharing with the Andor camera servers </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00480">480</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00492">492</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -706,7 +706,7 @@
 <p>Documented proc <code>startfastvideo</code> .</p>
 <p>Initiate fast video mode Globals : STATUS - Array of exposure statuses </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00331">331</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00343">343</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -725,7 +725,7 @@
  SCOPE - Array of telescope settings<br/>
  STATUS - Array of exposure statuses </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00464">464</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00476">476</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -741,7 +741,7 @@
 <p>Documented proc <code>testControl</code> .</p>
 <p>Test setting values in the SharedMem2 shared memory area which is used for high speed data sharing with the Andor camera servers </p>
 
-<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00498">498</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
+<p>Definition at line <a class="el" href="andor_8tcl_source.html#l00510">510</a> of file <a class="el" href="andor_8tcl_source.html">andor.tcl</a>.</p>
 
 </div>
 </div>
@@ -751,7 +751,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_28e1bb8382970ac72e8ae3b23df4a891.html">temp</a></li><li class="navelem"><a class="el" href="andor_8tcl.html">andor.tcl</a></li>
-    <li class="footer">Generated on Thu Feb 25 2021 12:22:18 for Speckle by
+    <li class="footer">Generated on Sun Mar 7 2021 14:37:28 for Speckle by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
   </ul>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		,rfactory,localhost.localdomain,07.03.2021 14:34,file:///home/rfactory/.config/libreoffice/4;