medipixDetector.h

Go to the documentation of this file.

/*
 * medipixDetector.h
 *
 *  Created on: 16 Oct 2013
 *      Author: hgv27681
 */

#ifndef MEDIPIXDETECTOR_H_
#define MEDIPIXDETECTOR_H_

#define MAX_MESSAGE_SIZE 256
#define MAX_FILENAME_LEN 256
#define MAX_BAD_PIXELS 100

#define ASYN_POLL_TIME .01
#define Labview_DEFAULT_TIMEOUT 2.0

#define FILE_READ_DELAY .01

#define DIMS 2

typedef enum
{
    Merlin, MedipixXBPM, UomXBPM, MerlinQuad
} medipixDetectorType;

typedef enum
{
    TMInternal,
    TMExternalEnable,
    TMExternalTriggerHigh,
    TMExternalTriggerLow,
    TMExternalTriggerRising,
    TMSoftwareTrigger
} medipixTriggerMode;
typedef enum
{
    MPXImageSingle,      
    MPXImageMultiple,    
    MPXImageContinuous,  
    MPXThresholdScan,
    MPXBackgroundCalibrate
} MPXImageMode_t;


typedef enum
{
    MPXQuadMode12Bit,
    MPXQuadMode24Bit,
    MPXQuadMode2Threshold,
    MPXQuadModeContinuousRW,
    MPXQuadModeColour,
    MPXQuadModeSumming
} MPXQuadMode_t;

#define TMTrigInternal  (char*)"0"
#define TMTrigRising    (char*)"1"
#define TMTrigFalling   (char*)"2"
#define TMTrigSoftware  (char*)"3"

#define medipixDelayTimeString              "DELAY_TIME"
#define medipixThreshold0String             "THRESHOLD0"
#define medipixThreshold1String             "THRESHOLD1"
#define medipixThreshold2String             "THRESHOLD2"
#define medipixThreshold3String             "THRESHOLD3"
#define medipixThreshold4String             "THRESHOLD4"
#define medipixThreshold5String             "THRESHOLD5"
#define medipixThreshold6String             "THRESHOLD6"
#define medipixThreshold7String             "THRESHOLD7"
#define medipixOperatingEnergyString        "OPERATINGENERGY"

#define medipixThresholdApplyString         "THRESHOLD_APPLY"
#define medipixThresholdAutoApplyString     "THRESHOLD_AUTO_APPLY"
#define medipixArmedString                  "ARMED"

#define medipixmedpixThresholdScanString    "THRESHOLDSCAN"
#define medipixStartThresholdScanString     "THRESHOLDSTART"
#define medipixStopThresholdScanString      "THRESHOLDSTOP"
#define medipixStepThresholdScanString      "THRESHOLDSTEP"
#define medipixStartThresholdScanningString "STARTTHRESHOLDSCANNING"
#define medipixCounterDepthString           "COUNTERDEPTH"
#define medipixResetString                  "RESET"
#define medipixSoftwareTriggerString        "SOFTWARETRIGGER"
#define medipixEnableCounter1String         "ENABLECOUNTER1"
#define medipixContinuousRWString           "CONTINUOUSRW"

// Medipix XBPM SPECIFIC
#define medipixProfileControlString         "PROFILECONTROL"
#define medipixProfileXString               "PROFILE_AVERAGE_X"
#define medipixProfileYString               "PROFILE_AVERAGE_Y"

// UoM BPM SPECIFIC
#define medipixEnableBackgroundCorrString   "ENABLEBACKGROUNDCORR"
#define medipixEnableImageSumString         "ENABLESUMAVERAGE"

// Medipix Quad
#define medipixQuadMerlinModeString         "QUADMERLINMODE"
#define medipixSelectGuiString              "SELECTGUI"

class mpxConnection;

class medipixDetector: public ADDriver
{
public:
    medipixDetector(const char *portName, const char *LabviewCmdPort,
            const char *LabviewDataPort, int maxSizeX, int maxSizeY,
            int detectorType, 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);
//    virtual asynStatus writeOctet(asynUser *pasynUser, const char *value,
//            size_t nChars, size_t *nActual);
    void report(FILE *fp, int details);
    void medipixTask(); /* This should be private but is called from C so must be public */
    void medipixStatus(); /* This should be private but is called from C so must be public */

    void fromLabViewStr(const char *str);
    void toLabViewStr(const char *str);

protected:
    int medipixDelayTime;
#define FIRST_medipix_PARAM medipixDelayTime
    int medipixThreshold0;
    int medipixThreshold1;
    int medipixThreshold2;
    int medipixThreshold3;
    int medipixThreshold4;
    int medipixThreshold5;
    int medipixThreshold6;
    int medipixThreshold7;
    int medipixOperatingEnergy;
    int medipixThresholdApply;
    int medipixThresholdAutoApply;
    int medipixArmed;
    int medipixThresholdScan;
    int medipixStartThresholdScan;
    int medipixStopThresholdScan;
    int medipixStepThresholdScan;
    int medipixTvxVersion;
    int medipixCounterDepth;
    int medipixSoftwareTrigger;
    int medipixReset;
    int medipixEnableCounter1;
    int medipixContinuousRW;
    int medipixProfileControl;
    int medipixProfileX;
    int medipixProfileY;
    int medipixEnableBackgroundCorr;
    int medipixEnableImageSum;
    int medipixQuadMerlinMode;
    int medipixSelectGui;

#define LAST_medipix_PARAM medipixSelectGui

private:
    /* These are the methods that are new to this class */
    void abortAcquisition();
    asynStatus SetQuadMode(int mode);
    asynStatus setModeCommands(int function);
    asynStatus setAcquireParams();
    asynStatus getThreshold();
    asynStatus updateThresholdScanParms();
    asynStatus setROI();

    NDArray* copyProfileToNDArray32(size_t *dims, char *buffer,
            int profileMask);
    NDArray* copyToNDArray16(size_t *dims, char *buffer, int offset);
    NDArray* copyToNDArray32(size_t *dims, char *buffer, int offset);
    inline void endian_swap(unsigned short& x);
    inline void endian_swap(unsigned int& x);
    inline void endian_swap(uint64_t& x);
    unsigned int maxSize[2];

    /* Our data */
    int imagesRemaining;
    NDArray *pFlatField;
    int multipleFileNumber;
    asynUser *pasynLabViewCmd;
    asynUser *pasynLabViewData;
    double averageFlatField;
    int framesPerAcquire;

    int *profileX;
    int *profileY;

    bool startingUp;  // used to avoid very chatty initialisation

    char LabviewCommandPortName[20];
    char LabviewDataPortName[20];

    medipixDetectorType detType;

    mpxConnection *cmdConnection;
    mpxConnection *dataConnection;
};

#define NUM_medipix_PARAMS (&LAST_medipix_PARAM - &FIRST_medipix_PARAM + 1)

static const char *driverName = "medipixDetector";

#endif /* MEDIPIXDETECTOR_H_ */