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

Extract Regions-Of-Interest (ROI) from NDArray data; the plugin can be a source of NDArray callbacks for other plugins, passing these sub-arrays. More...

#include <NDPluginROI.h>

Inheritance diagram for NDPluginROI:
NDPluginDriver asynNDArrayDriver asynPortDriver

List of all members.

Public Member Functions

 NDPluginROI (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int maxBuffers, size_t maxMemory, int priority, int stackSize)
 Constructor for NDPluginROI; 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.

Protected Attributes

int NDPluginROIName
int NDPluginROIDim0Min
int NDPluginROIDim1Min
int NDPluginROIDim2Min
int NDPluginROIDim0Size
int NDPluginROIDim1Size
int NDPluginROIDim2Size
int NDPluginROIDim0MaxSize
int NDPluginROIDim1MaxSize
int NDPluginROIDim2MaxSize
int NDPluginROIDim0Bin
int NDPluginROIDim1Bin
int NDPluginROIDim2Bin
int NDPluginROIDim0Reverse
int NDPluginROIDim1Reverse
int NDPluginROIDim2Reverse
int NDPluginROIDim0Enable
int NDPluginROIDim1Enable
int NDPluginROIDim2Enable
int NDPluginROIDim0AutoSize
int NDPluginROIDim1AutoSize
int NDPluginROIDim2AutoSize
int NDPluginROIDataType
int NDPluginROIEnableScale
int NDPluginROIScale

Detailed Description

Extract Regions-Of-Interest (ROI) from NDArray data; the plugin can be a source of NDArray callbacks for other plugins, passing these sub-arrays.

The plugin also optionally computes a statistics on the ROI.


Constructor & Destructor Documentation

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

Constructor for NDPluginROI; 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]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 NDPluginROI::processCallbacks ( NDArray pArray) [virtual]

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

Extracts the NthrDArray data into each of the ROIs that are being used. Computes statistics on the ROI if NDPluginROIComputeStatistics is 1. Computes the histogram of ROI values if NDPluginROIComputeHistogram is 1.

Parameters:
[in]pArrayThe NDArray from the callback.

Reimplemented from NDPluginDriver.


Member Data Documentation


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