#include <QImaging.h>

Inheritance diagram for QImage:

Public Member Functions
	QImage (const char portName, const char model, NDDataType_t dataType, int numbuffs, int debug, int maxBuffers, size_t maxMemory, int priority, int stackSize)
	QImage::QImage Class constructor. More...

virtual asynStatus	writeInt32 (asynUser *pasynUser, epicsInt32 value)
	QImage::writeInt32: Called when asyn clients call pasynInt32->write(). More...

virtual asynStatus	writeFloat64 (asynUser *pasynUser, epicsFloat64 value)
	QImage::writeFloat64: Called when asyn clients call pasynFloat64->write(). More...

virtual void	report (FILE *fp, int details)
	QImage::report. More...

virtual asynStatus	readEnum (asynUser pasynUser, char strings[], int values[], int severities[], size_t nElements, size_t *nIn)
	QImage::readEnum: Adds frame data type and color mode to enums. More...

void	consumerTask ()
	QImage::consumerTask: Thread function to accept new frames from the detector and push them down the pipeline. More...

void	frameTask ()
	QImage::frameTask: Thread function for generating software triggers for the detector. More...

void	shutdown ()
	QImage::shutdown: Function called at IOC exit. More...

void	pushCollectedFrame (int id)
	QImage::pushCollectedFrame: Pushes an aquired frame to a queue to be proecssed by consumer thread. More...

void	setExposureDone ()
	QImage::setExposureDone: Call signal when exposure happened on the detector. More...

Public Member Functions inherited from ADDriver
	ADDriver (const char *portName, int maxAddr, int numParams, int maxBuffers, size_t maxMemory, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize)
	All of the arguments are simply passed to the constructor for the asynNDArrayDriver base class, except numParams. More...

virtual asynStatus	connect (asynUser *pasynUser)
	Connects driver to device; This method is called when the driver's pasynCommon->connect() function is called. More...

virtual void	setShutter (int open)
	Set the shutter position. 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	writeOctet (asynUser pasynUser, const char value, size_t maxChars, size_t *nActual)
	Called when asyn clients call pasynOctet->write(). More...

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 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	qMaxBitDepthRBV

int	qSerialNumberRBV

int	qUniqueIdRBV

int	qCcdTypeRBV

int	qCooledRBV

int	qRegulatedCoolingRBV

int	qFanControlRBV

int	qHighSensitivityModeRBV

int	qBlackoutModeRBV

int	qAsymmetricalBinningRBV

int	qCoolerActive

int	qReadoutSpeed

int	qOffset

int	qImageFormat

int	qAcquireTimeRBV

int	qMinXRBV

int	qMinYRBV

int	qSizeXRBV

int	qSizeYRBV

int	qTriggerModeRBV

int	qGainRBV

int	qTemperatureRBV

int	qReadoutSpeedRBV

int	qOffsetRBV

int	qImageFormatRBV

int	qCoolerActiveRBV

int	qRegulatedCoolingLockRBV

int	qExposureStatusMessageRBV

int	qFrameStatusMessageRBV

int	qTrgCnt

int	qExpCnt

int	qFrmCnt

int	qShowDiags

int	qResetCam

int	qExposureMax

int	qExposureMin

int	qGainMax

int	qGainMin

int	qBinning

int	qAutoExposure

int	qWhiteBalance

int	qInitialize

Protected Attributes inherited from ADDriver
int	ADGain

int	ADBinX

int	ADBinY

int	ADMinX

int	ADMinY

int	ADSizeX

int	ADSizeY

int	ADMaxSizeX

int	ADMaxSizeY

int	ADReverseX

int	ADReverseY

int	ADFrameType

int	ADImageMode

int	ADNumExposures

int	ADNumExposuresCounter

int	ADNumImages

int	ADNumImagesCounter

int	ADAcquireTime

int	ADAcquirePeriod

int	ADTimeRemaining

int	ADStatus

int	ADTriggerMode

int	ADShutterControl

int	ADShutterControlEPICS

int	ADShutterStatus

int	ADShutterMode

int	ADShutterOpenDelay

int	ADShutterCloseDelay

int	ADTemperature

int	ADTemperatureActual

int	ADReadStatus

int	ADStatusMessage

int	ADStringToServer

int	ADStringFromServer

bool	deviceIsReachable

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_

Friends
void QCAMAPI	QImageCallback (void *usrPtr, unsigned long frameId, QCam_Err errorcode, unsigned long flags)
	Callback function from the detector when a frame or exposure occur. More...

Additional Inherited Members
Public Attributes inherited from asynNDArrayDriver
class NDArrayPool *	pNDArrayPool
	An NDArrayPool pointer that is initialized to pNDArrayPoolPvt_ in the constructor. More...

Constructor & Destructor Documentation

◆ QImage()

QImage::QImage	(	const char *	portName,
		const char *	model,
		NDDataType_t	ndDataType,
		int	numbuffs,
		int	debug,
		int	maxBuffers,
		size_t	maxMemory,
		int	priority,
		int	stackSize
	)

QImage::QImage Class constructor.

Parameters

portName	The name of the asyn port driver to be created.
model	Camera Model name
ndDataType	The initial data type (NDDataType_t) of the images that this driver will create.
numbuffs	The number of frames to hold in the circular buffer.
debug	Debug mode
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.
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.
priority	The thread priority for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.
stackSize	The stack size for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.

Member Function Documentation

◆ consumerTask()

void QImage::consumerTask ( )

QImage::consumerTask: Thread function to accept new frames from the detector and push them down the pipeline.

◆ frameTask()

void QImage::frameTask ( )

QImage::frameTask: Thread function for generating software triggers for the detector.

◆ pushCollectedFrame()

void QImage::pushCollectedFrame ( int id )

QImage::pushCollectedFrame: Pushes an aquired frame to a queue to be proecssed by consumer thread.

Parameters

id

◆ readEnum()

asynStatus QImage::readEnum	(	asynUser *	pasynUser,
		char *	strings[],
		int	values[],
		int	severities[],
		size_t	nElements,
		size_t *	nIn
	)

virtual

QImage::readEnum: Adds frame data type and color mode to enums.

Parameters

pasynUser
strings
values
severities
nElements
nIn

Returns

◆ report()

void QImage::report	(	FILE *	fp,
		int	details
	)

virtual

QImage::report.

Parameters

fp
details

Reimplemented from asynNDArrayDriver.

◆ setExposureDone()

void QImage::setExposureDone ( )

QImage::setExposureDone: Call signal when exposure happened on the detector.

◆ shutdown()

void QImage::shutdown ( void )

QImage::shutdown: Function called at IOC exit.

◆ writeFloat64()

asynStatus QImage::writeFloat64	(	asynUser *	pasynUser,
		epicsFloat64	value
	)

virtual

QImage::writeFloat64: Called when asyn clients call pasynFloat64->write().

This function performs actions for some parameters, including ADAcquireTime, ADGain, etc. For all parameters it sets the value in the parameter library and calls any registered callbacks.

Parameters

pasynUser	Structure that encodes the reason and address.
value	Value to write.

Returns

◆ writeInt32()

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

virtual

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

This function performs actions for some parameters, including ADAcquire, ADColorMode, etc. For all parameters it sets the value in the parameter library and calls any registered callbacks.

Parameters

pasynUser	Structure that encodes the reason and address.
value	Value to write

Returns

Reimplemented from ADDriver.

Friends And Related Function Documentation

◆ QImageCallback

void QCAMAPI QImageCallback	(	void *	usrPtr,
		unsigned long	frameId,
		QCam_Err	errorcode,
		unsigned long	flags
	)

friend

Callback function from the detector when a frame or exposure occur.

Parameters

usrPtr	QImage class pointer
frameId
errorcode
flags

Member Data Documentation

◆ qAcquireTimeRBV

int QImage::qAcquireTimeRBV

protected

◆ qAsymmetricalBinningRBV

int QImage::qAsymmetricalBinningRBV

protected

◆ qAutoExposure

int QImage::qAutoExposure

protected

◆ qBinning

int QImage::qBinning

protected

◆ qBlackoutModeRBV

int QImage::qBlackoutModeRBV

protected

◆ qCcdTypeRBV

int QImage::qCcdTypeRBV

protected

◆ qCooledRBV

int QImage::qCooledRBV

protected

◆ qCoolerActive

int QImage::qCoolerActive

protected

◆ qCoolerActiveRBV

int QImage::qCoolerActiveRBV

protected

◆ qExpCnt

int QImage::qExpCnt

protected

◆ qExposureMax

int QImage::qExposureMax

protected

◆ qExposureMin

int QImage::qExposureMin

protected

◆ qExposureStatusMessageRBV

int QImage::qExposureStatusMessageRBV

protected

◆ qFanControlRBV

int QImage::qFanControlRBV

protected

◆ qFrameStatusMessageRBV

int QImage::qFrameStatusMessageRBV

protected

◆ qFrmCnt

int QImage::qFrmCnt

protected

◆ qGainMax

int QImage::qGainMax

protected

◆ qGainMin

int QImage::qGainMin

protected

◆ qGainRBV

int QImage::qGainRBV

protected

◆ qHighSensitivityModeRBV

int QImage::qHighSensitivityModeRBV

protected

◆ qImageFormat

int QImage::qImageFormat

protected

◆ qImageFormatRBV

int QImage::qImageFormatRBV

protected

◆ qInitialize

int QImage::qInitialize

protected

◆ qMaxBitDepthRBV

int QImage::qMaxBitDepthRBV

protected

◆ qMinXRBV

int QImage::qMinXRBV

protected

◆ qMinYRBV

int QImage::qMinYRBV

protected

◆ qOffset

int QImage::qOffset

protected

◆ qOffsetRBV

int QImage::qOffsetRBV

protected

◆ qReadoutSpeed

int QImage::qReadoutSpeed

protected

◆ qReadoutSpeedRBV

int QImage::qReadoutSpeedRBV

protected

◆ qRegulatedCoolingLockRBV

int QImage::qRegulatedCoolingLockRBV

protected

◆ qRegulatedCoolingRBV

int QImage::qRegulatedCoolingRBV

protected

◆ qResetCam

int QImage::qResetCam

protected

◆ qSerialNumberRBV

int QImage::qSerialNumberRBV

protected

◆ qShowDiags

int QImage::qShowDiags

protected

◆ qSizeXRBV

int QImage::qSizeXRBV

protected

◆ qSizeYRBV

int QImage::qSizeYRBV

protected

◆ qTemperatureRBV

int QImage::qTemperatureRBV

protected

◆ qTrgCnt

int QImage::qTrgCnt

protected

◆ qTriggerModeRBV

int QImage::qTriggerModeRBV

protected

◆ qUniqueIdRBV

int QImage::qUniqueIdRBV

protected

◆ qWhiteBalance

int QImage::qWhiteBalance

protected

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

/home/runner/work/areaDetector/areaDetector/ADQImaging/Support/QImaging.h
/home/runner/work/areaDetector/areaDetector/ADQImaging/App/src/QImaging.cpp

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ QImage()

Member Function Documentation

◆ consumerTask()

◆ frameTask()

◆ pushCollectedFrame()

◆ readEnum()

◆ report()

◆ setExposureDone()

◆ shutdown()

◆ writeFloat64()

◆ writeInt32()

Friends And Related Function Documentation

◆ QImageCallback

Member Data Documentation

◆ qAcquireTimeRBV

◆ qAsymmetricalBinningRBV

◆ qAutoExposure

◆ qBinning

◆ qBlackoutModeRBV

◆ qCcdTypeRBV

◆ qCooledRBV

◆ qCoolerActive

◆ qCoolerActiveRBV

◆ qExpCnt

◆ qExposureMax

◆ qExposureMin

◆ qExposureStatusMessageRBV

◆ qFanControlRBV

◆ qFrameStatusMessageRBV

◆ qFrmCnt

◆ qGainMax

◆ qGainMin

◆ qGainRBV

◆ qHighSensitivityModeRBV

◆ qImageFormat

◆ qImageFormatRBV

◆ qInitialize

◆ qMaxBitDepthRBV

◆ qMinXRBV

◆ qMinYRBV

◆ qOffset

◆ qOffsetRBV

◆ qReadoutSpeed

◆ qReadoutSpeedRBV

◆ qRegulatedCoolingLockRBV

◆ qRegulatedCoolingRBV

◆ qResetCam

◆ qSerialNumberRBV

◆ qShowDiags

◆ qSizeXRBV

◆ qSizeYRBV

◆ qTemperatureRBV

◆ qTrgCnt

◆ qTriggerModeRBV

◆ qUniqueIdRBV

◆ qWhiteBalance