Driver for Princeton Instruments cameras using the LightField Automation software. More...

Inheritance diagram for LightField:

Public Member Functions
	LightField (const char portName, const char experimentName, int maxBuffers, size_t maxMemory, int priority, int stackSize)
	Constructor for LightField 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...

virtual asynStatus	writeOctet (asynUser pasynUser, const char value, size_t nChars, size_t *nActual)
	Called when asyn clients call pasynOctet->write(). More...

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

virtual void	setShutter (int open)
	Set the shutter position. More...

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

void	setAcquisitionComplete ()

void	frameCallback (ImageDataSetReceivedEventArgs^ args)
	callback function that is called by XISL every frame at end of data transfer More...

void	settingChangedCallback (SettingChangedEventArgs^ args)

void	exitHandler (void *args)

void	pollerTask ()

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

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

int	LFNumAccumulations_

int	LFNumAcquisitions_

int	LFGrating_

int	LFGratingWavelength_

int	LFSAGEnable_

int	LFSAGStartingWavelength_

int	LFSAGEndingWavelength_

int	LFEntranceSideWidth_

int	LFEntranceSelected_

int	LFExitSelected_

int	LFExperimentName_

int	LFUpdateExperiments_

int	LFShutterMode_

int	LFBackgroundPath_

int	LFBackgroundPathExists_

int	LFBackgroundFile_

int	LFBackgroundFullFile_

int	LFBackgroundEnable_

int	LFIntensifierEnable_

int	LFIntensifierGain_

int	LFGatingMode_

int	LFTriggerFrequency_

int	LFSyncMasterEnable_

int	LFSyncMaster2Delay_

int	LFRepGateWidth_

int	LFRepGateDelay_

int	LFSeqStartGateWidth_

int	LFSeqStartGateDelay_

int	LFSeqEndGateWidth_

int	LFSeqEndGateDelay_

int	LFAuxWidth_

int	LFAuxDelay_

int	LFReadyToRun_

int	LFFilePath_

int	LFFileName_

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 Princeton Instruments cameras using the LightField Automation software.

Constructor & Destructor Documentation

◆ LightField()

LightField::LightField	(	const char *	portName,
		const char *	experimentName,
		int	maxBuffers,
		size_t	maxMemory,
		int	priority,
		int	stackSize
	)

Constructor for LightField 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 for the parameters defined in this class, asynNDArrayDriver and ADDriver.

Parameters

[in]	portName	The name of the asyn port driver to be created.
[in]	experimentName	The name of the experiment to open initially. Set this to an empty string to open the default experiment in LightField.
[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

◆ exitHandler()

void LightField::exitHandler ( void * args )

◆ frameCallback()

void LightField::frameCallback ( ImageDataSetReceivedEventArgs^ args )

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

◆ pollerTask()

void LightField::pollerTask ( )

◆ readEnum()

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

virtual

◆ report()

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

virtual

Report status of the driver.

Prints details about the driver if details>0. It then calls the ADDriver::report() method.

Parameters

[in]	fp	File pointed passed by caller where the output is written to.
[in]	details	If >0 then driver details are printed.

Reimplemented from asynNDArrayDriver.

◆ setAcquisitionComplete()

void LightField::setAcquisitionComplete ( )

◆ setShutter()

void LightField::setShutter ( int open )

virtual

Set the shutter position.

This method will open (1) or close (0) the shutter if ADShutterMode==ADShutterModeEPICS. Drivers will implement setShutter if they support ADShutterModeDetector. If ADShutterMode=ADShutterModeDetector they will control the shutter directly, else they will call this method.

Parameters

[in] open 1 (open) or 0 (closed)

Reimplemented from ADDriver.

◆ settingChangedCallback()

void LightField::settingChangedCallback ( SettingChangedEventArgs^ args )

◆ writeFloat64()

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

virtual

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

[in]	pasynUser	pasynUser structure that encodes the reason and address.
[in]	value	Value to write.

◆ writeInt32()

asynStatus LightField::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.

◆ writeOctet()

asynStatus LightField::writeOctet	(	asynUser *	pasynUser,
		const char *	value,
		size_t	nChars,
		size_t *	nActual
	)

virtual

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

This function performs actions for some parameters, including NDAttributesFile. 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	Address of the string to write.
[in]	nChars	Number of characters to write.
[out]	nActual	Number of characters actually written.

Reimplemented from asynNDArrayDriver.

Member Data Documentation

◆ LFAuxDelay_

int LightField::LFAuxDelay_

protected

◆ LFAuxWidth_

int LightField::LFAuxWidth_

protected

◆ LFBackgroundEnable_

int LightField::LFBackgroundEnable_

protected

◆ LFBackgroundFile_

int LightField::LFBackgroundFile_

protected

◆ LFBackgroundFullFile_

int LightField::LFBackgroundFullFile_

protected

◆ LFBackgroundPath_

int LightField::LFBackgroundPath_

protected

◆ LFBackgroundPathExists_

int LightField::LFBackgroundPathExists_

protected

◆ LFEntranceSelected_

int LightField::LFEntranceSelected_

protected

◆ LFEntranceSideWidth_

int LightField::LFEntranceSideWidth_

protected

◆ LFExitSelected_

int LightField::LFExitSelected_

protected

◆ LFExperimentName_

int LightField::LFExperimentName_

protected

◆ LFFileName_

int LightField::LFFileName_

protected

◆ LFFilePath_

int LightField::LFFilePath_

protected

◆ LFGain_

int LightField::LFGain_

protected

◆ LFGatingMode_

int LightField::LFGatingMode_

protected

◆ LFGrating_

int LightField::LFGrating_

protected

◆ LFGratingWavelength_

int LightField::LFGratingWavelength_

protected

◆ LFIntensifierEnable_

int LightField::LFIntensifierEnable_

protected

◆ LFIntensifierGain_

int LightField::LFIntensifierGain_

protected

◆ LFNumAccumulations_

int LightField::LFNumAccumulations_

protected

◆ LFNumAcquisitions_

int LightField::LFNumAcquisitions_

protected

◆ LFReadyToRun_

int LightField::LFReadyToRun_

protected

◆ LFRepGateDelay_

int LightField::LFRepGateDelay_

protected

◆ LFRepGateWidth_

int LightField::LFRepGateWidth_

protected

◆ LFSAGEnable_

int LightField::LFSAGEnable_

protected

◆ LFSAGEndingWavelength_

int LightField::LFSAGEndingWavelength_

protected

◆ LFSAGStartingWavelength_

int LightField::LFSAGStartingWavelength_

protected

◆ LFSeqEndGateDelay_

int LightField::LFSeqEndGateDelay_

protected

◆ LFSeqEndGateWidth_

int LightField::LFSeqEndGateWidth_

protected

◆ LFSeqStartGateDelay_

int LightField::LFSeqStartGateDelay_

protected

◆ LFSeqStartGateWidth_

int LightField::LFSeqStartGateWidth_

protected

◆ LFShutterMode_

int LightField::LFShutterMode_

protected

◆ LFSyncMaster2Delay_

int LightField::LFSyncMaster2Delay_

protected

◆ LFSyncMasterEnable_

int LightField::LFSyncMasterEnable_

protected

◆ LFTriggerFrequency_

int LightField::LFTriggerFrequency_

protected

◆ LFUpdateExperiments_

int LightField::LFUpdateExperiments_

protected

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

/home/runner/work/areaDetector/areaDetector/ADLightField/lightFieldApp/src/LightField.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LightField()

Member Function Documentation

◆ exitHandler()

◆ frameCallback()

◆ pollerTask()

◆ readEnum()

◆ report()

◆ setAcquisitionComplete()

◆ setShutter()

◆ settingChangedCallback()

◆ writeFloat64()

◆ writeInt32()

◆ writeOctet()

Member Data Documentation

◆ LFAuxDelay_

◆ LFAuxWidth_

◆ LFBackgroundEnable_

◆ LFBackgroundFile_

◆ LFBackgroundFullFile_

◆ LFBackgroundPath_

◆ LFBackgroundPathExists_

◆ LFEntranceSelected_

◆ LFEntranceSideWidth_

◆ LFExitSelected_

◆ LFExperimentName_

◆ LFFileName_

◆ LFFilePath_

◆ LFGain_

◆ LFGatingMode_

◆ LFGrating_

◆ LFGratingWavelength_

◆ LFIntensifierEnable_

◆ LFIntensifierGain_

◆ LFNumAccumulations_

◆ LFNumAcquisitions_

◆ LFReadyToRun_

◆ LFRepGateDelay_

◆ LFRepGateWidth_

◆ LFSAGEnable_

◆ LFSAGEndingWavelength_

◆ LFSAGStartingWavelength_

◆ LFSeqEndGateDelay_

◆ LFSeqEndGateWidth_

◆ LFSeqStartGateDelay_

◆ LFSeqStartGateWidth_

◆ LFShutterMode_

◆ LFSyncMaster2Delay_

◆ LFSyncMasterEnable_

◆ LFTriggerFrequency_

◆ LFUpdateExperiments_