areaDetector  3-12-1
EPICS areaDetector framework
Public Member Functions | Protected Attributes | List of all members
merlinDetector Class Reference

Driver for Dectris merlin pixel array detectors using their Labview server over TCP/IP socket. More...

#include <merlinDetector.h>

Inheritance diagram for merlinDetector:
ADDriver asynNDArrayDriver

Public Member Functions

 merlinDetector (const char *portName, const char *LabviewCmdPort, const char *LabviewDataPort, int maxSizeX, int maxSizeY, int detectorType, int maxBuffers, size_t maxMemory, int priority, int stackSize)
 Constructor for merlin 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 merlinTask ()
 This thread controls acquisition, reads image files to get the image data, and does the callbacks to send it to higher layers It is totally decoupled from the command thread and simply waits for data frames to be sent on the data channel (TCP) regardless of the state in the command thread and TCP channel. More...
 
void merlinStatus ()
 This thread periodically read the detector status (temperature, humidity, etc.) It does not run if we are acquiring data, to avoid polling Labview when taking data. More...
 
void fromLabViewStr (const char *str)
 
void toLabViewStr (const char *str)
 
- 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 readInt32 (asynUser *pasynUser, epicsInt32 *value)
 
virtual asynStatus readFloat64 (asynUser *pasynUser, epicsFloat64 *value)
 
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...
 
asynStatus incrementQueuedArrayCount ()
 
asynStatus decrementQueuedArrayCount ()
 
int getQueuedArrayCount ()
 
void updateQueuedArrayCount ()
 

Protected Attributes

int merlinDelayTime
 
int merlinThreshold0
 
int merlinThreshold1
 
int merlinThreshold2
 
int merlinThreshold3
 
int merlinThreshold4
 
int merlinThreshold5
 
int merlinThreshold6
 
int merlinThreshold7
 
int merlinOperatingEnergy
 
int merlinThresholdApply
 
int merlinThresholdAutoApply
 
int merlinArmed
 
int merlinThresholdScan
 
int merlinStartThresholdScan
 
int merlinStopThresholdScan
 
int merlinStepThresholdScan
 
int merlinTvxVersion
 
int merlinCounterDepth
 
int merlinSoftwareTrigger
 
int merlinReset
 
int merlinEnableCounter1
 
int merlinContinuousRW
 
int merlinProfileControl
 
int merlinProfileX
 
int merlinProfileY
 
int merlinEnableBackgroundCorr
 
int merlinEnableImageSum
 
int merlinQuadMerlinMode
 
int merlinSelectGui
 
- 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 NDFileCapture
 
int NDFileDeleteDriverFile
 
int NDFileLazyOpen
 
int NDFileCreateDir
 
int NDFileTempSuffix
 
int NDAttributesFile
 
int NDAttributesStatus
 
int NDAttributesMacros
 
int NDArrayData
 
int NDArrayCallbacks
 
int NDPoolMaxBuffers
 
int NDPoolAllocBuffers
 
int NDPoolFreeBuffers
 
int NDPoolMaxMemory
 
int NDPoolUsedMemory
 
int NDPoolEmptyFreeList
 
int NDNumQueuedArrays
 
class NDArray ** pArrays
 An array of NDArray pointers used to store data in the driver. More...
 
class NDAttributeListpAttributeList
 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 NDArrayPoolpNDArrayPool
 An NDArrayPool pointer that is initialized to pNDArrayPoolPvt_ in the constructor. More...
 

Detailed Description

Driver for Dectris merlin pixel array detectors using their Labview server over TCP/IP socket.

Constructor & Destructor Documentation

◆ merlinDetector()

merlinDetector::merlinDetector ( const char *  portName,
const char *  LabviewCommandPort,
const char *  LabviewDataPort,
int  maxSizeX,
int  maxSizeY,
int  detectorType,
int  maxBuffers,
size_t  maxMemory,
int  priority,
int  stackSize 
)

Constructor for merlin 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]portNameThe name of the asyn port driver to be created.
[in]LabviewCommandPortThe name of the asyn port previously created with drvAsynIPPortConfigure to communicate with Labview.
[in]LabviewDataPortThe name of the asyn port previously created with drvAsynIPPortConfigure to communicate with Labview.
[in]maxSizeXThe size of the merlin detector in the X direction.
[in]maxSizeYThe size of the merlin detector in the Y direction.
[in]detectorTypeThe detector type (Marlin, MerlinXBPM, etc.)
[in]maxBuffersThe 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]maxMemoryThe 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]priorityThe thread priority for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.
[in]stackSizeThe stack size for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.

Member Function Documentation

◆ fromLabViewStr()

void merlinDetector::fromLabViewStr ( const char *  str)

◆ merlinStatus()

void merlinDetector::merlinStatus ( )

This thread periodically read the detector status (temperature, humidity, etc.) It does not run if we are acquiring data, to avoid polling Labview when taking data.

◆ merlinTask()

void merlinDetector::merlinTask ( )

This thread controls acquisition, reads image files to get the image data, and does the callbacks to send it to higher layers It is totally decoupled from the command thread and simply waits for data frames to be sent on the data channel (TCP) regardless of the state in the command thread and TCP channel.

◆ report()

void merlinDetector::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]fpFile pointed passed by caller where the output is written to.
[in]detailsIf >0 then driver details are printed.

Reimplemented from asynNDArrayDriver.

◆ toLabViewStr()

void merlinDetector::toLabViewStr ( const char *  str)

◆ writeFloat64()

asynStatus merlinDetector::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]pasynUserpasynUser structure that encodes the reason and address.
[in]valueValue to write.

◆ writeInt32()

asynStatus merlinDetector::writeInt32 ( asynUser *  pasynUser,
epicsInt32  value 
)
virtual

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

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

Parameters
[in]pasynUserpasynUser structure that encodes the reason and address.
[in]valueValue to write.

Reimplemented from ADDriver.

Member Data Documentation

◆ merlinArmed

int merlinDetector::merlinArmed
protected

◆ merlinContinuousRW

int merlinDetector::merlinContinuousRW
protected

◆ merlinCounterDepth

int merlinDetector::merlinCounterDepth
protected

◆ merlinDelayTime

int merlinDetector::merlinDelayTime
protected

◆ merlinEnableBackgroundCorr

int merlinDetector::merlinEnableBackgroundCorr
protected

◆ merlinEnableCounter1

int merlinDetector::merlinEnableCounter1
protected

◆ merlinEnableImageSum

int merlinDetector::merlinEnableImageSum
protected

◆ merlinOperatingEnergy

int merlinDetector::merlinOperatingEnergy
protected

◆ merlinProfileControl

int merlinDetector::merlinProfileControl
protected

◆ merlinProfileX

int merlinDetector::merlinProfileX
protected

◆ merlinProfileY

int merlinDetector::merlinProfileY
protected

◆ merlinQuadMerlinMode

int merlinDetector::merlinQuadMerlinMode
protected

◆ merlinReset

int merlinDetector::merlinReset
protected

◆ merlinSelectGui

int merlinDetector::merlinSelectGui
protected

◆ merlinSoftwareTrigger

int merlinDetector::merlinSoftwareTrigger
protected

◆ merlinStartThresholdScan

int merlinDetector::merlinStartThresholdScan
protected

◆ merlinStepThresholdScan

int merlinDetector::merlinStepThresholdScan
protected

◆ merlinStopThresholdScan

int merlinDetector::merlinStopThresholdScan
protected

◆ merlinThreshold0

int merlinDetector::merlinThreshold0
protected

◆ merlinThreshold1

int merlinDetector::merlinThreshold1
protected

◆ merlinThreshold2

int merlinDetector::merlinThreshold2
protected

◆ merlinThreshold3

int merlinDetector::merlinThreshold3
protected

◆ merlinThreshold4

int merlinDetector::merlinThreshold4
protected

◆ merlinThreshold5

int merlinDetector::merlinThreshold5
protected

◆ merlinThreshold6

int merlinDetector::merlinThreshold6
protected

◆ merlinThreshold7

int merlinDetector::merlinThreshold7
protected

◆ merlinThresholdApply

int merlinDetector::merlinThresholdApply
protected

◆ merlinThresholdAutoApply

int merlinDetector::merlinThresholdAutoApply
protected

◆ merlinThresholdScan

int merlinDetector::merlinThresholdScan
protected

◆ merlinTvxVersion

int merlinDetector::merlinTvxVersion
protected

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