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:

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, int maxThreads)
	Constructor for NDPluginROI; 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	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

int	NDPluginROICollapseDims

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

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

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]	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 0 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 0 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.
[in]	maxThreads	The maximum number of threads this driver is allowed to use. If 0 then 1 will be used.

Member Function Documentation

◆ processCallbacks()

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] pArray The NDArray from the callback.

Implements NDPluginDriver.

◆ writeInt32()

asynStatus NDPluginROI::writeInt32	(	asynUser *	pasynUser,
		epicsInt32	value
	)

virtual

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

This function performs actions for some parameters, including NDPluginDriverEnableCallbacks and NDPluginDriverArrayAddr. 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

◆ NDPluginROICollapseDims

int NDPluginROI::NDPluginROICollapseDims

protected

◆ NDPluginROIDataType

int NDPluginROI::NDPluginROIDataType

protected

◆ NDPluginROIDim0AutoSize

int NDPluginROI::NDPluginROIDim0AutoSize

protected

◆ NDPluginROIDim0Bin

int NDPluginROI::NDPluginROIDim0Bin

protected

◆ NDPluginROIDim0Enable

int NDPluginROI::NDPluginROIDim0Enable

protected

◆ NDPluginROIDim0MaxSize

int NDPluginROI::NDPluginROIDim0MaxSize

protected

◆ NDPluginROIDim0Min

int NDPluginROI::NDPluginROIDim0Min

protected

◆ NDPluginROIDim0Reverse

int NDPluginROI::NDPluginROIDim0Reverse

protected

◆ NDPluginROIDim0Size

int NDPluginROI::NDPluginROIDim0Size

protected

◆ NDPluginROIDim1AutoSize

int NDPluginROI::NDPluginROIDim1AutoSize

protected

◆ NDPluginROIDim1Bin

int NDPluginROI::NDPluginROIDim1Bin

protected

◆ NDPluginROIDim1Enable

int NDPluginROI::NDPluginROIDim1Enable

protected

◆ NDPluginROIDim1MaxSize

int NDPluginROI::NDPluginROIDim1MaxSize

protected

◆ NDPluginROIDim1Min

int NDPluginROI::NDPluginROIDim1Min

protected

◆ NDPluginROIDim1Reverse

int NDPluginROI::NDPluginROIDim1Reverse

protected

◆ NDPluginROIDim1Size

int NDPluginROI::NDPluginROIDim1Size

protected

◆ NDPluginROIDim2AutoSize

int NDPluginROI::NDPluginROIDim2AutoSize

protected

◆ NDPluginROIDim2Bin

int NDPluginROI::NDPluginROIDim2Bin

protected

◆ NDPluginROIDim2Enable

int NDPluginROI::NDPluginROIDim2Enable

protected

◆ NDPluginROIDim2MaxSize

int NDPluginROI::NDPluginROIDim2MaxSize

protected

◆ NDPluginROIDim2Min

int NDPluginROI::NDPluginROIDim2Min

protected

◆ NDPluginROIDim2Reverse

int NDPluginROI::NDPluginROIDim2Reverse

protected

◆ NDPluginROIDim2Size

int NDPluginROI::NDPluginROIDim2Size

protected

◆ NDPluginROIEnableScale

int NDPluginROI::NDPluginROIEnableScale

protected

◆ NDPluginROIName

int NDPluginROI::NDPluginROIName

protected

◆ NDPluginROIScale

int NDPluginROI::NDPluginROIScale

protected

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

/home/runner/work/areaDetector/areaDetector/ADCore/ADApp/pluginSrc/NDPluginROI.h
/home/runner/work/areaDetector/areaDetector/ADCore/ADApp/pluginSrc/NDPluginROI.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NDPluginROI()

Member Function Documentation

◆ processCallbacks()

◆ writeInt32()

Member Data Documentation

◆ NDPluginROICollapseDims

◆ NDPluginROIDataType

◆ NDPluginROIDim0AutoSize

◆ NDPluginROIDim0Bin

◆ NDPluginROIDim0Enable

◆ NDPluginROIDim0MaxSize

◆ NDPluginROIDim0Min

◆ NDPluginROIDim0Reverse

◆ NDPluginROIDim0Size

◆ NDPluginROIDim1AutoSize

◆ NDPluginROIDim1Bin

◆ NDPluginROIDim1Enable

◆ NDPluginROIDim1MaxSize

◆ NDPluginROIDim1Min

◆ NDPluginROIDim1Reverse

◆ NDPluginROIDim1Size

◆ NDPluginROIDim2AutoSize

◆ NDPluginROIDim2Bin

◆ NDPluginROIDim2Enable

◆ NDPluginROIDim2MaxSize

◆ NDPluginROIDim2Min

◆ NDPluginROIDim2Reverse

◆ NDPluginROIDim2Size

◆ NDPluginROIEnableScale

◆ NDPluginROIName

◆ NDPluginROIScale