diff --git a/documentation/andorDoc.html b/documentation/andorDoc.html new file mode 100755 index 0000000..ad74dfd --- /dev/null +++ b/documentation/andorDoc.html @@ -0,0 +1,377 @@ + + + + areaDetector Andor driver + + + +
+

+ areaDetector Andor driver

+

+ January 7, 2012

+

+ Matthew Pearson, Diamond Light Source

+

+ Mark Rivers, University of Chicago

+
+

+ Table of Contents

+ +

+ Introduction

+

+ This is an EPICS + areaDetector driver for CCD and CMOS detectors from Andor Technology. + It has been tested on the Andor iKon CCD cameras with USB interface, but should work with other cameras as well.

+

+ The driver currently provides the following features:

+ + +

+ 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 Andor detectors. The + Andor class documentation describes this class in detail.

+

+ Implementation of standard driver parameters

+

+ The following table describes how the Andor driver implements some of the + standard driver parameters. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Implementation of Parameters in asynNDArrayDriver.h and ADDriver.h, and EPICS Record + Definitions in ADBase.template and NDFile.template
+ Parameter index variable + EPICS record name + Description
+ ADTriggerMode + $(P)$(R)TriggerMode
+ $(P)$(R)TriggerMode_RBV		 + Sets the trigger mode for the detector. Options are: +
    +
  • Internal
    • +
  • External
    • +
+ This has not yet been tested. +
+ ADImageMode + $(P)$(R)ImageMode
+ $(P)$(R)ImageMode_RBV		 + Sets the trigger mode for the detector. Options are: +
    +
  • Single
    • +
  • Multiple (accumulate)
    • +
  • Continuous (not supported yet)
    • +
+
+ ADNumImages + $(P)$(R)NumImages
+ $(P)$(R)NumImages_RBV		 + Set the number of images to take in multiple (accumulate) mode +
+ ADTemperature + $(P)$(R)Temperature
+ $(P)$(R)Temperature_RBV		 + Set and read the operating temperature of the CCD (-120C to 20C) +
+ + +

+ Andor specific parameters

+

+ The Andor driver implements the following parameters in addition to those + in asynNDArrayDriver.h and ADDriver.h. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Parameter Definitions in andorCCD.h and EPICS Record Definitions in andorCCD.template +
+ Parameter index variable + asyn interface + Access + Description + drvInfo string + EPICS record name + EPICS record type
AndorCoolerParamasynInt32R/WTurn the CCD cooler on and offANDOR_COOLERAndorCooler
+ AndorCooler_RBV		bo
+ bi
AndorShutdownParamasynInt32R/WWrite a 1 to this PV to shutdown the CCD and the driver cleanly. This must be done before rebooting the IOC.ANDOR_SHUTDOWNAndorShutdownbo
AndorStartupParamasynInt32R/WWrite a 1 to this PV to reinitialize the Andor software.ANDOR_STARTUPAndorStartupbo
AndorImageModeAMultiParamasynInt32R/WSelects the Andor imaging mode. Choices are: +
    +
  • Accumulate
    • +
  • Kinetics
    • +
  • Fast Kintetics
    • +
ANDOR_IMAGE_MODE_AMAndorImageModembbo
AndorACTInKineticsParamasynFloat64R/WAccumulated cycle time in kinetics mode.ANDOR_ACT_KINETICSAndorACTInKineticsao
AndorANumInKineticsParamasynInt32R/WNumber of accumulations in kinetics mode.ANDOR_ANUM_KINETICSAndorANumInKineticsao
AndorFKHeightParamasynInt32R/WHeight of the region in Fast Kinetics mode.ANDOR_FK_HEIGHTAndorFKHeightao
AndorFKHBinningParamasynInt32R/WHorizontal binning of the region in Fast Kinetics mode.ANDOR_FKH_BINNINGAndorFKHBinningao
AndorFKVBinningParamasynInt32R/WVertical binning of the region in Fast Kinetics mode.ANDOR_FKV_BINNINGAndorFKVBinningao
AndorFKOffsetParamasynInt32R/WOffset in Fast Kinetics mode.ANDOR_FK_OFFSETAndorFKOffsetao
AndorTempStatusMessageasynOctetR/OTemperature status message.ANDOR_TEMP_STATAndorTempStatus_RBVwaveform
AndorMessageasynOctetR/OOther status message.ANDOR_MESSAGEAndorMessage_RBVwaveform
AndorShutterModeasynInt32R/WSelects the Andor shutter mode. Choices are: +
    +
  • Auto
    • +
  • Open
    • +
ANDOR_SHUTTER_MODEAndorShutterModembbo
AndorShutterExTTLasynInt32R/WSelects the TTL polarity of an external shutter. Choices are: +
    +
  • Low To Open
    • +
  • High To Open
    • +
ANDOR_SHUTTER_EXTTLAndorShutterExTTLbo
AndorFileFormatasynInt32R/WSelects the file format for save files with the Andor driver. Choices are: +
    +
  • TIFF
    • +
  • BMP
    • +
  • SIF
    • +
  • EDF
    • +
  • RAW
    • +
  • TEXT
    • +
+ NOTE: Currently only TIFF is supported.		ANDOR_FILE_FORMATAndorFileFormatmbbo
AndorPALFileNameasynOctetR/WPath and Filename of pallette file (used for TIFF file colours) (255 chars max).ANDOR_PAL_FILE_PATHPALFilePathwaveform
AndorAdcSpeedasynInt32R/WSwitch between the slow (low noise) ADC and the fast ADC. Choices are: +
    +
  • 0.05 MHz
    • +
  • 2.5 MHz
    • +
ANDOR_ADC_SPEEDAndorADCSpeed
+ AndorADCSpeed_RBV		mbbo
+ mbbi
+ + +

+ Usage

+

+Always use channel access put callback when setting parameters.

+

+If any of the parameters set are out of range or fail in some way, then the PV will be put into alarm state. +This should be checked after every PV set.

+

+An example palette file for a TIFF file is GREY.PAL in the iocAndor directory.

+ +

+ Andor CCD information and user manual

+

+file:///dls_sw/work/R3.14.8.2/support/andorCCD/etc/private/iKon-M_Manual.pdf

+

+file:///dls_sw/work/R3.14.8.2/support/andorCCD/etc/private/Software_Development_Kit_V2.81.pdf (for developers only)

+ +

+ Future plans

+ + +