From a21fbbd26c4722b28d5b4c8f8489530e1b40a4d6 Mon Sep 17 00:00:00 2001 From: rivers Date: Thu, 27 Sep 2012 23:29:16 +0000 Subject: [PATCH] Reformatted with VS git-svn-id: https://subversion.xor.aps.anl.gov/synApps/areaDetector/trunk@15238 dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b --- documentation/BrukerDoc.html | 89 ++++++++++++++++++------------------ 1 file changed, 44 insertions(+), 45 deletions(-) diff --git a/documentation/BrukerDoc.html b/documentation/BrukerDoc.html index 5ab8762..418461f 100755 --- a/documentation/BrukerDoc.html +++ b/documentation/BrukerDoc.html @@ -30,25 +30,25 @@

Introduction

- This is a driver for detectors from - Bruker AXS using the Bruker Instrument Server (BIS).

+ This is a driver for detectors from Bruker AXS + using the Bruker Instrument Server (BIS).

- The interface to the detector is via TCP/IP socket connections to the Bruker Instrument Server (BIS) - program that Bruker provides. The BIS program must be started before - the areaDetector software is started. + The interface to the detector is via TCP/IP socket connections to the Bruker Instrument + Server (BIS) program that Bruker provides. The BIS program must be started + before the areaDetector software is started.

- The Bruker Instrument Server saves the data to disk in Bruker's SRFM file format. The areaDetector - driver reads these disk files in order to read the data, because BIS does - not provide another mechanism to access the data. + The Bruker Instrument Server saves the data to disk in Bruker's SRFM file format. + The areaDetector driver reads these disk files in order to read the data, because + BIS does not provide another mechanism to access the data.

This driver inherits from ADDriver. It implements many of the parameters in asynNDArrayDriver.h and in ADArrayDriver.h. It also implements a number of parameters that are specific - to the Bruker detector. The BIS - class documentation describes this class in detail.

+ to the Bruker detector. The + BIS class documentation describes this class in detail.

Implementation of standard driver parameters

@@ -95,14 +95,12 @@ $(P)$(R)FilePath Controls the path for saving images. It must be a valid path for BIS and - for the areaDetector driver, which is normally running in an EPICS IOC. Normally BIS - and the EPICS IOC are run on the same machine so this is not an issue. Running the - IOC on another machine is difficult because Windows does not support soft links - that could be used to make the paths look identical.
- The terminator at the end of - FilePath must be a "\" character, it cannot be a "/" character, because BIS - only recognizes the "\". - + for the areaDetector driver, which is normally running in an EPICS IOC. Normally + BIS and the EPICS IOC are run on the same machine so this is not an issue. Running + the IOC on another machine is difficult because Windows does not support soft links + that could be used to make the paths look identical.
+ The terminator at the end of FilePath must be a "\" character, it cannot + be a "/" character, because BIS only recognizes the "\". @@ -110,8 +108,7 @@ $(P)$(R)FileFormat - BIS only supports Bruker format SRFM files. - + BIS only supports Bruker format SRFM files. @@ -132,10 +129,12 @@ -

- BIS will automatically open and close the shutter when exposures are collected. It does this by changing the state of - pin 3 of the parallel port DB-25 connector on the PC. This signal is connected to a shutter control box. Alternatively, - if ADShutterMode is set to ADShutterModeEPICS, then any EPICS PV can be used to control a shutter.

+

+ BIS will automatically open and close the shutter when exposures are collected. + It does this by changing the state of pin 3 of the parallel port DB-25 connector + on the PC. This signal is connected to a shutter control box. Alternatively, if + ADShutterMode is set to ADShutterModeEPICS, then any EPICS PV can be used to control + a shutter.

Bruker specific parameters

@@ -149,7 +148,8 @@ - Parameter Definitions in mar345.cpp and EPICS Record Definitions in mar345.template + Parameter Definitions in mar345.cpp and EPICS Record Definitions in mar345.template + @@ -185,8 +185,7 @@ $(P)$(R)ReadSFRMTimeout - ao - + ao @@ -202,8 +201,7 @@ $(P)$(R)BISStatus - waveform - + waveform @@ -222,8 +220,7 @@ longout
- longin - + longin @@ -242,12 +239,13 @@
  • Capture or stream file saving (NDFileWriteMode, NDFileCapture, NDNumCapture, NDNumCaptured)

    • - BIS supports binning, but the binning in the X and Y directions must be the same, so only ADBinX is supported.

    + BIS supports binning, but the binning in the X and Y directions must be the same, + so only ADBinX is supported.

    Configuration

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

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

       BISDetectorConfig(const char *portName, const char *commandPort, const char *statusPort,
                     int maxBuffers, size_t maxMemory,
@@ -256,8 +254,8 @@
   
    
     For details on the meaning of the parameters to this function refer to the detailed
     documentation on theBISDetectorConfig function in the 
-      BIS.cpp documentation and in the documentation for the constructor for
-    the BIS class.
+      BIS.cpp documentation and in the documentation for the constructor for the
+    BIS class.
   
    
   
    
     There an example IOC boot directory and startup script (iocBoot/iocBruker/st.cmd)
@@ -282,15 +280,16 @@
   
    
     The following are some current restrictions of the Bruker driver: