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

Does image statistics. More...

#include <NDPluginStats.h>

Inheritance diagram for NDPluginStats:
NDPluginDriver asynNDArrayDriver asynPortDriver

List of all members.

Public Member Functions

 NDPluginStats (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int maxBuffers, size_t maxMemory, int priority, int stackSize)
 Constructor for NDPluginStats; 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().
asynStatus writeFloat64 (asynUser *pasynUser, epicsFloat64 value)
 Called when asyn clients call pasynFloat64->write().
template<typename epicsType >
void doComputeStatisticsT (NDArray *pArray, NDStats_t *pStats)
int doComputeStatistics (NDArray *pArray, NDStats_t *pStats)
template<typename epicsType >
asynStatus doComputeCentroidT (NDArray *pArray)
asynStatus doComputeCentroid (NDArray *pArray)
template<typename epicsType >
asynStatus doComputeProfilesT (NDArray *pArray)
asynStatus doComputeProfiles (NDArray *pArray)
template<typename epicsType >
asynStatus doComputeHistogramT (NDArray *pArray)
asynStatus doComputeHistogram (NDArray *pArray)

Protected Attributes

int NDPluginStatsComputeStatistics
int NDPluginStatsBgdWidth
int NDPluginStatsMinValue
int NDPluginStatsMinX
int NDPluginStatsMinY
int NDPluginStatsMaxValue
int NDPluginStatsMaxX
int NDPluginStatsMaxY
int NDPluginStatsMeanValue
int NDPluginStatsSigmaValue
int NDPluginStatsTotal
int NDPluginStatsNet
int NDPluginStatsComputeCentroid
int NDPluginStatsCentroidThreshold
int NDPluginStatsCentroidX
int NDPluginStatsCentroidY
int NDPluginStatsSigmaX
int NDPluginStatsSigmaY
int NDPluginStatsSigmaXY
int NDPluginStatsTSControl
int NDPluginStatsTSNumPoints
int NDPluginStatsTSCurrentPoint
int NDPluginStatsTSAcquiring
int NDPluginStatsTSMinValue
int NDPluginStatsTSMinX
int NDPluginStatsTSMinY
int NDPluginStatsTSMaxValue
int NDPluginStatsTSMaxX
int NDPluginStatsTSMaxY
int NDPluginStatsTSMeanValue
int NDPluginStatsTSSigmaValue
int NDPluginStatsTSTotal
int NDPluginStatsTSNet
int NDPluginStatsTSCentroidX
int NDPluginStatsTSCentroidY
int NDPluginStatsTSSigmaX
int NDPluginStatsTSSigmaY
int NDPluginStatsTSSigmaXY
int NDPluginStatsComputeProfiles
int NDPluginStatsProfileSizeX
int NDPluginStatsProfileSizeY
int NDPluginStatsCursorX
int NDPluginStatsCursorY
int NDPluginStatsProfileAverageX
int NDPluginStatsProfileAverageY
int NDPluginStatsProfileThresholdX
int NDPluginStatsProfileThresholdY
int NDPluginStatsProfileCentroidX
int NDPluginStatsProfileCentroidY
int NDPluginStatsProfileCursorX
int NDPluginStatsProfileCursorY
int NDPluginStatsComputeHistogram
int NDPluginStatsHistSize
int NDPluginStatsHistMin
int NDPluginStatsHistMax
int NDPluginStatsHistEntropy
int NDPluginStatsHistArray

Detailed Description

Does image statistics.

These include Min, max, mean, sigma X and Y centroid and sigma Histogram


Constructor & Destructor Documentation

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

Constructor for NDPluginStats; 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

asynStatus NDPluginStats::doComputeCentroid ( NDArray pArray)
template<typename epicsType >
asynStatus NDPluginStats::doComputeCentroidT ( NDArray pArray)
asynStatus NDPluginStats::doComputeHistogram ( NDArray pArray)
template<typename epicsType >
asynStatus NDPluginStats::doComputeHistogramT ( NDArray pArray)
asynStatus NDPluginStats::doComputeProfiles ( NDArray pArray)
template<typename epicsType >
asynStatus NDPluginStats::doComputeProfilesT ( NDArray pArray)
int NDPluginStats::doComputeStatistics ( NDArray pArray,
NDStats_t pStats 
)
template<typename epicsType >
void NDPluginStats::doComputeStatisticsT ( NDArray pArray,
NDStats_t pStats 
)
void NDPluginStats::processCallbacks ( NDArray pArray) [virtual]

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

Does image statistics.

Parameters:
[in]pArrayThe NDArray from the callback.

Reimplemented from NDPluginDriver.

asynStatus NDPluginStats::writeFloat64 ( asynUser *  pasynUser,
epicsFloat64  value 
) [virtual]

Called when asyn clients call pasynFloat64->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 asynPortDriver.

asynStatus NDPluginStats::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: