From 70814c4d4fe9362bf3454c28b244d75ab3553acf Mon Sep 17 00:00:00 2001 From: rivers Date: Mon, 17 Aug 2009 22:50:15 +0000 Subject: [PATCH] Use links for configuration and st.cmd; changes for R1-5 git-svn-id: https://subversion.xor.aps.anl.gov/synApps/areaDetector/trunk@9320 dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b --- documentation/MarCCDDoc.html | 182 +++++++---------------------------- 1 file changed, 34 insertions(+), 148 deletions(-) diff --git a/documentation/MarCCDDoc.html b/documentation/MarCCDDoc.html index 4cca131..c49b12f 100755 --- a/documentation/MarCCDDoc.html +++ b/documentation/MarCCDDoc.html @@ -10,7 +10,7 @@

areaDetector MarCCD driver

- January 26, 2009

+ August 17, 2009

Mark Rivers

@@ -32,8 +32,8 @@ Introduction

This is a driver for the MarCCD detectors from Rayonix/MarUSA. - It inherits from ADDriver and implements many of the parameters in ADStdDriverParams.h. - It also implements a number of parameters that are specific to the MarCCD detectors.

+ It implements many of the parameters in asynNDArrayDriver.h and ADDriver.h. It also + implements a number of parameters that are specific to the MarCCD detectors.

The interface to the detector is via a TCP/IP socket interface to the marccd_server_socket server that MarUSA provides. The marccd_server_socket program must be started before @@ -67,6 +67,9 @@ remote_mode_server_arguments 2222 reads these disk files in order to read the data, because marccd does not provide another mechanism to access the data.

+

+ This driver inherits from ADDriver. The + marCCD class documentation describes this class in detail.

Implementation of standard driver parameters

@@ -77,8 +80,8 @@ remote_mode_server_arguments 2222 - Implementation of Parameters in ADStdDriverParams.h and EPICS Record Definitions - in ADBase.template and NDFile.template + Implementation of Parameters in asynNDArrayDriver.h and ADDriver.h, and EPICS Record + Definitions in ADBase.template and NDFile.template @@ -139,7 +142,7 @@ remote_mode_server_arguments 2222 - ADFilePath + NDFilePath $(P$(R)FilePath @@ -150,7 +153,7 @@ remote_mode_server_arguments 2222 - ADFileFormat + NDFileFormat $(P)$(R)FileFormat @@ -167,9 +170,9 @@ remote_mode_server_arguments 2222

MarCCD specific parameters

- The MarCCD driver implements the following parameters in addition to those in ADStdDriverParams.h. - Note that to reduce the width of this table the enum names have been split into - 2 lines, but these are just a single name, for example marCCDState. + The MarCCD driver implements the following parameters in addition to those in asynNDArrayDriver.h + and ADDriver.h. Note that to reduce the width of this table the enum names have + been split into 2 lines, but these are just a single name, for example marCCDState.

@@ -525,9 +528,9 @@ remote_mode_server_arguments 2222 + Detector two-theta angle (deg); ignored if empty string; requires theta axis definition + with display name "TwoTheta" in marccd configuration file (e.g. "theta_display_name + TwoTheta")
r/w - Detector two-theta angle (deg); ignored if empty string; requires theta axis - definition with display name "TwoTheta" in marccd configuration file (e.g. - "theta_display_name TwoTheta") MAR_TWO_THETA @@ -618,145 +621,29 @@ remote_mode_server_arguments 2222
  • Trigger mode (ADTriggerMode)
  • Gain (ADGain)
  • Region to read out (ADMinX, ADMinY, ADSizeX, ADSizeY, ADReverseX, ADReverseY)
    • -
  • Data type (ADDataType)
    • -
  • Reading previous files (ADReadFile)
    • -
  • Capture or stream file saving (ADFileWriteMode, ADFileCapture, ADNumCapture, ADNumCaptured)
    • +
  • Data type (NDDataType)
    • +
  • Reading previous files (NDReadFile)
    • +
  • Capture or stream file saving (NDFileWriteMode, NDFileCapture, NDNumCapture, NDNumCaptured)
    • -

    +

    Configuration

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

    - 
       
-marCCDConfig(const char *portName, const char *marCCDPort, 
-             int maxBuffers, size_t maxMemory);
+    The marCCD driver is created with the marCCDConfig command, either from C/C++ or
+    from the EPICS IOC shell.
    
+  
    int marCCDConfig(const char *portName, const char *serverPort,
+                 int maxBuffers, size_t maxMemory,
+                 int priority, int stackSize)
   
    
-  
-    
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-    
-  
    
-          Argument
-          Description
    
-          portName
-          The name of the asyn port for this detector.
-        
    
-          marCCDPort
-          The name of the asyn TCP/IP port to communicate with marccd_server_socket. This
-          must have been previously created with drvAsynIPPortConfig(),
-        
    
-          maxBuffers
-          Maximum number of buffers to be created for plugin callbacks. Passed to the constructor
-          for the ADDriver base class.
    
-          maxMemory
-          Maximum number of bytes of memory to be allocated for plugin callbacks. Passed to
-          the constructor for the ADDriver base class.
    
   
    
-    The following is an example st.cmd startup script:
+    For details on the meaning of the parameters to this function refer to the detailed
+    documentation on the mar345Config function in the 
+      marCCD.cpp documentation and in the documentation for the constructor for
+    the marCCD class.
+  
    
+  
    
+    There an example IOC boot directory and startup script (iocBoot/iocMARCCD/st.cmd)
+    provided with areaDetector.
   
    
-  
    < envPaths
-errlogInit(20000)
-
-dbLoadDatabase("$(AREA_DETECTOR)/dbd/marCCDApp.dbd")
-marCCDApp_registerRecordDeviceDriver(pdbbase) 
-
-###
-# Create the asyn port to talk to the MAR on port 2222
-drvAsynIPPortConfigure("marServer","gse-marccd1.cars.aps.anl.gov:2222")
-# Set the input and output terminators.
-asynOctetSetInputEos("marServer", 0, "\n")
-asynOctetSetOutputEos("marServer", 0, "\n")
-#asynSetTraceMask("marServer",0,9)
-asynSetTraceIOMask("marServer",0,2)
-
-marCCDConfig("MAR", "marServer", 20, 200000000)
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/ADBase.template",  "P=13MARCCD1:,R=cam1:,PORT=MAR,ADDR=0,TIMEOUT=1")
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/marCCD.template","P=13MARCCD1:,R=cam1:,PORT=MAR,ADDR=0,TIMEOUT=1,MARSERVER_PORT=marServer")
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/NDFile.template","P=13MARCCD1:,R=cam1:,PORT=MAR,ADDR=0,TIMEOUT=1")
-
-# Create a standard arrays plugin
-drvNDStdArraysConfigure("MARImage", 5, 0, "MAR", 0, -1)
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/NDPluginBase.template","P=13MARCCD1:,R=image1:,PORT=MARImage,ADDR=0,TIMEOUT=1,NDARRAY_PORT=MAR,NDARRAY_ADDR=0")
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/NDStdArrays.template", "P=13MARCCD1:,R=image1:,PORT=MARImage,ADDR=0,TIMEOUT=1,SIZE=16,FTVL=SHORT,NELEMENTS=1200000")
-
-# Create an ROI plugin
-drvNDROIConfigure("MARROI", 5, 0, "MAR", 0, 10, 20, -1)
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/NDPluginBase.template","P=13MARCCD1:,R=ROI1:,  PORT=MARROI,ADDR=0,TIMEOUT=1,NDARRAY_PORT=MAR,NDARRAY_ADDR=0")
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/NDROI.template",       "P=13MARCCD1:,R=ROI1:,  PORT=MARROI,ADDR=0,TIMEOUT=1")
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/NDROIN.template",      "P=13MARCCD1:,R=ROI1:0:,PORT=MARROI,ADDR=0,TIMEOUT=1,HIST_SIZE=256")
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/NDROIN.template",      "P=13MARCCD1:,R=ROI1:1:,PORT=MARROI,ADDR=1,TIMEOUT=1,HIST_SIZE=256")
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/NDROIN.template",      "P=13MARCCD1:,R=ROI1:2:,PORT=MARROI,ADDR=2,TIMEOUT=1,HIST_SIZE=256")
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/NDROIN.template",      "P=13MARCCD1:,R=ROI1:3:,PORT=MARROI,ADDR=3,TIMEOUT=1,HIST_SIZE=256")
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/NDROIN.template",      "P=13MARCCD1:,R=ROI1:4:,PORT=MARROI,ADDR=3,TIMEOUT=1,HIST_SIZE=256")
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/NDROIN.template",      "P=13MARCCD1:,R=ROI1:5:,PORT=MARROI,ADDR=3,TIMEOUT=1,HIST_SIZE=256")
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/NDROIN.template",      "P=13MARCCD1:,R=ROI1:6:,PORT=MARROI,ADDR=3,TIMEOUT=1,HIST_SIZE=256")
-dbLoadRecords("$(AREA_DETECTOR)/ADApp/Db/NDROIN.template",      "P=13MARCCD1:,R=ROI1:7:,PORT=MARROI,ADDR=3,TIMEOUT=1,HIST_SIZE=256")
-
-# Create "fastSweep" drivers for the MCA record to do on-the-fly scanning of ROI data
-initFastSweep("MARSweepTotal", "MARROI", 8, 2048, "TOTAL_ARRAY", "CALLBACK_PERIOD")
-initFastSweep("MARSweepNet", "MARROI", 8, 2048, "NET_ARRAY", "CALLBACK_PERIOD")
-
-# Load MCA records for the fast sweep drivers
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:0:TotalArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepTotal 0)")
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:1:TotalArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepTotal 1)")
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:2:TotalArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepTotal 2)")
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:3:TotalArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepTotal 3)")
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:4:TotalArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepTotal 4)")
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:5:TotalArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepTotal 5)")
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:6:TotalArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepTotal 6)")
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:7:TotalArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepTotal 7)")
-
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:0:NetArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepNet 0)")
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:1:NetArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepNet 1)")
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:2:NetArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepNet 2)")
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:3:NetArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepNet 3)")
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:4:NetArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepNet 4)")
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:5:NetArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepNet 5)")
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:6:NetArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepNet 6)")
-dbLoadRecords("$(MCA)/mcaApp/Db/mca.db", "P=13MARCCD1:,M=ROI1:7:NetArray,DTYP=asynMCA,NCHAN=2048,INP=@asyn(MARSweepNet 7)")
-
-
-#asynSetTraceMask("MARROI",0,3)
-#asynSetTraceIOMask("MARROI",0,4)
-
-# Load scan records
-dbLoadRecords("$(SSCAN)/sscanApp/Db/scan.db", "P=13MARCCD1:,MAXPTS1=2000,MAXPTS2=200,MAXPTS3=20,MAXPTS4=10,MAXPTSH=10")
-
-set_requestfile_path("./")
-set_savefile_path("./autosave")
-set_requestfile_path("$(AREA_DETECTOR)/ADApp/Db")
-set_requestfile_path("$(SSCAN)/sscanApp/Db")
-set_pass0_restoreFile("auto_settings.sav")
-set_pass1_restoreFile("auto_settings.sav")
-save_restoreSet_status_prefix("13MARCCD1:")
-dbLoadRecords("$(AUTOSAVE)/asApp/Db/save_restoreStatus.db", "P=13MARCCD1:")
-
-iocInit()
-
-# save things every thirty seconds
-create_monitor_set("auto_settings.req", 30,"P=13MARCCD1:,D=cam1:")
-
-
    
   
    
     MEDM screens
    
   
    
@@ -960,8 +847,7 @@ create_monitor_set("auto_settings.req", 30,"P=13MARCCD1:,D=cam1:")
       default. The areaDetector driver can only read TIFF files, not other formats. 
     
  • The areaDetector driver can in principle be run on machines other than the Linux
       machine running marccd, since the connection is via a socket. It has only been tested
-      on Linux, because it requires libtiff and this is not normally installed, for example,
-      on Windows.
    • 
+      on Linux.
     
  • The MarCCD driver keeps retrying to read each TIFF file until the modification
       date of the TIFF file is after the time that the exposure command was issued.
       If it did not do this check then it could be reading and displaying old files that