diff --git a/documentation/MarCCDDoc.html b/documentation/MarCCDDoc.html index 5b8d585..aa2b3ad 100755 --- a/documentation/MarCCDDoc.html +++ b/documentation/MarCCDDoc.html @@ -7,7 +7,7 @@

areaDetector MarCCD driver

- November 18, 2008

+ November 24, 2008

Mark Rivers

@@ -40,26 +40,23 @@

marccd must be using Version 1 of the remote protocol. This is normally done done by editing the file marccd/configuration/marccd.conf and replacing the line

-
-include marccd_server_v0.conf
+  
include marccd_server_v0.conf
     

with

-
-include marccd_server_v1.conf
+  
include marccd_server_v1.conf
     

The file marccd_server_v1.conf should contain the lines:

-
-remote_mode_server_command /home/marccd/contrib/marccd_server/marccd_server_socket
+  
remote_mode_server_command /home/marccd/contrib/marccd_server/marccd_server_socket
 remote_mode_server_arguments 2222
     

The first line points to the location of the marccd_server_socket program that is used to implement remote control. In order to work with the areaDetector driver this must be a version of this program created after November 11, 2008 when support - for the get_frameshift command was added. A recent version of this program can - be downloaded from the + for the get_frameshift command was added. A recent version of this + program can be downloaded from the Rayonix FTP site.

@@ -77,8 +74,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 ADStdDriverParams.h and EPICS Record Definitions + in ADBase.template and NDFile.template @@ -98,8 +95,8 @@ remote_mode_server_arguments 2222 from ADStdDriverParams.h. The choices for the MarCCD are:

  • Normal (corrected data frame without double correlation)
  • -
  • Background (background frame with 0 exposure time, done with double correlation to remove - zingers)
  • +
  • Background (background frame with 0 exposure time, done with double correlation + to remove zingers)
  • Raw (data frame without correction for background or spatial distortion)
  • DblCorrelation (two images each collected for half the nominal acquisition time, zingers removed by double correlation)
  • @@ -136,14 +133,14 @@ remote_mode_server_arguments 2222 be used to make the paths look identical. + + ADFileFormat + + $(P)$(R)FileFormat + + marccd only supports TIFF files. + - - ADFileFormat - - $(P)$(R)FileFormat - - marccd only supports TIFF files. -

    @@ -383,8 +380,8 @@ remote_mode_server_arguments 2222 that restricts the x-rays to horizontal stripe. An exposure is made, and then an external signal causes the detector to shift the image by the number of lines given by this parameter. A number of images separated by times of a few milliseconds can - be collected, and then the detector is read out. Set this parameter to 0 to - disable frameshift mode. + be collected, and then the detector is read out. Set this parameter to 0 to disable + frameshift mode. MAR_FRAME_SHIFT @@ -549,8 +546,9 @@ remote_mode_server_arguments 2222

    Unsupported standard driver parameters

    -

    The MarCCD driver does not support the following standard driver parameters because - they are not supported in the marccd program: +

    + The MarCCD driver does not support the following standard driver parameters because + they are not supported in the marccd program:

    • Number of exposures per image (ADNumExposures)
    • Trigger mode (ADTriggerMode)
    • @@ -558,8 +556,7 @@ remote_mode_server_arguments 2222
    • 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)
    • +
    • Capture or stream file saving (ADFileWriteMode, ADFileCapture, ADNumCapture, ADNumCaptured)

    Configuration

    @@ -590,8 +587,8 @@ marCCDConfig(const char *portName, const char *marCCDPort, marCCDPort - The name of the asyn TCP/IP port to communicate with marccd_server_socket. This must have been - previously created with drvAsynIPPortConfig(), + The name of the asyn TCP/IP port to communicate with marccd_server_socket. This + must have been previously created with drvAsynIPPortConfig(), @@ -613,8 +610,7 @@ marCCDConfig(const char *portName, const char *marCCDPort,

    The following is an example st.cmd startup script:

    -
    -< envPaths
    +  
    < envPaths
     errlogInit(20000)
     
     dbLoadDatabase("$(AREA_DETECTOR)/dbd/marCCDApp.dbd")
    @@ -710,7 +706,6 @@ create_monitor_set("auto_settings.req", 30,"P=13MARCCD1:,D=cam1:")
         

    marccd.adl

    marCCD.png -

    marccdAncillary.adl is the screen used to input ancillary information that is written to the MarCCD TIFF files. @@ -727,8 +722,9 @@ create_monitor_set("auto_settings.req", 30,"P=13MARCCD1:,D=cam1:") asynRecord.adl

MarCCDAsynRecord.png

- asynOctet.adl can be used to send any command to the marccd remote server and display - the response. It can be loaded from the More menu in asynRecord.adl above.

+ asynOctet.adl can be used to send any command to the marccd remote + server and display the response. It can be loaded from the More menu in asynRecord.adl + above.

asynOctet.adl

@@ -737,10 +733,9 @@ create_monitor_set("auto_settings.req", 30,"P=13MARCCD1:,D=cam1:") Performance measurements

The following measurements were done to demonstrate the performance that can be - obtained with the areaDetector MarCCD driver. These measurements were made with a - MAR-165 CCD, with the EPICS IOC running on the same Linux machine as the marccd - program. The acquisition time was 1 second.

- + obtained with the areaDetector MarCCD driver. These measurements were made with + a MAR-165 CCD. The EPICS IOC was running on the same Linux machine as the marccd + program. The acquisition time was 1 second.

@@ -774,9 +769,11 @@ create_monitor_set("auto_settings.req", 30,"P=13MARCCD1:,D=cam1:") 4.00 @@ -816,9 +813,11 @@ create_monitor_set("auto_settings.req", 30,"P=13MARCCD1:,D=cam1:") 1.90 @@ -858,9 +857,11 @@ create_monitor_set("auto_settings.req", 30,"P=13MARCCD1:,D=cam1:") 1.40 @@ -885,15 +886,20 @@ create_monitor_set("auto_settings.req", 30,"P=13MARCCD1:,D=cam1:")
- Readout: 3.02
- Correct: 0.56
- Save: 0.20 + Readout: 3.02 +
+ Correct: 0.56 +
+ Save: 0.20
- Readout: 1.30
- Correct: 0.28
- Save: 0.06 + Readout: 1.30 +
+ Correct: 0.28 +
+ Save: 0.06
- Readout: 0.78
- Correct: 0.29
- Save: 0.06 + Readout: 0.78 +
+ Correct: 0.29 +
+ Save: 0.06
-

Restrictions

The following are some current restrictions of the MarCCD driver: