From 3c2ec69e842f9f5530690a6d648f0f5de1df6552 Mon Sep 17 00:00:00 2001 From: rivers Date: Tue, 26 Oct 2010 02:07:40 +0000 Subject: [PATCH] Additions and reformatting git-svn-id: https://subversion.xor.aps.anl.gov/synApps/areaDetector/trunk@11885 dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b --- documentation/URLDriverDoc.html | 75 ++++++++++++++++++++------------- 1 file changed, 46 insertions(+), 29 deletions(-) diff --git a/documentation/URLDriverDoc.html b/documentation/URLDriverDoc.html index 3182814..f0212d4 100755 --- a/documentation/URLDriverDoc.html +++ b/documentation/URLDriverDoc.html @@ -29,16 +29,17 @@

Introduction

- This is a driver for reading images from a URL. It can be used to read images from Web cameras, - Axis video servers, or simply from a disk file. - It reads the images using - GraphicsMagick and can thus read images encoded in any of the formats supported by GraphicsMagick, + This is a driver for reading images from a URL. It can be used to read images from + Web cameras, Axis video servers, or simply from + a disk file. It reads the images using GraphicsMagick + and can thus read images encoded in any of the formats supported by GraphicsMagick, such as JPEG, TIFF, PNG, etc.

- The driver simply reads images from the specified URL at the rate determined by the AcquirePeriod. Web cameras - and Axis video servers have a URL address from which the current image can be read. There are often several - addresses for different image sizes. + The driver simply reads images from the specified URL at the rate determined by + the AcquirePeriod. Web cameras and Axis video servers have a URL address from which + the current image can be read. There are often several addresses for different image + sizes.

This driver inherits from ADDriver. @@ -73,9 +74,10 @@ $(P$(R)AcquirePeriod - This controls the period between reading images. The driver attempts to collected images at this rate - determined by this value. NOTE: If this value is set to 0 or - too small a value can result in the driver using 100% of the CPU and becoming unresponsive to EPICS. + This controls the period between reading images. The driver attempts to collected + images at this rate determined by this value. NOTE: If this value is set to 0 or + too small a value can result in the driver using 100% of the CPU and becoming unresponsive + to EPICS. @@ -115,7 +117,8 @@ r/w - The name of the URL to read images from. There are 10 output records to control the URL name. + The name of the URL to read images from. There are 10 output records to control + the URL name. URL_NAME @@ -126,25 +129,30 @@ waveform
waveform +

- The URLs for Web cameras and video servers are typically long strings, which are difficult to remember and to type. - Thus, for convenience there is an EPICS mbbo record which is used to select 1 of 10 URLs. This allows easily switching between - cameras, etc. The mbbo menu string fields (e.g. ZRST, ONST, etc.) can be edited to supply a useful short - description of each camera (e.g. "Sample camera", and the corresponding URL waveform record will store the actual URL. - Both are in save/restore. Note that when the mbbo menu string fields are edited then one will need to close the main URLDriver.adl - medm screen and reopen it to see the new menu choices. This is due to restrictions in medm and Channel Access. + The URLs for Web cameras and video servers are typically long strings, which are + difficult to remember and to type. Thus, for convenience there is an EPICS mbbo + record which is used to select 1 of 10 URLs. This allows easily switching between + cameras, etc. The mbbo menu string fields (e.g. ZRST, ONST, etc.) can be edited + to supply a useful short description of each camera (e.g. "Sample camera", and the + corresponding URL waveform record will store the actual URL. Both are in save/restore. + Note that when the mbbo menu string fields are edited then one will need to close + the main URLDriver.adl medm screen and reopen it to see the new menu choices. This + is due to restrictions in medm and Channel Access.

Unsupported standard driver parameters

- The URL driver does not support many of the standard driver parameters because it does not provide control of - image acquisition. Thus AcquireTime, binning, region to read out, trigger modes, etc. are not supported.

+ The URL driver does not support many of the standard driver parameters because it + does not provide control of image acquisition. Thus AcquireTime, binning, region + to read out, trigger modes, etc. are not supported.

Configuration

- The URL driver is created with the URLDriverConfig command, either from C/C++ - or from the EPICS IOC shell.

+ The URL driver is created with the URLDriverConfig command, either from C/C++ or + from the EPICS IOC shell.

int URLDriverConfig(const char *portName,
                 int maxBuffers, size_t maxMemory,
                 int priority, int stackSize)
@@ -152,8 +160,8 @@
   

     For details on the meaning of the parameters to this function refer to the detailed
     documentation on the URLDirverConfig function in the 
-      URLDriver.cpp documentation and in the documentation for the constructor for the
-    URLDriver class.
+      URLDriver.cpp documentation and in the documentation for the constructor for
+    the URLDriver class.
   

   

     There an example IOC boot directory and startup script (iocBoot/iocURL/st.cmd)
@@ -162,9 +170,9 @@
   

     MEDM screens

   

-    The following show the MEDM screens that are used to control the URL driver.
-    Note that the general purpose screen ADBase.adl can be used, but it exposes many
-    controls that are not applicable to the URL driver, and lacks some fields that are important
+    The following show the MEDM screens that are used to control the URL driver. Note
+    that the general purpose screen ADBase.adl can be used, but it exposes many controls
+    that are not applicable to the URL driver, and lacks some fields that are important
     for the URL driver.

   

     URLDriver.adl is the main screen used to control the URL driver.
@@ -174,13 +182,22 @@
       URLDriver.adl
     URLDriver.png
   

-    URLDriverSetup.adl is the screen used to configure the mbbo menu choices and the URL strings
-    for up to 10 preset URLs.  Note that when a new value is entered into any of the URL string waveform records that URL
-    will be immediately displayed, even if it is not the URL currently selected in the mbbo menu.
+    URLDriverSetup.adl is the screen used to configure the mbbo menu choices
+    and the URL strings for up to 10 preset URLs. Note that when a new value is entered
+    into any of the URL string waveform records that URL will be immediately displayed,
+    even if it is not the URL currently selected in the mbbo menu.
   

   

     

       URLDriverSetup.adl

     URLDriverSetup.png

+  

+    The following is an ImageJ viewer window looking at the URL driver connected to
+    analog camera through an Axis video server.
+  

+  

+    

+      ImageJ Viewer of URL driver with Axis video server

+    ImageJ_URLDriver.jpg