PerkinElmer.h

Go to the documentation of this file.

/* PerkinElmer.h
 *
 * This is a driver the PerkinElmer Image Plates
 *        Models:    XRD0820
 *                   XRF0822
 *
 *
 * Author: Brian Tieman
 *
 * Created:  07/24/2008
 *
 * Current author: Mark Rivers
 *
 */

#ifndef PERKINELMER_H
#define PERKINELMER_H

#include "ADDriver.h"

#include <windows.h>
#include "Acq.h"

//______________________________________________________________________________________________

static const char *driverName = "PerkinElmer";

//______________________________________________________________________________________________


typedef enum
{
  PE_ACQUIRE_ACQUISITION,
  PE_ACQUIRE_OFFSET,
  PE_ACQUIRE_GAIN
} PEAcquisitionMode_t;

// We add an additional mode to ADImageMode = PEImageAverage

typedef enum
{
  PEImageSingle     = ADImageSingle,
  PEImageMultiple   = ADImageMultiple,
  PEImageContinuous = ADImageContinuous,
  PEImageAverage
} PEImageMode_t;

typedef enum
{
  PE_INTERNAL_TRIGGER,
  PE_EXTERNAL_TRIGGER,
  PE_FREE_RUNNING,
  PE_SOFT_TRIGGER
} PETimingMode_t;

typedef enum
{
  PE_SYNC_DDD_CLEAR,
  PE_SYNC_DDD_NOCLEAR,
  PE_SYNC_LINEWISE,
  PE_SYNC_FRAMEWISE,
  PE_SYNC_AUTOTRIGGER
} PESyncMode_t;


//______________________________________________________________________________________________

class PerkinElmer;

class PerkinElmer : public ADDriver
{
public:
  PerkinElmer(const char *portName, int IDType, const char *IDValue, 
              int maxBuffers, size_t maxMemory,
              int priority, int stackSize);

  /* These are the methods that we override from ADDriver */
  virtual asynStatus writeInt32(asynUser *pasynUser, epicsInt32 value);
  virtual asynStatus writeFloat64(asynUser *pasynUser, epicsFloat64 value);
  void report(FILE *fp, int details);

  // These should really be private, but they are called from C so must be public
  void endFrameCallback(HACQDESC hAcqDesc);
  void endAcqCallback(HACQDESC hAcqDesc);
  void acquireStopTask(void);
  ~PerkinElmer();

protected:
  int PE_Initialize;
#define PE_FIRST_PARAM PE_Initialize
  int PE_CorrectionsDirectory;
  int PE_AcquireOffset;
  int PE_NumOffsetFrames;
  int PE_CurrentOffsetFrame;
  int PE_UseOffset;
  int PE_OffsetAvailable;
  int PE_OffsetConstant;
  int PE_AcquireGain;
  int PE_NumGainFrames;
  int PE_CurrentGainFrame;
  int PE_UseGain;
  int PE_GainAvailable;
  int PE_GainFile;
  int PE_LoadGainFile;
  int PE_SaveGainFile;
  int PE_UsePixelCorrection;
  int PE_PixelCorrectionAvailable;
  int PE_PixelCorrectionFile;
  int PE_LoadPixelCorrectionFile;
  int PE_Gain;
  int PE_NumFrameBuffers;
  int PE_Trigger;
  int PE_SyncMode;
  int PE_FrameBufferIndex;
  int PE_ImageNumber;
  int PE_SkipFrames;
  int PE_NumFramesToSkip;
  #define PE_LAST_PARAM PE_NumFramesToSkip


private:
  int           IDType_;
  char          *IDValue_;
  HACQDESC      hAcqDesc_;
  epicsEventId  acquireStopEvent_;
  epicsUInt16   *pAcqBuffer_;
  epicsUInt16   *pOffsetBuffer_;
  DWORD         *pGainBuffer_;
  epicsUInt16   *pBadPixelMap_;
  int           *pPixelCorrectionList_;
  unsigned int  uiNumFrameBuffers_;
  unsigned int  uiNumBuffersInUse_;
  int           iAcqMode_;
  // Keep a copy of parmeters for Acquistion_EnumSensors 
  unsigned int  uiNumSensors_;
  // Keep a copy of parmeters for Acquisition_GetCommChannel
  unsigned int  uiChannelType_;
  int           iChannelNum_;
  // Keep a copy of parmeters from Acquisition_GetConfiguration
  unsigned int  uiDevFrames_;
  unsigned int  uiRows_;
  unsigned int  uiColumns_;
  unsigned int  uiDataType_;
  unsigned int  uiSortFlags_;
  CHwHeaderInfo cHwHeaderInfo_;
  CHwHeaderInfoEx cHwHeaderInfoEx_;
  BOOL          bEnableIRQ_;
  DWORD         dwAcqType_;
  DWORD         dwSystemID_;
  DWORD         dwSyncMode_;
  DWORD         dwHwAccess_;
  DWORD         dwBoardType_;
  bool          acquireSettingsChanged_;
  bool          doSoftwareTriggers_; 

  bool initializeDetector (void);
  void setBinning(void);
  void reportSensors(FILE *fp, int details);

  void acquireSetup(void);
  void acquireStop(void);
  void acquireNormalImage(void);
  void acquireOffsetImage(void);
  void acquireGainImage(void);
  void doSoftwareTrigger(void);

  asynStatus loadGainFile(void);
  asynStatus saveGainFile(void);
  asynStatus loadPixelCorrectionFile();

  void reportXISStatus(int errorCode, const char *functionName, const char *formatString, ...);

};

//______________________________________________________________________________________________
#define PE_SystemIDString                   "PE_SYSTEMID"
#define PE_InitializeString                 "PE_INITIALIZE"
#define PE_CorrectionsDirectoryString       "PE_CORRECTIONS_DIRECTORY"
#define PE_AcquireOffsetString              "PE_ACQUIRE_OFFSET"
#define PE_NumOffsetFramesString            "PE_NUM_OFFSET_FRAMES"
#define PE_CurrentOffsetFrameString         "PE_CURRENT_OFFSET_FRAME"
#define PE_UseOffsetString                  "PE_USE_OFFSET"
#define PE_OffsetAvailableString            "PE_OFFSET_AVAILABLE"
#define PE_OffsetConstantString             "PE_OFFSET_CONSTANT"
#define PE_AcquireGainString                "PE_ACQUIRE_GAIN"
#define PE_NumGainFramesString              "PE_NUM_GAIN_FRAMES"
#define PE_CurrentGainFrameString           "PE_CURRENT_GAIN_FRAME"
#define PE_UseGainString                    "PE_USE_GAIN"
#define PE_GainAvailableString              "PE_GAIN_AVAILABLE"
#define PE_GainFileString                   "PE_GAIN_FILE"
#define PE_LoadGainFileString               "PE_LOAD_GAIN_FILE"
#define PE_SaveGainFileString               "PE_SAVE_GAIN_FILE"
#define PE_UsePixelCorrectionString         "PE_USE_PIXEL_CORRECTION"
#define PE_PixelCorrectionAvailableString   "PE_PIXEL_CORRECTION_AVAILABLE"
#define PE_PixelCorrectionFileString        "PE_PIXEL_CORRECTION_FILE"
#define PE_LoadPixelCorrectionFileString    "PE_LOAD_PIXEL_CORRECTION_FILE"
#define PE_GainString                       "PE_GAIN"
#define PE_NumFrameBuffersString            "PE_NUM_FRAME_BUFFERS"
#define PE_TriggerString                    "PE_TRIGGER"
#define PE_SyncModeString                   "PE_SYNC_MODE"
#define PE_FrameBufferIndexString           "PE_FRAME_BUFFER_INDEX"
#define PE_ImageNumberString                "PE_IMAGE_NUMBER"
#define PE_SkipFramesString                 "PE_SKIP_FRAMES"
#define PE_NumFramesToSkipString            "PE_NUM_FRAMES_TO_SKIP"

#define NUM_PERKIN_ELMER_PARAMS ((int)(&PE_LAST_PARAM - &PE_FIRST_PARAM + 1))
//______________________________________________________________________________________________

#endif