adsc Class Reference

Driver for ADSC detectors (Q4, Q4r, Q210, Q210r, Q270, Q315, Q315r). More...

Inheritance diagram for adsc:

Public Member Functions
	adsc (const char *portName, const char *modelName)
	Constructor for ADSC driver; most parameters are simply passed to ADDriver::ADDriver. More...
virtual	~adsc ()
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	imageAcquisitionTask ()
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 Member Functions
AdscStatus_t	acquireImages ()
void	acquisitionFinished (int adstatus)
void	clearLastDarksParameters ()
AdscStatus_t	createFileNameNoIncrement (char *dst, size_t dstSize)
const char *	getAdscCcdStateString (int ccdState)
AdscStatus_t	getImage (int lastImage)
int	getImageSize (AdscModel_t model, int binMode)
int	getImageSizeX (AdscModel_t model, int binMode)
int	getImageSizeY (AdscModel_t model, int binMode)
AdscStatus_t	loadPerDatasetParameters ()
AdscStatus_t	loadPerImageParameters ()
AdscStatus_t	readDetectorCondition ()
AdscStatus_t	resetControlLibrary ()
AdscStatus_t	setBinModeInParams (int binMode)
void	setLastDarksParameters (double exposureTime, int adc, int bin)
AdscStatus_t	setOkToExpose (int isEnabled)
AdscStatus_t	setExternSwTriggerControl (AdscExternSwTriggerControl_t value)
int	shouldTakeDarks ()
AdscStatus_t	startExposure ()
AdscStatus_t	stopExposure ()
AdscStatus_t	takeDarks (const char *destDir)
AdscStatus_t	takeDarksIfRequired ()
AdscStatus_t	takeImage (const char *fullFileName, int imageKind, int lastImage, int triggerMode)
AdscStatus_t	imageAcquired ()
AdscStatus_t	waitForDetectorState (int desiredState, double timeout, int failOnErrorState)
AdscStatus_t	waitForExternalTrigger (epicsEventId eventId)
AdscStatus_t	writeDetectorParametersBeforeDataset ()
AdscStatus_t	writeDetectorParametersBeforeImage ()

Protected Attributes
int	AdscReadCondition
int	AdscState
int	AdscStatus
int	AdscLastError
int	AdscSoftwareReset
int	AdscLastImage
int	AdscOkToExpose
int	AdscExternSwTriggerControl
int	AdscReuseDarks
int	AdscDezinger
int	AdscAdc
int	AdscRaw
int	AdscImageTransform
int	AdscStoredDarks
int	AdscBeamCenterX
int	AdscBeamCenterY
int	AdscDistance
int	AdscTwoTheta
int	AdscAxis
int	AdscWavelength
int	AdscImageWidth
int	AdscPhi
int	AdscOmega
int	AdscKappa
int	AdscPrivateStopExpRetryCnt
AdscModel_t	model
int	lastImage
double	lastDarksExposureTime
int	lastDarksAdc
int	lastDarksBin
int	perDatasetReuseDarks
int	perDatasetDezinger
int	perDatasetAdc
int	perDatasetRaw
int	perDatasetImageTransform
int	perDatasetStoredDarks
int	perDatasetAxis
double	perDatasetExposureTime
double	perDatasetAcquirePeriod
int	perDatasetBin
int	perDatasetImageMode
int	perDatasetTriggerMode
int	perDatasetNumImages
double	perImageBeamCenterX
double	perImageBeamCenterY
double	perImageDistance
double	perImageTwoTheta
double	perImageWavelength
double	perImageImageWidth
double	perImagePhi
double	perImageOmega
double	perImageKappa
char	perImageFullFileName [MAX_FILENAME_LEN]
epicsEventId	startEventId
epicsEventId	stopEventId
epicsEventId	startTriggerEventId
epicsEventId	stopTriggerEventId
epicsEventId	lastImageEventId
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 ADSC detectors (Q4, Q4r, Q210, Q210r, Q270, Q315, Q315r).

Constructor & Destructor Documentation

adsc()

adsc::adsc	(	const char *	portName,
		const char *	modelName
	)

Constructor for ADSC 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]	modelName	The model name of the detector being used; choices are "Q4", "Q4r", "Q210", "Q210r", "Q270", "Q315", or "Q315r"

~adsc()

adsc::~adsc ( )

virtual

Member Function Documentation

acquireImages()

AdscStatus_t adsc::acquireImages ( )

protected

acquisitionFinished()

void adsc::acquisitionFinished ( int  adstatus )

protected

clearLastDarksParameters()

void adsc::clearLastDarksParameters ( )

protected

createFileNameNoIncrement()

AdscStatus_t adsc::createFileNameNoIncrement ( char *  dst, size_t  dstSize  )

protected

getAdscCcdStateString()

const char * adsc::getAdscCcdStateString ( int  ccdState )

protected

getImage()

AdscStatus_t adsc::getImage ( int  lastImage )

protected

getImageSize()

int adsc::getImageSize ( AdscModel_t  model, int  binMode  )

protected

getImageSizeX()

int adsc::getImageSizeX ( AdscModel_t  model, int  binMode  )

protected

getImageSizeY()

int adsc::getImageSizeY ( AdscModel_t  model, int  binMode  )

protected

imageAcquired()

AdscStatus_t adsc::imageAcquired ( )

protected

imageAcquisitionTask()

void adsc::imageAcquisitionTask

(

)

loadPerDatasetParameters()

AdscStatus_t adsc::loadPerDatasetParameters ( )

protected

loadPerImageParameters()

AdscStatus_t adsc::loadPerImageParameters ( )

protected

readDetectorCondition()

AdscStatus_t adsc::readDetectorCondition ( )

protected

report()

void adsc::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.

resetControlLibrary()

AdscStatus_t adsc::resetControlLibrary ( )

protected

setBinModeInParams()

AdscStatus_t adsc::setBinModeInParams ( int  binMode )

protected

setExternSwTriggerControl()

AdscStatus_t adsc::setExternSwTriggerControl ( AdscExternSwTriggerControl_t  value )

protected

setLastDarksParameters()

void adsc::setLastDarksParameters ( double  exposureTime, int  adc, int  bin  )

protected

setOkToExpose()

AdscStatus_t adsc::setOkToExpose ( int  isEnabled )

protected

shouldTakeDarks()

int adsc::shouldTakeDarks ( )

protected

startExposure()

AdscStatus_t adsc::startExposure ( )

protected

stopExposure()

AdscStatus_t adsc::stopExposure ( )

protected

takeDarks()

AdscStatus_t adsc::takeDarks ( const char *  destDir )

protected

takeDarksIfRequired()

AdscStatus_t adsc::takeDarksIfRequired ( )

protected

takeImage()

AdscStatus_t adsc::takeImage ( const char *  fullFileName, int  imageKind, int  lastImage, int  triggerMode  )

protected

waitForDetectorState()

AdscStatus_t adsc::waitForDetectorState ( int  desiredState, double  timeout, int  failOnErrorState  )

protected

waitForExternalTrigger()

AdscStatus_t adsc::waitForExternalTrigger ( epicsEventId  eventId )

protected

writeDetectorParametersBeforeDataset()

AdscStatus_t adsc::writeDetectorParametersBeforeDataset ( )

protected

writeDetectorParametersBeforeImage()

AdscStatus_t adsc::writeDetectorParametersBeforeImage ( )

protected

writeFloat64()

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

virtual

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

This function performs actions for some parameters, including ADAcquireTime, AdscTwoTheta, 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 adsc::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

AdscAdc

int adsc::AdscAdc

protected

AdscAxis

int adsc::AdscAxis

protected

AdscBeamCenterX

int adsc::AdscBeamCenterX

protected

AdscBeamCenterY

int adsc::AdscBeamCenterY

protected

AdscDezinger

int adsc::AdscDezinger

protected

AdscDistance

int adsc::AdscDistance

protected

AdscExternSwTriggerControl

int adsc::AdscExternSwTriggerControl

protected

AdscImageTransform

int adsc::AdscImageTransform

protected

AdscImageWidth

int adsc::AdscImageWidth

protected

AdscKappa

int adsc::AdscKappa

protected

AdscLastError

int adsc::AdscLastError

protected

AdscLastImage

int adsc::AdscLastImage

protected

AdscOkToExpose

int adsc::AdscOkToExpose

protected

AdscOmega

int adsc::AdscOmega

protected

AdscPhi

int adsc::AdscPhi

protected

AdscPrivateStopExpRetryCnt

int adsc::AdscPrivateStopExpRetryCnt

protected

AdscRaw

int adsc::AdscRaw

protected

AdscReadCondition

int adsc::AdscReadCondition

protected

AdscReuseDarks

int adsc::AdscReuseDarks

protected

AdscSoftwareReset

int adsc::AdscSoftwareReset

protected

AdscState

int adsc::AdscState

protected

AdscStatus

int adsc::AdscStatus

protected

AdscStoredDarks

int adsc::AdscStoredDarks

protected

AdscTwoTheta

int adsc::AdscTwoTheta

protected

AdscWavelength

int adsc::AdscWavelength

protected

lastDarksAdc

int adsc::lastDarksAdc

protected

lastDarksBin

int adsc::lastDarksBin

protected

lastDarksExposureTime

double adsc::lastDarksExposureTime

protected

lastImage

int adsc::lastImage

protected

lastImageEventId

epicsEventId adsc::lastImageEventId

protected

model

AdscModel_t adsc::model

protected

perDatasetAcquirePeriod

double adsc::perDatasetAcquirePeriod

protected

perDatasetAdc

int adsc::perDatasetAdc

protected

perDatasetAxis

int adsc::perDatasetAxis

protected

perDatasetBin

int adsc::perDatasetBin

protected

perDatasetDezinger

int adsc::perDatasetDezinger

protected

perDatasetExposureTime

double adsc::perDatasetExposureTime

protected

perDatasetImageMode

int adsc::perDatasetImageMode

protected

perDatasetImageTransform

int adsc::perDatasetImageTransform

protected

perDatasetNumImages

int adsc::perDatasetNumImages

protected

perDatasetRaw

int adsc::perDatasetRaw

protected

perDatasetReuseDarks

int adsc::perDatasetReuseDarks

protected

perDatasetStoredDarks

int adsc::perDatasetStoredDarks

protected

perDatasetTriggerMode

int adsc::perDatasetTriggerMode

protected

perImageBeamCenterX

double adsc::perImageBeamCenterX

protected

perImageBeamCenterY

double adsc::perImageBeamCenterY

protected

perImageDistance

double adsc::perImageDistance

protected

perImageFullFileName

char adsc::perImageFullFileName[MAX_FILENAME_LEN]

protected

perImageImageWidth

double adsc::perImageImageWidth

protected

perImageKappa

double adsc::perImageKappa

protected

perImageOmega

double adsc::perImageOmega

protected

perImagePhi

double adsc::perImagePhi

protected

perImageTwoTheta

double adsc::perImageTwoTheta

protected

perImageWavelength

double adsc::perImageWavelength

protected

startEventId

epicsEventId adsc::startEventId

protected

startTriggerEventId

epicsEventId adsc::startTriggerEventId

protected

stopEventId

epicsEventId adsc::stopEventId

protected

stopTriggerEventId

epicsEventId adsc::stopTriggerEventId

protected

---

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

• /home/runner/work/areaDetector/areaDetector/ADADSC/adscApp/src/adsc.cpp