Class to wrap Lambda detector library provided by X-Spectrum. More...

#include <ADLambda.h>

Inheritance diagram for ADLambda:

Public Member Functions
	ADLambda (const char portName, const char configPath, int numModules, int fake)
	Constructor. More...

	~ADLambda ()

virtual asynStatus	disconnect ()

virtual asynStatus	connect ()

void	waitAcquireThread ()
	Background thread to wait until an acquire signal is recieved. More...

void	tryConnect ()

void	acquireThread (int receiver)
	Thread spawned per detector module, acquires frames from indexed receiver and copies the data to the correct spot in the stitched image. More...

void	acquireDecoderThread ()

void	exportThread ()
	Thread to pull and export NDArrays being generated by the acquisition threads. More...

void	report (FILE *fp, int details)
	Override super class's report method to provide detector specific info. More...

virtual asynStatus	writeInt32 (asynUser *pasynUser, epicsInt32 value)
	Override from super class to handle detector specific parameters. 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 ()

Static Public Attributes
static const char *	driverName = "Lambda"

Protected Attributes
int	LAMBDA_ConfigFilePath

int	LAMBDA_DecoderDetected

int	LAMBDA_EnergyThreshold

int	LAMBDA_DualThreshold

int	LAMBDA_DecodedQueueDepth

int	LAMBDA_OperatingMode

int	LAMBDA_DualMode

int	LAMBDA_ChargeSumming

int	LAMBDA_GatingEnable

int	LAMBDA_BadFrameCounter

int	LAMBDA_BadImage

int	LAMBDA_ReadoutThreads

int	LAMBDA_StitchedWidth

int	LAMBDA_StitchedHeight

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

Class to wrap Lambda detector library provided by X-Spectrum.

Constructor & Destructor Documentation

◆ ADLambda()

ADLambda::ADLambda	(	const char *	portName,
		const char *	configPath,
		int	numModules,
		int	fake
	)

Constructor.

Parameters

[in]	portName	The name of the asyn port driver to be created.
[in]	configPath	directory containing configuration file location
[in]	numModules	The number of individual camera modules the system contains

◆ ~ADLambda()

ADLambda::~ADLambda ( )

Member Function Documentation

◆ acquireDecoderThread()

void ADLambda::acquireDecoderThread ( )

◆ acquireThread()

void ADLambda::acquireThread ( int receiver )

Thread spawned per detector module, acquires frames from indexed receiver and copies the data to the correct spot in the stitched image.

Grab parameters that will be used for the entirety of the acquisition

◆ connect()

asynStatus ADLambda::connect ( )

virtual

◆ disconnect()

asynStatus ADLambda::disconnect ( )

virtual

◆ exportThread()

void ADLambda::exportThread ( )

Thread to pull and export NDArrays being generated by the acquisition threads.

◆ report()

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

virtual

Override super class's report method to provide detector specific info.

When done, call ADDriver (direct super class) method to provide info from the upper classes.

Reimplemented from asynNDArrayDriver.

◆ tryConnect()

void ADLambda::tryConnect ( )

Set up Detector

◆ waitAcquireThread()

void ADLambda::waitAcquireThread ( )

Background thread to wait until an acquire signal is recieved.

Afterwards, start the acquisition and create an acquire thread for each receiver. Then, wait until the threads all finish.

◆ writeInt32()

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

virtual

Override from super class to handle detector specific parameters.

If the parameter is from one of the super classes and is not handled here, then pass along to ADDriver (direct super class)

Make sure that we write the value to the param

Reimplemented from ADDriver.

Member Data Documentation

◆ driverName

const char * ADLambda::driverName = "Lambda"

static

◆ LAMBDA_BadFrameCounter

int ADLambda::LAMBDA_BadFrameCounter

protected

◆ LAMBDA_BadImage

int ADLambda::LAMBDA_BadImage

protected

◆ LAMBDA_ChargeSumming

int ADLambda::LAMBDA_ChargeSumming

protected

◆ LAMBDA_ConfigFilePath

int ADLambda::LAMBDA_ConfigFilePath

protected

◆ LAMBDA_DecodedQueueDepth

int ADLambda::LAMBDA_DecodedQueueDepth

protected

◆ LAMBDA_DecoderDetected

int ADLambda::LAMBDA_DecoderDetected

protected

◆ LAMBDA_DualMode

int ADLambda::LAMBDA_DualMode

protected

◆ LAMBDA_DualThreshold

int ADLambda::LAMBDA_DualThreshold

protected

◆ LAMBDA_EnergyThreshold

int ADLambda::LAMBDA_EnergyThreshold

protected

◆ LAMBDA_GatingEnable

int ADLambda::LAMBDA_GatingEnable

protected

◆ LAMBDA_OperatingMode

int ADLambda::LAMBDA_OperatingMode

protected

◆ LAMBDA_ReadoutThreads

int ADLambda::LAMBDA_ReadoutThreads

protected

◆ LAMBDA_StitchedHeight

int ADLambda::LAMBDA_StitchedHeight

protected

◆ LAMBDA_StitchedWidth

int ADLambda::LAMBDA_StitchedWidth

protected

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

/home/runner/work/areaDetector/areaDetector/ADLambda/LambdaApp/src/ADLambda.h
/home/runner/work/areaDetector/areaDetector/ADLambda/LambdaApp/src/ADLambda.cpp

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ADLambda()

◆ ~ADLambda()

Member Function Documentation

◆ acquireDecoderThread()

◆ acquireThread()

◆ connect()

◆ disconnect()

◆ exportThread()

◆ report()

◆ tryConnect()

◆ waitAcquireThread()

◆ writeInt32()

Member Data Documentation

◆ driverName

◆ LAMBDA_BadFrameCounter

◆ LAMBDA_BadImage

◆ LAMBDA_ChargeSumming

◆ LAMBDA_ConfigFilePath

◆ LAMBDA_DecodedQueueDepth

◆ LAMBDA_DecoderDetected

◆ LAMBDA_DualMode

◆ LAMBDA_DualThreshold

◆ LAMBDA_EnergyThreshold

◆ LAMBDA_GatingEnable

◆ LAMBDA_OperatingMode

◆ LAMBDA_ReadoutThreads

◆ LAMBDA_StitchedHeight

◆ LAMBDA_StitchedWidth