Start documenting improvements for R1-8

git-svn-id: https://subversion.xor.aps.anl.gov/synApps/areaDetector/trunk@14247 dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b
This commit is contained in:
rivers
2011-12-03 19:59:30 +00:00
parent 5c34d2d7ee
commit ee1d127436

View File

@@ -10,7 +10,7 @@
<h1>
areaDetector PerkinElmer driver</h1>
<h2>
August 9, 2011</h2>
December 3, 2011</h2>
<h2>
John Hammonds, Brian Tieman, Mark Rivers</h2>
<h2>
@@ -35,16 +35,15 @@
PerkinElmer</a>.</p>
<p>
The driver is based upon the XISL library provided by PerkinElmer. It only runs
on Microsoft Windows computers.
on Microsoft Windows computers. It supports both 32-bit and 64-bit versions of Windows.
</p>
<p>
This driver has been tested with the following detectors</p>
<ul>
<li>XRD0820 w/ XRD-FG PCI frame grabber</li>
<li>XRD1621 w/ XRD-FGX PCI frame grabber</li>
</ul>
<p>
ADD ADDTIONAL INTRODUCTORY TEXT HERE.</p>
<li>XRD1621 w/ XRD-FGe Opto PCI-Express frame grabber</li>
</ul>
<p>
This driver inherits from <a href="areaDetectorDoc.html#ADDriver">ADDriver</a>.
It implements many of the parameters in <a href="areaDetectorDoxygenHTML/asyn_n_d_array_driver_8h.html">
@@ -58,8 +57,6 @@
The following table describes how the PerkinElmer driver implements some of the
standard driver parameters.
</p>
<p>
DOCUMENT IMPLEMENTATION OF STANDARD DRIVER PARAMETERS IN THIS TABLE</p>
<table border="1" cellpadding="2" cellspacing="2" style="text-align: left">
<tbody>
<tr>
@@ -81,7 +78,7 @@
<td>
$(P)$(R)NumImages</td>
<td>
Controls the number of images to acquire when ADImageMode is ADImageMultiple.</td>
Controls the number of images to acquire when ADImageMode is Multiple or Average</td>
</tr>
<tr>
<td>
@@ -92,7 +89,7 @@
<td>
When using Internal Triggers, this parameter controls the period between trigger
pulses which will also be equal to the exposure time. This parameter is only updated
when the detector is initialized</td>
when the detector is initialized.</td>
</tr>
<tr>
<td>
@@ -110,13 +107,26 @@
</ul>
</td>
</tr>
</tbody>
<tr>
<td>
ADImageMode</td>
<td>
$(P)$(R)ImageMode<br />
$(P)$(R)ImageMode_RBV</td>
<td>
Sets the trigger mode for the detector. Options are:
<ul>
<li>Single</li>
<li>Multiple</li>
<li>Continuous</li>
<li>Average. This mode is new for the Perkin Elmer. It averages NumImages frames in
the hardware frame grabber. It is useful when the total acquisition time is longer than
the 5 second maximum allowed in Internal trigger mode, etc.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>
It is useful to use NDPluginROI to define an ROI containing the entire PerkinElmer
detector. The MaxValue_RBV PV in this ROI can be monitored to make sure that the
16-bit limit of 65,535 is not being approached in any pixel.
</p>
<h2 id="Driver_parameters" style="text-align: left">
PerkinElmer specific parameters</h2>
<p>
@@ -237,7 +247,7 @@
<td>
r</td>
<td>
Frame number from frame buffer for this image</td>
Frame number from the hardware frame buffer for this image. Values go from 1 to 8.</td>
<td>
PE_FRAME_BUFFER_INDEX</td>
<td>
@@ -253,7 +263,7 @@
<td>
r</td>
<td>
Image number for this image in the collections sequence</td>
Image number for this image in the image buffer array.</td>
<td>
PE_IMAGE_NUMBER</td>
<td>