/home/epics/devel/areaDetector/1-5/ADApp/ADSrc/ADDriver.h File Reference

#include <epicsTypes.h>
#include <epicsMessageQueue.h>
#include <epicsTime.h>
#include <asynStandardInterfaces.h>
#include "asynNDArrayDriver.h"

Go to the source code of this file.

Classes

class  ADDriver
 Class from which areaDetector drivers are directly derived. More...

Defines

#define AREA_DETECTOR_OK   0
 Success code; generally asyn status codes are used instead where possible.
#define AREA_DETECTOR_ERROR   -1
 Failure code; generally asyn status codes are used instead where possible.

Enumerations

enum  ADShutterStatus_t { ADShutterClosed, ADShutterOpen }
 Enumeration of shutter status. More...
enum  ADShutterMode_t { ADShutterModeNone, ADShutterModeEPICS, ADShutterModeDetector }
 Enumeration of shutter modes. More...
enum  ADStatus_t {
  ADStatusIdle, ADStatusAcquire, ADStatusReadout, ADStatusCorrect,
  ADStatusSaving, ADStatusAborting, ADStatusError, ADStatusWaiting
}
 Enumeration of detector status. More...
enum  ADImageMode_t { ADImageSingle, ADImageMultiple, ADImageContinuous }
 Enumeration of image collection modes. More...
enum  ADFrameType_t { ADFrameNormal, ADFrameBackground, ADFrameFlatField, ADFrameDoubleCorrelation }
enum  ADTriggerMode_t { ADTriggerInternal, ADTriggerExternal }
enum  ADStdDriverParam_t {
  ADManufacturer = NDLastStdParam, ADModel, ADGain, ADBinX,
  ADBinY, ADMinX, ADMinY, ADSizeX,
  ADSizeY, ADMaxSizeX, ADMaxSizeY, ADReverseX,
  ADReverseY, ADFrameType, ADImageMode, ADTriggerMode,
  ADNumExposures, ADNumImages, ADAcquireTime, ADAcquirePeriod,
  ADStatus, ADAcquire, ADShutterControl, ADShutterControlEPICS,
  ADShutterStatus, ADShutterMode, ADShutterOpenDelay, ADShutterCloseDelay,
  ADTemperature, ADNumImagesCounter, ADNumExposuresCounter, ADTimeRemaining,
  ADReadStatus, ADStatusMessage, ADStringToServer, ADStringFromServer,
  ADLastStdParam
}
 Enumeration of parameters that affect the behaviour of the detector. More...


Define Documentation

#define AREA_DETECTOR_ERROR   -1

Failure code; generally asyn status codes are used instead where possible.

#define AREA_DETECTOR_OK   0

Success code; generally asyn status codes are used instead where possible.


Enumeration Type Documentation

Enumerator:
ADFrameNormal  Normal frame type.
ADFrameBackground  Background frame type.
ADFrameFlatField  Flat field (no sample) frame type.
ADFrameDoubleCorrelation  Double correlation frame type, used to remove zingers.

Enumeration of image collection modes.

Enumerator:
ADImageSingle  Collect a single image per Acquire command.
ADImageMultiple  Collect ADNumImages images per Acquire command.
ADImageContinuous  Collect images continuously until Acquire is set to 0.

Enumeration of shutter modes.

Enumerator:
ADShutterModeNone  Don't use shutter.
ADShutterModeEPICS  Shutter controlled by EPICS PVs.
ADShutterModeDetector  Shutter controlled directly by detector.

Enumeration of shutter status.

Enumerator:
ADShutterClosed  Shutter closed.
ADShutterOpen  Shutter open.

enum ADStatus_t

Enumeration of detector status.

Enumerator:
ADStatusIdle  Detector is idle.
ADStatusAcquire  Detector is acquiring.
ADStatusReadout  Detector is reading out.
ADStatusCorrect  Detector is correcting data.
ADStatusSaving  Detector is saving data.
ADStatusAborting  Detector is aborting an operation.
ADStatusError  Detector has encountered an error.
ADStatusWaiting  Detector is waiting for something, typically for the acquire period to elapse.

Enumeration of parameters that affect the behaviour of the detector.

These are the values that asyn will place in pasynUser->reason when the standard asyn interface methods are called.

Enumerator:
ADManufacturer  (asynOctet, r/o) Detector manufacturer name
ADModel  (asynOctet, r/o) Detector model name
ADGain  (asynFloat64, r/w) Gain
ADBinX  (asynInt32, r/w) Binning in the X direction
ADBinY  (asynInt32, r/w) Binning in the Y direction
ADMinX  (asynInt32, r/w) First pixel in the X direction; 0 is the first pixel on the detector
ADMinY  (asynInt32, r/w) First pixel in the Y direction; 0 is the first pixel on the detector
ADSizeX  (asynInt32, r/w) Size of the region to read in the X direction
ADSizeY  (asynInt32, r/w) Size of the region to read in the Y direction
ADMaxSizeX  (asynInt32, r/o) Maximum (sensor) size in the X direction
ADMaxSizeY  (asynInt32, r/o) Maximum (sensor) size in the Y direction
ADReverseX  (asynInt32, r/w) Reverse image in the X direction (0=No, 1=Yes)
ADReverseY  (asynInt32, r/w) Reverse image in the Y direction (0=No, 1=Yes)
ADFrameType  (asynInt32, r/w) Frame type (ADFrameType_t)
ADImageMode  (asynInt32, r/w) Image mode (ADImageMode_t)
ADTriggerMode  (asynInt32, r/w) Trigger mode (ADTriggerMode_t)
ADNumExposures  (asynInt32, r/w) Number of exposures per image to acquire
ADNumImages  (asynInt32, r/w) Number of images to acquire in one acquisition sequence
ADAcquireTime  (asynFloat64, r/w) Acquisition time per image
ADAcquirePeriod  (asynFloat64, r/w) Acquisition period between images
ADStatus  (asynInt32, r/o) Acquisition status (ADStatus_t)
ADAcquire  (asynInt32, r/w) Start(1) or Stop(0) acquisition
ADShutterControl  (asynInt32, r/w) (ADShutterStatus_t) Open (1) or Close(0) shutter
ADShutterControlEPICS  (asynInt32, r/o) (ADShutterStatus_t) Open (1) or Close(0) EPICS shutter
ADShutterStatus  (asynInt32, r/o) (ADShutterStatus_t) Shutter Open (1) or Closed(0)
ADShutterMode  (asynInt32, r/w) (ADShutterMode_t) Use EPICS or detector shutter
ADShutterOpenDelay  (asynFloat64, r/w) Time for shutter to open
ADShutterCloseDelay  (asynFloat64, r/w) Time for shutter to close
ADTemperature  (asynFloat64, r/w) Detector temperature
ADNumImagesCounter  (asynInt32, r/o) Number of images collected in current acquisition sequence
ADNumExposuresCounter  (asynInt32, r/o) Number of exposures collected for current image
ADTimeRemaining  (asynFloat64, r/o) Acquisition time remaining
ADReadStatus  (asynInt32, r/w) Write 1 to force a read of detector status
ADStatusMessage  (asynOctet, r/o) Status message
ADStringToServer  (asynOctet, r/o) String sent to server for message-based drivers
ADStringFromServer  (asynOctet, r/o) String received from server for message-based drivers
ADLastStdParam  The last standard driver parameter; Drivers must begin their detector-specific parameter enums with this value.

Enumerator:
ADTriggerInternal  Internal trigger from detector.
ADTriggerExternal  External trigger input.


Generated on Tue Aug 25 16:53:03 2009 for areaDetector by  doxygen 1.5.7.1