Files
ADAndor/documentation/areaDetector.html
2008-09-18 22:10:25 +00:00

297 lines
8.2 KiB
HTML
Executable File

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>areaDetector: EPICS software for area detectors</title>
</head>
<body>
<h1>
areaDetector: EPICS software for area detectors</h1>
<p>
Module Owner: Mark Rivers: University of Chicago</p>
<p>
This page is the home of <b>areaDetector</b>, an application for controlling area
(2-D) detectors, including CCDs, pixel array detectors, and online imaging plates.
</p>
<p>
<b>NOTE:</b> This module will replace the <a href="http://cars.uchicago.edu/software/epics/ccd.html">
ccd</a> and <a href="http://cars.uchicago.edu/software/epics/epilatusROI.html">pilatusROI</a>
modules. &nbsp;</p>
<p>
Devices supported in <b>areaDetector</b> include:</p>
<p>
From <a href="http://www.dectris.com">Dectris</a>
</p>
<ul>
<li>The <a href="http://www.dectris.com/sites/pilatus100k.html">Pilatus</a> pixel-array
detector.</li>
</ul>
<p>
From <a href="http://www.prosilica.com">Prosilica</a>
</p>
<ul>
<li>High-speed, high-resolution CCD cameras. These use GigE and Firewire interfaces.</li>
</ul>
<p>
From <a href="http://www.mar-usa.com/">MAR</a> (coming soon)</p>
<ul>
<li>MAR-165 CCD camera.</li>
<li>MAR-345 online image plate reader</li>
</ul>
<p>
From <a href="http://www.roperscientific.com/">Roper</a> (coming soon)</p>
<ul>
<li>All CCD cameras supported by the WinView program.&nbsp; This includes the entire
Princeton Instruments line, as well as most of the Photometrics line. </li>
</ul>
<p>
From <a href="http://www.bruker-axs.de/">Bruker</a> (coming soon)</p>
<ul>
<li>The SMART CCD camera line with Photometrics cameras. This requires the PCI interface
card, replacing the old ISA bus card, and requires controlling the detector with
WinView, not the SMART software.</li>
</ul>
<p>
Please email any comments and bug reports to <a href="mailto:%20rivers@cars.uchicago.edu">
Mark Rivers</a> who is responsible for coordinating development and releases.</p>
<h2>
Where to find it</h2>
<p>
The areaDetector module is in the EPICS Applications SVN repository on <a href="http://epics.svn.sourceforge.net/viewvc/epics/applications/trunk/areaDetector/">
SourceForge.</a> Persons wishing to collaborate on this project can contact Mark
Rivers to get write access to this application there.
</p>
<p>
You can download the software from the links in the table below:</p>
<table border="1" summary="Where to find the software">
<tbody>
<tr align="center">
<th>
Module Version</th>
<th>
Release Date</th>
<th>
Filename</th>
<th>
Documentation</th>
<th>
Release Notes</th>
<th>
Known Problems</th>
</tr>
<tr>
<td>
1-2</td>
<td>
19-Sep-2008</td>
<td>
<a href="http://cars.uchicago.edu/software/pub/areaDetectorR1-1.tgz">areaDetectorR1-2.tgz</a></td>
<td>
<a href="areaDetectorDoc.html">areaDetectorDoc</a></td>
<td>
<a href="areaDetectorReleaseNotes.html">Release notes</a></td>
<td>
See release notes</td>
</tr>
<tr>
<td>
1-1</td>
<td>
10-May-2008</td>
<td>
<a href="http://cars.uchicago.edu/software/pub/areaDetectorR1-1.tgz">areaDetectorR1-1.tgz</a></td>
<td>
<a href="areaDetectorDoc.html">areaDetectorDoc</a></td>
<td>
<a href="areaDetectorReleaseNotes.html">Release notes</a></td>
<td>
See release notes</td>
</tr>
<tr>
<td>
1-0</td>
<td>
11-Apr-2008</td>
<td>
<a href="http://cars.uchicago.edu/software/pub/areaDetectorR1-0.tgz">areaDetectorR1-0.tgz</a></td>
<td>
<a href="areaDetectorDoc.html">areaDetectorDoc</a></td>
<td>
<a href="areaDetectorReleaseNotes.html">Release notes</a></td>
<td>
See release notes</td>
</tr>
</tbody>
</table>
<h2>
Required Modules</h2>
<table border="1" summary="Required Modules">
<tbody>
<tr align="center">
<th>
Module Version</th>
<th>
Requires module</th>
<th>
Release needed</th>
<th>
Required for</th>
</tr>
<tr>
<td rowspan="6">
1-2</td>
<td>
EPICS base</td>
<td>
3.14.8.2</td>
<td>
Base support</td>
</tr>
<tr>
<td>
asyn</td>
<td>
4-10</td>
<td>
Socket and interface support</td>
</tr>
<tr>
<td>
calc</td>
<td>
2-6-5</td>
<td>
scalcout record, needed by sscan database and useful for other databases</td>
</tr>
<tr>
<td>
sscan</td>
<td>
2-5-6</td>
<td>
Busy record</td>
</tr>
<tr>
<td>
mca</td>
<td>
6-10</td>
<td>
mca record for getting time sequence of ROI counts</td>
</tr>
<tr>
<td>
autosave</td>
<td>
4-3</td>
<td>
Save/restore</td>
</tr>
<tr>
<td rowspan="4">
1-1</td>
<td>
EPICS base</td>
<td>
3.14.8.2</td>
<td>
Base support</td>
</tr>
<tr>
<td>
asyn</td>
<td>
4-10</td>
<td>
Socket and interface support</td>
</tr>
<tr>
<td>
sscan</td>
<td>
2-5-6</td>
<td>
Busy record</td>
</tr>
<tr>
<td>
autosave</td>
<td>
4-3</td>
<td>
Save/restore</td>
</tr>
<tr>
<td rowspan="4">
1-0</td>
<td>
EPICS base</td>
<td>
3.14.8.2</td>
<td>
Base support</td>
</tr>
<tr>
<td>
asyn</td>
<td>
4-10</td>
<td>
Socket and interface support</td>
</tr>
<tr>
<td>
sscan</td>
<td>
2-5-6</td>
<td>
Busy record</td>
</tr>
<tr>
<td>
autosave</td>
<td>
4-3</td>
<td>
Save/restore</td>
</tr>
</tbody>
</table>
<h2>
Installation and Building</h2>
<p>
After obtaining a copy of the distribution, it must be installed and built for use
at your site. These steps only need to be performed once for the site (unless versions
of the module running under different releases of EPICS and/or the other required
modules are needed).</p>
<ol>
<li>Create an installation directory for the module, usually this will end with<br />
<br />
<tt>.../support/</tt>
<br />
</li>
<li>Place the distribution file in this directory. Then issue the commands (Unix style)
<pre>tar xvzf areaDetectorRX-Y.tgz
</pre>
where X-Y is the release.</li>
<li>This creates a &lt;top&gt; application.<br />
<pre>.../support/areaDetectorRX-Y
</pre>
</li>
<li>Edit the <tt>config[ure]/RELEASE</tt> file and set the paths to your installation
of EPICS base and to your versions of supporting modules.</li>
<li>Run <tt>gnumake</tt> in the top level directory and check for any compilation
errors.</li>
<li>Please email&nbsp; <a href="mailto:rivers@cars.uchicago.edu">Mark Rivers</a>&nbsp;
so that a record can be kept of which sites are using this software.</li>
</ol>
<h2>
In Use</h2>
<p>
This software was originally developed by Mark Rivers.</p>
<ul>
<li>ANL/APS : In use at CARS beamlines.</li>
<li>Australian Synchrotron : In use at microspectroscopy beamline, ID5.</li>
</ul>
</body>
</html>