From 83ec7cb0a77c05a301c72062c4f734a726d0cd25 Mon Sep 17 00:00:00 2001 From: rivers Date: Mon, 23 Jan 2012 21:06:34 +0000 Subject: [PATCH] Updated and reformatted with VS2008 git-svn-id: https://subversion.xor.aps.anl.gov/synApps/areaDetector/trunk@14378 dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b --- documentation/andorDoc.html | 456 +++++++++++++++++++++++------------- 1 file changed, 287 insertions(+), 169 deletions(-) diff --git a/documentation/andorDoc.html b/documentation/andorDoc.html index ad74dfd..4c53d4c 100755 --- a/documentation/andorDoc.html +++ b/documentation/andorDoc.html @@ -31,20 +31,20 @@ 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.

+ 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:

- - + The driver currently provides the following features:

+

This driver inherits from ADDriver. It implements many of the parameters in @@ -55,8 +55,8 @@

Implementation of standard driver parameters

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

@@ -85,8 +85,7 @@
  • Internal
  • External
    • - This has not yet been tested. - + This has not yet been tested. + Set the number of images to take in multiple (accumulate) mode + Set and read the operating temperature of the CCD (-120C to 20C)
    @@ -110,8 +109,7 @@ $(P)$(R)NumImages
    $(P)$(R)NumImages_RBV    		 - Set the number of images to take in multiple (accumulate) mode -
    @@ -120,18 +118,15 @@ $(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. + The Andor driver implements the following parameters in addition to those in asynNDArrayDriver.h + and ADDriver.h.

    @@ -157,151 +152,257 @@ EPICS record type - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - - - + + + - - - + + + + + - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - - - + + + - - - + + + + + - - - - + + + - - - + + + + + - - - - + + + - - - + + NOTE: Currently only TIFF is supported. + + + - - - - - - - + + + + + + + - - - - + + + - - - + + + + +
    AndorCoolerParamasynInt32R/WTurn the CCD cooler on and offANDOR_COOLERAndorCooler
    - AndorCooler_RBV    		bo
    - bi    		 + AndorCoolerParam + asynInt32 + R/W + Turn the CCD cooler on and off + ANDOR_COOLER + AndorCooler
    + 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 + AndorShutdownParam + asynInt32 + R/W + Write a 1 to this PV to shutdown the CCD and the driver cleanly. This must be done + before rebooting the IOC. + ANDOR_SHUTDOWN + AndorShutdown + bo
    AndorStartupParamasynInt32R/WWrite a 1 to this PV to reinitialize the Andor software.ANDOR_STARTUPAndorStartupbo + AndorStartupParam + asynInt32 + R/W + Write a 1 to this PV to reinitialize the Andor software. + ANDOR_STARTUP + AndorStartup + bo
    AndorImageModeAMultiParamasynInt32R/WSelects the Andor imaging mode. Choices are: + + AndorImageModeAMultiParam + asynInt32 + R/W + Selects the Andor imaging mode. Choices are:
    • Accumulate
    • Kinetics
    • Fast Kintetics
      • -
    		ANDOR_IMAGE_MODE_AMAndorImageModembbo + ANDOR_IMAGE_MODE_AM + AndorImageMode + mbbo
    AndorACTInKineticsParamasynFloat64R/WAccumulated cycle time in kinetics mode.ANDOR_ACT_KINETICSAndorACTInKineticsao + AndorACTInKineticsParam + asynFloat64 + R/W + Accumulated cycle time in kinetics mode. + ANDOR_ACT_KINETICS + AndorACTInKinetics + ao
    AndorANumInKineticsParamasynInt32R/WNumber of accumulations in kinetics mode.ANDOR_ANUM_KINETICSAndorANumInKineticsao + AndorANumInKineticsParam + asynInt32 + R/W + Number of accumulations in kinetics mode. + ANDOR_ANUM_KINETICS + AndorANumInKinetics + ao
    AndorFKHeightParamasynInt32R/WHeight of the region in Fast Kinetics mode.ANDOR_FK_HEIGHTAndorFKHeightao + AndorFKHeightParam + asynInt32 + R/W + Height of the region in Fast Kinetics mode. + ANDOR_FK_HEIGHT + AndorFKHeight + ao
    AndorFKHBinningParamasynInt32R/WHorizontal binning of the region in Fast Kinetics mode.ANDOR_FKH_BINNINGAndorFKHBinningao + AndorFKHBinningParam + asynInt32 + R/W + Horizontal binning of the region in Fast Kinetics mode. + ANDOR_FKH_BINNING + AndorFKHBinning + ao
    AndorFKVBinningParamasynInt32R/WVertical binning of the region in Fast Kinetics mode.ANDOR_FKV_BINNINGAndorFKVBinningao + AndorFKVBinningParam + asynInt32 + R/W + Vertical binning of the region in Fast Kinetics mode. + ANDOR_FKV_BINNING + AndorFKVBinning + ao
    AndorFKOffsetParamasynInt32R/WOffset in Fast Kinetics mode.ANDOR_FK_OFFSETAndorFKOffsetao + AndorFKOffsetParam + asynInt32 + R/W + Offset in Fast Kinetics mode. + ANDOR_FK_OFFSET + AndorFKOffset + ao
    AndorTempStatusMessageasynOctetR/OTemperature status message.ANDOR_TEMP_STATAndorTempStatus_RBVwaveform + AndorTempStatusMessage + asynOctet + R/O + Temperature status message. + ANDOR_TEMP_STAT + AndorTempStatus_RBV + waveform
    AndorMessageasynOctetR/OOther status message.ANDOR_MESSAGEAndorMessage_RBVwaveform + AndorMessage + asynOctet + R/O + Other status message. + ANDOR_MESSAGE + AndorMessage_RBV + waveform
    AndorShutterModeasynInt32R/WSelects the Andor shutter mode. Choices are: + + AndorShutterMode + asynInt32 + R/W + Selects the Andor shutter mode. Choices are:
    • Auto
    • Open
      • -
    		ANDOR_SHUTTER_MODEAndorShutterModembbo + ANDOR_SHUTTER_MODE + AndorShutterMode + mbbo
    AndorShutterExTTLasynInt32R/WSelects the TTL polarity of an external shutter. Choices are: + + AndorShutterExTTL + asynInt32 + R/W + Selects the TTL polarity of an external shutter. Choices are:
    • Low To Open
    • High To Open
      • -
    		ANDOR_SHUTTER_EXTTLAndorShutterExTTLbo + ANDOR_SHUTTER_EXTTL + AndorShutterExTTL + bo
    AndorFileFormatasynInt32R/WSelects the file format for save files with the Andor driver. Choices are: + + AndorFileFormat + asynInt32 + R/W + Selects the file format for save files with the Andor driver. Choices are:
    • TIFF
    • BMP
      • @@ -309,57 +410,74 @@
    • EDF
    • RAW
    • TEXT
      • -
    - NOTE: Currently only TIFF is supported.    		ANDOR_FILE_FORMATAndorFileFormatmbbo + ANDOR_FILE_FORMAT + AndorFileFormat + mbbo
    AndorPALFileNameasynOctetR/WPath and Filename of pallette file (used for TIFF file colours) (255 chars max).ANDOR_PAL_FILE_PATHPALFilePathwaveform + AndorPALFileName + asynOctet + R/W + Path and Filename of pallette file (used for TIFF file colours) (255 chars max). + + ANDOR_PAL_FILE_PATH + PALFilePath + waveform
    AndorAdcSpeedasynInt32R/WSwitch between the slow (low noise) ADC and the fast ADC. Choices are: + + AndorAdcSpeed + asynInt32 + R/W + Switch 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    		 + ANDOR_ADC_SPEED + AndorADCSpeed
    + 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.

    - +

    + 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)

    - +

    + 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