NDPluginProcess Class Reference

Does image processing operations. More...

#include <NDPluginProcess.h>

Inheritance diagram for NDPluginProcess:

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. More...
void	processCallbacks (NDArray *pArray)
	Callback function that is called by the NDArray driver with new NDArray data. More...
asynStatus	writeInt32 (asynUser *pasynUser, epicsInt32 value)
	Called when asyn clients call pasynInt32->write(). More...
Public Member Functions inherited from NDPluginDriver
	NDPluginDriver (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int maxAddr, int maxBuffers, size_t maxMemory, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize, int maxThreads, bool compressionAware=false)
	Constructor for NDPluginDriver; most parameters are simply passed to asynNDArrayDriver::asynNDArrayDriver. More...
	~NDPluginDriver ()
virtual asynStatus	writeFloat64 (asynUser *pasynUser, epicsFloat64 value)
	Called when asyn clients call pasynFloat64->write(). More...
virtual asynStatus	writeOctet (asynUser *pasynUser, const char *value, size_t maxChars, size_t *nActual)
	Called when asyn clients call pasynOctet->write(). More...
virtual asynStatus	readInt32Array (asynUser *pasynUser, epicsInt32 *value, size_t nElements, size_t *nIn)
	Called when asyn clients call pasynInt32Array->read(). More...
virtual void	driverCallback (asynUser *pasynUser, void *genericPointer)
	Method that is called from the driver with a new NDArray. More...
virtual void	run (void)
	Starts the thread that receives NDArrays from the epicsMessageQueue. More...
virtual asynStatus	start (void)
	Starts the plugin threads. More...
void	sortingTask ()
	Method runs as a separate thread, periodically doing NDArray callbacks to downstream plugins. More...
Public Member Functions inherited from asynNDArrayDriver
	asynNDArrayDriver (const char *portName, int maxAddr, int maxBuffers, size_t maxMemory, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize)
	This is the constructor for the asynNDArrayDriver class. More...
virtual	~asynNDArrayDriver ()
virtual asynStatus	readGenericPointer (asynUser *pasynUser, void *genericPointer)
	This method copies an NDArray object from the asynNDArrayDriver to an NDArray pointer passed in by the caller. More...
virtual asynStatus	writeGenericPointer (asynUser *pasynUser, void *genericPointer)
	This method currently does nothing, but it should be implemented in this base class. More...
virtual asynStatus	setIntegerParam (int index, int value)
	Sets the value for an integer in the parameter library. More...
virtual asynStatus	setIntegerParam (int list, int index, int value)
	Sets the value for an integer in the parameter library. More...
virtual void	report (FILE *fp, int details)
	Report status of the driver. More...
virtual asynStatus	createFilePath (const char *path, int pathDepth)
	Function to create a directory path for a file. More...
virtual asynStatus	checkPath ()
	Checks whether the directory specified NDFilePath parameter exists. More...
virtual bool	checkPath (std::string &filePath)
	Checks whether the directory specified exists. More...
virtual asynStatus	createFileName (int maxChars, char *fullFileName)
	Build a file name from component parts. More...
virtual asynStatus	createFileName (int maxChars, char *filePath, char *fileName)
	Build a file name from component parts. More...
virtual asynStatus	readNDAttributesFile ()
	Create this driver's NDAttributeList (pAttributeList) by reading an XML file This clears any existing attributes from this drivers' NDAttributeList and then creates a new list based on the XML file. More...
virtual asynStatus	getAttributes (NDAttributeList *pAttributeList)
	Get the current values of attributes from this driver and appends them to an output attribute list. More...
virtual void	updateTimeStamps (NDArray *pArray)
asynStatus	incrementQueuedArrayCount ()
asynStatus	decrementQueuedArrayCount ()
int	getQueuedArrayCount ()
void	updateQueuedArrayCount ()

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	NDPluginProcessLowClipThresh
int	NDPluginProcessLowClipValue
int	NDPluginProcessEnableLowClip
int	NDPluginProcessHighClipThresh
int	NDPluginProcessHighClipValue
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
Protected Attributes inherited from NDPluginDriver
int	NDPluginDriverArrayPort
int	NDPluginDriverArrayAddr
int	NDPluginDriverPluginType
int	NDPluginDriverDroppedArrays
int	NDPluginDriverQueueSize
int	NDPluginDriverQueueFree
int	NDPluginDriverMaxThreads
int	NDPluginDriverNumThreads
int	NDPluginDriverSortMode
int	NDPluginDriverSortTime
int	NDPluginDriverSortSize
int	NDPluginDriverSortFree
int	NDPluginDriverDisorderedArrays
int	NDPluginDriverDroppedOutputArrays
int	NDPluginDriverEnableCallbacks
int	NDPluginDriverBlockingCallbacks
int	NDPluginDriverProcessPlugin
int	NDPluginDriverExecutionTime
int	NDPluginDriverMinCallbackTime
int	NDPluginDriverMaxByteRate
NDArray *	pPrevInputArray_
Protected Attributes inherited from asynNDArrayDriver
int	NDPortNameSelf
int	NDADCoreVersion
int	NDDriverVersion
int	ADManufacturer
int	ADModel
int	ADSerialNumber
int	ADSDKVersion
int	ADFirmwareVersion
int	ADAcquire
int	ADAcquireBusy
int	ADWaitForPlugins
int	NDArraySizeX
int	NDArraySizeY
int	NDArraySizeZ
int	NDArraySize
int	NDNDimensions
int	NDDimensions
int	NDDataType
int	NDColorMode
int	NDUniqueId
int	NDTimeStamp
int	NDEpicsTSSec
int	NDEpicsTSNsec
int	NDBayerPattern
int	NDCodec
int	NDCompressedSize
int	NDArrayCounter
int	NDFilePath
int	NDFilePathExists
int	NDFileName
int	NDFileNumber
int	NDFileTemplate
int	NDAutoIncrement
int	NDFullFileName
int	NDFileFormat
int	NDAutoSave
int	NDWriteFile
int	NDReadFile
int	NDFileWriteMode
int	NDFileWriteStatus
int	NDFileWriteMessage
int	NDFileNumCapture
int	NDFileNumCaptured
int	NDFileFreeCapture
int	NDFileCapture
int	NDFileDeleteDriverFile
int	NDFileLazyOpen
int	NDFileCreateDir
int	NDFileTempSuffix
int	NDAttributesFile
int	NDAttributesStatus
int	NDAttributesMacros
int	NDArrayData
int	NDArrayCallbacks
int	NDPoolMaxBuffers
int	NDPoolAllocBuffers
int	NDPoolPreAllocBuffers
int	NDPoolNumPreAllocBuffers
int	NDPoolFreeBuffers
int	NDPoolMaxMemory
int	NDPoolUsedMemory
int	NDPoolEmptyFreeList
int	NDPoolPollStats
int	NDNumQueuedArrays
class NDArray **	pArrays
	An array of NDArray pointers used to store data in the driver. More...
class NDAttributeList *	pAttributeList
	An NDAttributeList object used to obtain the current values of a set of attributes. More...
int	threadStackSize_
int	threadPriority_

Additional Inherited Members
Public Attributes inherited from asynNDArrayDriver
class NDArrayPool *	pNDArrayPool
	An NDArrayPool pointer that is initialized to pNDArrayPoolPvt_ in the constructor. More...
Protected Member Functions inherited from NDPluginDriver
virtual void	beginProcessCallbacks (NDArray *pArray)
	Method that is normally called at the beginning of the processCallbacks method in derived classes. More...
virtual asynStatus	endProcessCallbacks (NDArray *pArray, bool copyArray=false, bool readAttributes=true)
	Method that is normally called at the end of the processCallbacks()) method in derived classes. More...
virtual asynStatus	connectToArrayPort (void)
	Connect this plugin to an NDArray port driver; disconnect from any existing driver first, register for callbacks if enabled. More...
virtual asynStatus	setArrayInterrupt (int connect)
	Register or unregister to receive asynGenericPointer (NDArray) callbacks from the driver. More...
bool	throttled (NDArray *pArray)

Detailed Description

Does image processing operations.

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

Constructor & Destructor Documentation

NDPluginProcess()

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]	portName	The name of the asyn port driver to be created.
[in]	queueSize	The 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]	blockingCallbacks	Initial 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]	NDArrayPort	Name of asyn port driver for initial source of NDArray callbacks.
[in]	NDArrayAddr	asyn port driver address for initial source of NDArray callbacks.
[in]	maxBuffers	The 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]	maxMemory	The 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]	priority	The thread priority for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.
[in]	stackSize	The stack size for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.

Member Function Documentation

processCallbacks()

void NDPluginProcess::processCallbacks ( NDArray *  pArray )

virtual

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

Does image processing.

Parameters

[in]

pArray

The NDArray from the callback.

Implements NDPluginDriver.

writeInt32()

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]	pasynUser	pasynUser structure that encodes the reason and address.
[in]	value	Value to write.

Reimplemented from NDPluginDriver.

Member Data Documentation

NDPluginProcessAutoOffsetScale

int NDPluginProcess::NDPluginProcessAutoOffsetScale

protected

NDPluginProcessAutoResetFilter

int NDPluginProcess::NDPluginProcessAutoResetFilter

protected

NDPluginProcessDataType

int NDPluginProcess::NDPluginProcessDataType

protected

NDPluginProcessEnableBackground

int NDPluginProcess::NDPluginProcessEnableBackground

protected

NDPluginProcessEnableFilter

int NDPluginProcess::NDPluginProcessEnableFilter

protected

NDPluginProcessEnableFlatField

int NDPluginProcess::NDPluginProcessEnableFlatField

protected

NDPluginProcessEnableHighClip

int NDPluginProcess::NDPluginProcessEnableHighClip

protected

NDPluginProcessEnableLowClip

int NDPluginProcess::NDPluginProcessEnableLowClip

protected

NDPluginProcessEnableOffsetScale

int NDPluginProcess::NDPluginProcessEnableOffsetScale

protected

NDPluginProcessFC1

int NDPluginProcess::NDPluginProcessFC1

protected

NDPluginProcessFC2

int NDPluginProcess::NDPluginProcessFC2

protected

NDPluginProcessFC3

int NDPluginProcess::NDPluginProcessFC3

protected

NDPluginProcessFC4

int NDPluginProcess::NDPluginProcessFC4

protected

NDPluginProcessFilterCallbacks

int NDPluginProcess::NDPluginProcessFilterCallbacks

protected

NDPluginProcessFOffset

int NDPluginProcess::NDPluginProcessFOffset

protected

NDPluginProcessFScale

int NDPluginProcess::NDPluginProcessFScale

protected

NDPluginProcessHighClipThresh

int NDPluginProcess::NDPluginProcessHighClipThresh

protected

NDPluginProcessHighClipValue

int NDPluginProcess::NDPluginProcessHighClipValue

protected

NDPluginProcessLowClipThresh

int NDPluginProcess::NDPluginProcessLowClipThresh

protected

NDPluginProcessLowClipValue

int NDPluginProcess::NDPluginProcessLowClipValue

protected

NDPluginProcessNumFilter

int NDPluginProcess::NDPluginProcessNumFilter

protected

NDPluginProcessNumFiltered

int NDPluginProcess::NDPluginProcessNumFiltered

protected

NDPluginProcessOC1

int NDPluginProcess::NDPluginProcessOC1

protected

NDPluginProcessOC2

int NDPluginProcess::NDPluginProcessOC2

protected

NDPluginProcessOC3

int NDPluginProcess::NDPluginProcessOC3

protected

NDPluginProcessOC4

int NDPluginProcess::NDPluginProcessOC4

protected

NDPluginProcessOffset

int NDPluginProcess::NDPluginProcessOffset

protected

NDPluginProcessOOffset

int NDPluginProcess::NDPluginProcessOOffset

protected

NDPluginProcessOScale

int NDPluginProcess::NDPluginProcessOScale

protected

NDPluginProcessRC1

int NDPluginProcess::NDPluginProcessRC1

protected

NDPluginProcessRC2

int NDPluginProcess::NDPluginProcessRC2

protected

NDPluginProcessResetFilter

int NDPluginProcess::NDPluginProcessResetFilter

protected

NDPluginProcessROffset

int NDPluginProcess::NDPluginProcessROffset

protected

NDPluginProcessSaveBackground

int NDPluginProcess::NDPluginProcessSaveBackground

protected

NDPluginProcessSaveFlatField

int NDPluginProcess::NDPluginProcessSaveFlatField

protected

NDPluginProcessScale

int NDPluginProcess::NDPluginProcessScale

protected

NDPluginProcessScaleFlatField

int NDPluginProcess::NDPluginProcessScaleFlatField

protected

NDPluginProcessValidBackground

int NDPluginProcess::NDPluginProcessValidBackground

protected

NDPluginProcessValidFlatField

int NDPluginProcess::NDPluginProcessValidFlatField

protected

---

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

• /home/runner/work/areaDetector/areaDetector/ADCore/ADApp/pluginSrc/NDPluginProcess.h
• /home/runner/work/areaDetector/areaDetector/ADCore/ADApp/pluginSrc/NDPluginProcess.cpp