areaDetector 1-9
Public Member Functions | Protected Attributes
pilatusDetector Class Reference

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

Inheritance diagram for pilatusDetector:
ADDriver asynNDArrayDriver asynPortDriver

List of all members.

Public Member Functions

 pilatusDetector (const char *portName, const char *camserverPort, int maxSizeX, int maxSizeY, int maxBuffers, size_t maxMemory, int priority, int stackSize)
 Constructor for Pilatus driver; most parameters are simply passed to ADDriver::ADDriver.
virtual asynStatus writeInt32 (asynUser *pasynUser, epicsInt32 value)
 Called when asyn clients call pasynInt32->write().
virtual asynStatus writeFloat64 (asynUser *pasynUser, epicsFloat64 value)
 Called when asyn clients call pasynFloat64->write().
virtual asynStatus writeOctet (asynUser *pasynUser, const char *value, size_t nChars, size_t *nActual)
 Called when asyn clients call pasynOctet->write().
void report (FILE *fp, int details)
 Report status of the driver.
void pilatusTask ()
 This thread controls acquisition, reads image files to get the image data, and does the callbacks to send it to higher layers.
void pilatusStatus ()
 This thread periodically read the detector status (temperature, humidity, etc.) It does not run if we are acquiring data, to avoid polling camserver when taking data.

Protected Attributes

int PilatusDelayTime
int PilatusThreshold
int PilatusThresholdApply
int PilatusThresholdAutoApply
int PilatusArmed
int PilatusImageFileTmot
int PilatusBadPixelFile
int PilatusNumBadPixels
int PilatusFlatFieldFile
int PilatusMinFlatField
int PilatusFlatFieldValid
int PilatusGapFill
int PilatusWavelength
int PilatusEnergyLow
int PilatusEnergyHigh
int PilatusDetDist
int PilatusDetVOffset
int PilatusBeamX
int PilatusBeamY
int PilatusFlux
int PilatusFilterTransm
int PilatusStartAngle
int PilatusAngleIncr
int PilatusDet2theta
int PilatusPolarization
int PilatusAlpha
int PilatusKappa
int PilatusPhi
int PilatusChi
int PilatusOscillAxis
int PilatusNumOscill
int PilatusPixelCutOff
int PilatusThTemp0
int PilatusThTemp1
int PilatusThTemp2
int PilatusThHumid0
int PilatusThHumid1
int PilatusThHumid2
int PilatusTvxVersion
int PilatusCbfTemplateFile
int PilatusHeaderString

Detailed Description

Driver for Dectris Pilatus pixel array detectors using their camserver server over TCP/IP socket.


Constructor & Destructor Documentation

pilatusDetector::pilatusDetector ( const char *  portName,
const char *  camserverPort,
int  maxSizeX,
int  maxSizeY,
int  maxBuffers,
size_t  maxMemory,
int  priority,
int  stackSize 
)

Constructor for Pilatus 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]camserverPortThe name of the asyn port previously created with drvAsynIPPortConfigure to communicate with camserver.
[in]maxSizeXThe size of the Pilatus detector in the X direction.
[in]maxSizeYThe size of the Pilatus detector in the Y direction.
[in]portNameThe name of the asyn port driver to be created.
[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

void pilatusDetector::pilatusStatus ( )

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

void pilatusDetector::pilatusTask ( )

This thread controls acquisition, reads image files to get the image data, and does the callbacks to send it to higher layers.

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

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

Reimplemented from asynPortDriver.

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

asynStatus pilatusDetector::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 PilatusBadPixelFile, ADFilePath, 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]valueAddress of the string to write.
[in]nCharsNumber of characters to write.
[out]nActualNumber of characters actually written.

Reimplemented from asynNDArrayDriver.


Member Data Documentation

int pilatusDetector::PilatusChi [protected]
int pilatusDetector::PilatusPhi [protected]

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