NDPluginProcess.h

Go to the documentation of this file.

#ifndef NDPluginProcess_H
#define NDPluginProcess_H

#include "NDPluginDriver.h"

/* Background array subtraction */
#define NDPluginProcessSaveBackgroundString     "SAVE_BACKGROUND"   /* (asynInt32,   r/w) Save the current frame as background */
#define NDPluginProcessEnableBackgroundString   "ENABLE_BACKGROUND" /* (asynInt32,   r/w) Enable background subtraction? */
#define NDPluginProcessValidBackgroundString    "VALID_BACKGROUND"  /* (asynInt32,   r/o) Is there a valid background */

/* Flat field normalization */
#define NDPluginProcessSaveFlatFieldString      "SAVE_FLAT_FIELD"   /* (asynInt32,   r/w) Save the current frame as flat field */
#define NDPluginProcessEnableFlatFieldString    "ENABLE_FLAT_FIELD" /* (asynInt32,   r/w) Enable flat field normalization? */
#define NDPluginProcessValidFlatFieldString     "VALID_FLAT_FIELD"  /* (asynInt32,   r/o) Is there a valid flat field */
#define NDPluginProcessScaleFlatFieldString     "SCALE_FLAT_FIELD"  /* (asynInt32,   r/o) Scale factor after dividing by flat field */

/* Offset and scaling */
#define NDPluginProcessEnableOffsetScaleString  "ENABLE_OFFSET_SCALE" /* (asynInt32, r/w) Enable offset and scale? */
#define NDPluginProcessAutoOffsetScaleString    "AUTO_OFFSET_SCALE" /* (asynInt32,   r/w) Oneshot calc of scale and offset value from min and max values */
#define NDPluginProcessScaleString              "SCALE"             /* (asynFloat64, r/w) Scale value */
#define NDPluginProcessOffsetString             "OFFSET"            /* (asynFloat64, r/w) Offset value */

/* High and low clipping */
#define NDPluginProcessLowClipString            "LOW_CLIP"          /* (asynFloat64, r/w) Low clip value */
#define NDPluginProcessEnableLowClipString      "ENABLE_LOW_CLIP"   /* (asynInt32,   r/w) Enable low clipping? */
#define NDPluginProcessHighClipString           "HIGH_CLIP"         /* (asynFloat64, r/w) High clip value */
#define NDPluginProcessEnableHighClipString     "ENABLE_HIGH_CLIP"  /* (asynInt32,   r/w) Enable high clipping? */

/* Recursive filter */
#define NDPluginProcessEnableFilterString       "ENABLE_FILTER"     /* (asynInt32,   r/w) Enable frame filtering? */
#define NDPluginProcessResetFilterString        "RESET_FILTER"      /* (asynInt32,   r/w) Reset frame filtering when 1 */
#define NDPluginProcessAutoResetFilterString    "AUTO_RESET_FILTER" /* (asynInt32,   r/w) Auto-reset filter on N */
#define NDPluginProcessFilterCallbacksString    "FILTER_CALLBACKS"  /* (asynInt32,   r/w) Only do callbacks on N */
#define NDPluginProcessNumFilterString          "NUM_FILTER"        /* (asynInt32,   r/w) Number of frames to filter */
#define NDPluginProcessNumFilteredString        "NUM_FILTERED"      /* (asynInt32,   r/o) Number of frames filtered */
#define NDPluginProcessOOffsetString            "FILTER_OOFFSET"    /* (asynFloat64, r/w) Output offset */
#define NDPluginProcessOScaleString             "FILTER_OSCALE"     /* (asynFloat64, r/w) Output scale */
#define NDPluginProcessOC1String                "FILTER_OC1"        /* (asynFloat64, r/w) Output coefficient 1 */
#define NDPluginProcessOC2String                "FILTER_OC2"        /* (asynFloat64, r/w) Output coefficient 2 */
#define NDPluginProcessOC3String                "FILTER_OC3"        /* (asynFloat64, r/w) Output coefficient 3 */
#define NDPluginProcessOC4String                "FILTER_OC4"        /* (asynFloat64, r/w) Output coefficient 4 */
#define NDPluginProcessFOffsetString            "FILTER_FOFFSET"    /* (asynFloat64, r/w) Filter offset */
#define NDPluginProcessFScaleString             "FILTER_FSCALE"     /* (asynFloat64, r/w) Filter scale */
#define NDPluginProcessFC1String                "FILTER_FC1"        /* (asynFloat64, r/w) Filter coefficient 1 */
#define NDPluginProcessFC2String                "FILTER_FC2"        /* (asynFloat64, r/w) Filter coefficient 2 */
#define NDPluginProcessFC3String                "FILTER_FC3"        /* (asynFloat64, r/w) Filter coefficient 3 */
#define NDPluginProcessFC4String                "FILTER_FC4"        /* (asynFloat64, r/w) Filter coefficient 4 */
#define NDPluginProcessROffsetString            "FILTER_ROFFSET"    /* (asynFloat64, r/w) Reset offset */
#define NDPluginProcessRC1String                "FILTER_RC1"        /* (asynFloat64, r/w) Reset coefficient 1 */
#define NDPluginProcessRC2String                "FILTER_RC2"        /* (asynFloat64, r/w) Reset coefficient 2 */

/* Output data type */
#define NDPluginProcessDataTypeString           "PROCESS_DATA_TYPE" /* (asynInt32,   r/w) Output type.  -1 means automatic. */


class NDPLUGIN_API NDPluginProcess : public NDPluginDriver {
public:
    NDPluginProcess(const char *portName, int queueSize, int blockingCallbacks,
                 const char *NDArrayPort, int NDArrayAddr,
                 int maxBuffers, size_t maxMemory,
                 int priority, int stackSize);
    /* These methods override the virtual methods in the base class */
    void processCallbacks(NDArray *pArray);
    asynStatus writeInt32(asynUser *pasynUser, epicsInt32 value);

protected:
    /* Background array subtraction */
    int NDPluginProcessSaveBackground;
    #define FIRST_NDPLUGIN_PROCESS_PARAM NDPluginProcessSaveBackground
    int NDPluginProcessEnableBackground;
    int NDPluginProcessValidBackground;

    /* Flat field normalization */
    int NDPluginProcessSaveFlatField;
    int NDPluginProcessEnableFlatField;
    int NDPluginProcessValidFlatField;
    int NDPluginProcessScaleFlatField;

    /* Scale and offset */
    int NDPluginProcessEnableOffsetScale;
    int NDPluginProcessAutoOffsetScale;
    int NDPluginProcessScale;
    int NDPluginProcessOffset;

    /* High and low clipping */
    int NDPluginProcessLowClip;
    int NDPluginProcessEnableLowClip;
    int NDPluginProcessHighClip;
    int NDPluginProcessEnableHighClip;

    /* Frame filtering */
    int NDPluginProcessEnableFilter;
    int NDPluginProcessResetFilter;
    int NDPluginProcessAutoResetFilter;
    int NDPluginProcessFilterCallbacks;
    int NDPluginProcessNumFilter;
    int NDPluginProcessNumFiltered;
    int NDPluginProcessOOffset;
    int NDPluginProcessOScale;
    int NDPluginProcessOC1;
    int NDPluginProcessOC2;
    int NDPluginProcessOC3;
    int NDPluginProcessOC4;
    int NDPluginProcessFOffset;
    int NDPluginProcessFScale;
    int NDPluginProcessFC1;
    int NDPluginProcessFC2;
    int NDPluginProcessFC3;
    int NDPluginProcessFC4;
    int NDPluginProcessROffset;
    int NDPluginProcessRC1;
    int NDPluginProcessRC2;

    /* Output data type */
    int NDPluginProcessDataType;

private:
    NDArray *pBackground;
    size_t  nBackgroundElements;
    NDArray *pFlatField;
    size_t  nFlatFieldElements;
    NDArray *pFilter;
    int  numFiltered;
};

#endif