areaDetector 1-9
Public Member Functions | Protected Attributes
NDPluginOverlay Class Reference

Overlay graphics on top of an image. More...

#include <NDPluginOverlay.h>

Inheritance diagram for NDPluginOverlay:
NDPluginDriver asynNDArrayDriver asynPortDriver

List of all members.

Public Member Functions

 NDPluginOverlay (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int maxOverlays, int maxBuffers, size_t maxMemory, int priority, int stackSize)
 Constructor for NDPluginOverlay; 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.
template<typename epicsType >
void doOverlayT (NDArray *pArray, NDOverlay_t *pOverlay)
int doOverlay (NDArray *pArray, NDOverlay_t *pOverlay)
template<typename epicsType >
void setPixel (epicsType *pValue, NDOverlay_t *pOverlay)

Protected Attributes

int NDPluginOverlayMaxSizeX
int NDPluginOverlayMaxSizeY
int NDPluginOverlayName
int NDPluginOverlayUse
int NDPluginOverlayPositionX
int NDPluginOverlayPositionY
int NDPluginOverlaySizeX
int NDPluginOverlaySizeY
int NDPluginOverlayShape
int NDPluginOverlayDrawMode
int NDPluginOverlayRed
int NDPluginOverlayGreen
int NDPluginOverlayBlue

Detailed Description

Overlay graphics on top of an image.

Useful for highlighting ROIs and displaying cursors


Constructor & Destructor Documentation

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

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

After calling the base class constructor this method sets reasonable default values for all of the ROI 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]maxOverlaysThe maximum number ofoverlays this plugin supports. 1 is minimum.
[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

int NDPluginOverlay::doOverlay ( NDArray pArray,
NDOverlay_t pOverlay 
)
template<typename epicsType >
void NDPluginOverlay::doOverlayT ( NDArray pArray,
NDOverlay_t pOverlay 
)
void NDPluginOverlay::processCallbacks ( NDArray pArray) [virtual]

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

Draws overlays on top of the array.

Parameters:
[in]pArrayThe NDArray from the callback.

Reimplemented from NDPluginDriver.

template<typename epicsType >
void NDPluginOverlay::setPixel ( epicsType *  pValue,
NDOverlay_t pOverlay 
)

Member Data Documentation


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