areaDetector 1-8
Public Member Functions | Protected Attributes
NDPluginProcess Class Reference

Does image processing operations. More...

#include <NDPluginProcess.h>

Inheritance diagram for NDPluginProcess:
NDPluginDriver asynNDArrayDriver asynPortDriver

List of all members.

Public Member Functions

 NDPluginProcess (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int maxBuffers, size_t maxMemory, int priority, int stackSize)
 Constructor for NDPluginProcess; most parameters are simply passed to NDPluginDriver::NDPluginDriver.
void processCallbacks (NDArray *pArray)
 Callback function that is called by the NDArray driver with new NDArray data.
asynStatus writeInt32 (asynUser *pasynUser, epicsInt32 value)
 Called when asyn clients call pasynInt32->write().

Protected Attributes

int NDPluginProcessSaveBackground
int NDPluginProcessEnableBackground
int NDPluginProcessValidBackground
int NDPluginProcessSaveFlatField
int NDPluginProcessEnableFlatField
int NDPluginProcessValidFlatField
int NDPluginProcessScaleFlatField
int NDPluginProcessEnableOffsetScale
int NDPluginProcessAutoOffsetScale
int NDPluginProcessScale
int NDPluginProcessOffset
int NDPluginProcessLowClip
int NDPluginProcessEnableLowClip
int NDPluginProcessHighClip
int NDPluginProcessEnableHighClip
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
int NDPluginProcessDataType

Detailed Description

Does image processing operations.

These include Background subtraction Flat field normalization Low clipping High clipping Frame averaging


Constructor & Destructor Documentation

NDPluginProcess::NDPluginProcess ( const char *  portName,
int  queueSize,
int  blockingCallbacks,
const char *  NDArrayPort,
int  NDArrayAddr,
int  maxBuffers,
size_t  maxMemory,
int  priority,
int  stackSize 
)

Constructor for NDPluginProcess; most parameters are simply passed to NDPluginDriver::NDPluginDriver.

After calling the base class constructor this method sets reasonable default values for all of the parameters.

Parameters:
[in]portNameThe name of the asyn port driver to be created.
[in]queueSizeThe number of NDArrays that the input queue for this plugin can hold when NDPluginDriverBlockingCallbacks=0. Larger queues can decrease the number of dropped arrays, at the expense of more NDArray buffers being allocated from the underlying driver's NDArrayPool.
[in]blockingCallbacksInitial setting for the NDPluginDriverBlockingCallbacks flag. 0=callbacks are queued and executed by the callback thread; 1 callbacks execute in the thread of the driver doing the callbacks.
[in]NDArrayPortName of asyn port driver for initial source of NDArray callbacks.
[in]NDArrayAddrasyn port driver address for initial source of NDArray callbacks.
[in]maxBuffersThe maximum number of NDArray buffers that the NDArrayPool for this driver is allowed to allocate. Set this to -1 to allow an unlimited number of buffers.
[in]maxMemoryThe maximum amount of memory that the NDArrayPool for this driver is allowed to allocate. Set this to -1 to allow an unlimited amount of memory.
[in]priorityThe thread priority for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.
[in]stackSizeThe stack size for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.

Member Function Documentation

void NDPluginProcess::processCallbacks ( NDArray pArray) [virtual]

Callback function that is called by the NDArray driver with new NDArray data.

Does image processing.

Parameters:
[in]pArrayThe NDArray from the callback.

Reimplemented from NDPluginDriver.

asynStatus NDPluginProcess::writeInt32 ( asynUser *  pasynUser,
epicsInt32  value 
) [virtual]

Called when asyn clients call pasynInt32->write().

This function performs actions for some parameters. For all parameters it sets the value in the parameter library and calls any registered callbacks..

Parameters:
[in]pasynUserpasynUser structure that encodes the reason and address.
[in]valueValue to write.

Reimplemented from NDPluginDriver.


Member Data Documentation


The documentation for this class was generated from the following files: