Removed references to writing TIFF files in driver, which is not longer supported; added note about using IP address or IP DNS name instead of UniqueId in constructor and prosilicaConfig command

git-svn-id: https://subversion.xor.aps.anl.gov/synApps/areaDetector/trunk@12957 dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b
This commit is contained in:
rivers
2011-06-20 03:53:28 +00:00
parent ddfffc17e0
commit 987c13a030

View File

@@ -36,12 +36,6 @@
to a user-supplied function each time there is a new frame. Thus, the driver does
not need to create a thread itself for callbacks."
</p>
<p>
The vendor library supports saving individual frames as TIFF files, and this is
implemented in the driver. Other file plugins, such as the <a href="NDPluginFile.html#netCDF">
NDFileNetCDF</a> plugin can be used to capture or stream images much more rapidly
in the netCDF file format.
</p>
<p>
This driver inherits from <a href="areaDetectorDoc.html#ADDriver">ADDriver</a>.
It implements nearly all of the parameters in <a href="areaDetectorDoxygenHTML/asyn_n_d_array_driver_8h.html">
@@ -69,14 +63,6 @@
The Prosilica supports hardware timing input and output signals that are supported
in the driver.
</p>
<p>
The NDFileFormat choices for the Prosilica are:
</p>
<ul>
<li>TIFF (this is the only format supported)</li>
<li>Invalid (this menu item is defined only because MEDM will not display a menu widget
with only 1 choice)</li>
</ul>
<p>
The NDDataType choices for the Prosilica are:
</p>
@@ -675,21 +661,28 @@
The Prosilica driver is created with the prosilicaConfig command, either from C/C++
or from the EPICS IOC shell.</p>
<pre>int prosilicaConfig(char *portName,
int uniqueId,
const char* cameraId,
int maxBuffers, size_t maxMemory,
int priority, int stackSize)
</pre>
<p>
The <b>uniqueId</b> parameter is a unique number assigned to each Prosilica camera.
areaDetector uses this number, rather than the TCP/IP address, to find the camera
and connect to it. This is done so that the cameras can be configured to use DHCP,
and hence have non-predictable TCP/IP addresses. This does mean that areaDetector
The <b>cameraId</b> string can be any of the following:</p>
<ul>
<li>The camera's UniqueId, which is a number assigned by the vendor to each Prosilica camera, e.g. 50110.</li>
<li>The camera's IP address, e.g. 164.54.160.48.</li>
<li>The camera's IP DNS name, e.g. gse-prosilica1.cars.aps.anl.gov.</li>
</ul>
<p>Using the UniqueId has the advantage that the cameras can be configured to use DHCP,
and hence have non-predictable TCP/IP addresses. However, if the UniqueId is used then the areaDetector
IOC must be on the same subnet as the camera, since cameras cannot be found by UniqueID
through routers. The simplest way to determine the uniqueId of a camera is to run
the Prosilica GigEViewer application, select the camera, and press the "i" icon
on the bottom of the main window to show the camera information for this camera.
The Unique ID will be displayed on the first line in the information window. For
details on the meaning of the other parameters to this function refer to the detailed
The Unique ID will be displayed on the first line in the information window.</p>
<p>The IP address or IP DNS name
can be used for cameras with fixed IP addresses, and <b>must</b> be used for cameras that are not
on the local subnet.</p>
<p>For details on the meaning of the other parameters to this function refer to the detailed
documentation on the prosilicaConfig function in the <a href="areaDetectorDoxygenHTML/prosilica_8cpp.html">
prosilica.cpp documentation</a> and in the documentation for the constructor for
the <a href="areaDetectorDoxygenHTML/classprosilica.html">prosilica class</a>.