Driver for the Perkin Elmer flat panel amorphous silicon detectors. More...

#include <PerkinElmer.h>

Inheritance diagram for PerkinElmer:

Public Member Functions
	PerkinElmer (const char portName, int IDType, const char IDValue, int maxBuffers, size_t maxMemory, int priority, int stackSize)
	Constructor for Perkin Elmer driver; most parameters are simply passed to ADDriver::ADDriver. More...

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

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

void	report (FILE *fp, int details)
	Report status of the driver. More...

void	endFrameCallback (HACQDESC hAcqDesc)
	callback function that is called by XISL every frame at end of data transfer More...

void	endAcqCallback (HACQDESC hAcqDesc)
	callback function that is called by XISL at end of acquisition More...

void	acquireStopTask (void)

	~PerkinElmer ()
	Destructor for Perkin Elmer driver; most parameters are simply passed to ADDriver::ADDriver. 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	PE_Initialize

int	PE_CorrectionsDirectory

int	PE_AcquireOffset

int	PE_NumOffsetFrames

int	PE_CurrentOffsetFrame

int	PE_UseOffset

int	PE_OffsetAvailable

int	PE_OffsetConstant

int	PE_AcquireGain

int	PE_NumGainFrames

int	PE_CurrentGainFrame

int	PE_UseGain

int	PE_GainAvailable

int	PE_GainFile

int	PE_LoadGainFile

int	PE_SaveGainFile

int	PE_UsePixelCorrection

int	PE_PixelCorrectionAvailable

int	PE_PixelCorrectionFile

int	PE_LoadPixelCorrectionFile

int	PE_Gain

int	PE_NumFrameBuffers

int	PE_Trigger

int	PE_SyncMode

int	PE_FrameBufferIndex

int	PE_ImageNumber

int	PE_SkipFrames

int	PE_NumFramesToSkip

int	PE_TriggerOutSignal

int	PE_TriggerOutEPLength

int	PE_TriggerOutEPFirstFrame

int	PE_TriggerOutEPLastFrame

int	PE_TriggerOutEPDelay1

int	PE_TriggerOutEPDelay2

int	PE_TriggerOutDDDDelay

int	PE_TriggerOutEdge

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_

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

Detailed Description

Driver for the Perkin Elmer flat panel amorphous silicon detectors.

Constructor & Destructor Documentation

◆ PerkinElmer()

PerkinElmer::PerkinElmer	(	const char *	portName,
		int	IDType,
		const char *	IDValue,
		int	maxBuffers,
		size_t	maxMemory,
		int	priority,
		int	stackSize
	)

Constructor for Perkin Elmer driver; most parameters are simply passed to ADDriver::ADDriver.

After calling the base class constructor this method creates a thread to collect the detector data, and sets reasonable default values the parameters defined in this class, asynNDArrayDriver, and ADDriver.

Parameters

[in]	portName	The name of the asyn port driver to be created.
[in]	IDType	The type of system ID being specifed in IDValue. Allowed values are: IDType = 0 Frame grabber card or directly connected GigE detector, IDValue = detector index # in system. IDType = 1 GigE detector, IDValue = IP address (e.g. 164.54.160.21) IDType = 2 GigE detector, IDValue = MAC address (e.g. 00005b032e6b, must be lower-case letters) IDType = 3 GigE detector, IDValue = device name (e.g. 8#2608).
[in]	IDValue	The detector ID as explained above (index #, IP name, MAC address, or device name) For IDType=0 then if IDValue="" then the first detector found in the system will be used. For IDType=3 the available device names on the network can be found with the command "asynReport 1 portName"
[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.

◆ ~PerkinElmer()

PerkinElmer::~PerkinElmer ( )

Destructor for Perkin Elmer driver; most parameters are simply passed to ADDriver::ADDriver.

Frees all resources and calls Acquisition_Close()

Member Function Documentation

◆ acquireStopTask()

void PerkinElmer::acquireStopTask ( void )

◆ endAcqCallback()

void PerkinElmer::endAcqCallback ( HACQDESC hAcqDesc )

callback function that is called by XISL at end of acquisition

◆ endFrameCallback()

void PerkinElmer::endFrameCallback ( HACQDESC hAcqDesc )

callback function that is called by XISL every frame at end of data transfer

Find offset into secondary frame buffer

Correct for detector offset and gain as necessary

Correct for dead pixels as necessary

◆ report()

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

virtual

Report status of the driver.

Prints details about the detector in us if details>0. Prints information about all local and network detectors if details>1. It then calls the ADDriver::report() method.

Parameters

[in]	fp	File pointed passed by caller where the output is written to.
[in]	details	Controls the level of detail in the report.

Reimplemented from asynNDArrayDriver.

◆ writeFloat64()

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

◆ writeInt32()

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

virtual

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

This function performs actions for some parameters, including ADAcquire, ADBinX, etc. 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 ADDriver.

Member Data Documentation

◆ PE_AcquireGain

int PerkinElmer::PE_AcquireGain

protected

◆ PE_AcquireOffset

int PerkinElmer::PE_AcquireOffset

protected

◆ PE_CorrectionsDirectory

int PerkinElmer::PE_CorrectionsDirectory

protected

◆ PE_CurrentGainFrame

int PerkinElmer::PE_CurrentGainFrame

protected

◆ PE_CurrentOffsetFrame

int PerkinElmer::PE_CurrentOffsetFrame

protected

◆ PE_FrameBufferIndex

int PerkinElmer::PE_FrameBufferIndex

protected

◆ PE_Gain

int PerkinElmer::PE_Gain

protected

◆ PE_GainAvailable

int PerkinElmer::PE_GainAvailable

protected

◆ PE_GainFile

int PerkinElmer::PE_GainFile

protected

◆ PE_ImageNumber

int PerkinElmer::PE_ImageNumber

protected

◆ PE_Initialize

int PerkinElmer::PE_Initialize

protected

◆ PE_LoadGainFile

int PerkinElmer::PE_LoadGainFile

protected

◆ PE_LoadPixelCorrectionFile

int PerkinElmer::PE_LoadPixelCorrectionFile

protected

◆ PE_NumFrameBuffers

int PerkinElmer::PE_NumFrameBuffers

protected

◆ PE_NumFramesToSkip

int PerkinElmer::PE_NumFramesToSkip

protected

◆ PE_NumGainFrames

int PerkinElmer::PE_NumGainFrames

protected

◆ PE_NumOffsetFrames

int PerkinElmer::PE_NumOffsetFrames

protected

◆ PE_OffsetAvailable

int PerkinElmer::PE_OffsetAvailable

protected

◆ PE_OffsetConstant

int PerkinElmer::PE_OffsetConstant

protected

◆ PE_PixelCorrectionAvailable

int PerkinElmer::PE_PixelCorrectionAvailable

protected

◆ PE_PixelCorrectionFile

int PerkinElmer::PE_PixelCorrectionFile

protected

◆ PE_SaveGainFile

int PerkinElmer::PE_SaveGainFile

protected

◆ PE_SkipFrames

int PerkinElmer::PE_SkipFrames

protected

◆ PE_SyncMode

int PerkinElmer::PE_SyncMode

protected

◆ PE_Trigger

int PerkinElmer::PE_Trigger

protected

◆ PE_TriggerOutDDDDelay

int PerkinElmer::PE_TriggerOutDDDDelay

protected

◆ PE_TriggerOutEdge

int PerkinElmer::PE_TriggerOutEdge

protected

◆ PE_TriggerOutEPDelay1

int PerkinElmer::PE_TriggerOutEPDelay1

protected

◆ PE_TriggerOutEPDelay2

int PerkinElmer::PE_TriggerOutEPDelay2

protected

◆ PE_TriggerOutEPFirstFrame

int PerkinElmer::PE_TriggerOutEPFirstFrame

protected

◆ PE_TriggerOutEPLastFrame

int PerkinElmer::PE_TriggerOutEPLastFrame

protected

◆ PE_TriggerOutEPLength

int PerkinElmer::PE_TriggerOutEPLength

protected

◆ PE_TriggerOutSignal

int PerkinElmer::PE_TriggerOutSignal

protected

◆ PE_UseGain

int PerkinElmer::PE_UseGain

protected

◆ PE_UseOffset

int PerkinElmer::PE_UseOffset

protected

◆ PE_UsePixelCorrection

int PerkinElmer::PE_UsePixelCorrection

protected

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

/home/runner/work/areaDetector/areaDetector/ADPerkinElmer/perkinElmerApp/src/PerkinElmer.h
/home/runner/work/areaDetector/areaDetector/ADPerkinElmer/perkinElmerApp/src/PerkinElmer.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PerkinElmer()

◆ ~PerkinElmer()

Member Function Documentation

◆ acquireStopTask()

◆ endAcqCallback()

◆ endFrameCallback()

◆ report()

◆ writeFloat64()

◆ writeInt32()

Member Data Documentation

◆ PE_AcquireGain

◆ PE_AcquireOffset

◆ PE_CorrectionsDirectory

◆ PE_CurrentGainFrame

◆ PE_CurrentOffsetFrame

◆ PE_FrameBufferIndex

◆ PE_Gain

◆ PE_GainAvailable

◆ PE_GainFile

◆ PE_ImageNumber

◆ PE_Initialize

◆ PE_LoadGainFile

◆ PE_LoadPixelCorrectionFile

◆ PE_NumFrameBuffers

◆ PE_NumFramesToSkip

◆ PE_NumGainFrames

◆ PE_NumOffsetFrames

◆ PE_OffsetAvailable

◆ PE_OffsetConstant

◆ PE_PixelCorrectionAvailable

◆ PE_PixelCorrectionFile

◆ PE_SaveGainFile

◆ PE_SkipFrames

◆ PE_SyncMode

◆ PE_Trigger

◆ PE_TriggerOutDDDDelay

◆ PE_TriggerOutEdge

◆ PE_TriggerOutEPDelay1

◆ PE_TriggerOutEPDelay2

◆ PE_TriggerOutEPFirstFrame

◆ PE_TriggerOutEPLastFrame

◆ PE_TriggerOutEPLength

◆ PE_TriggerOutSignal

◆ PE_UseGain

◆ PE_UseOffset

◆ PE_UsePixelCorrection