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 TIFF files to get the image data, and does the callbacks to send it to higher layers.

Protected Attributes

int PilatusDelayTime
int PilatusThreshold
int PilatusArmed
int PilatusTiffTimeout
int PilatusBadPixelFile
int PilatusNumBadPixels
int PilatusFlatFieldFile
int PilatusMinFlatField
int PilatusFlatFieldValid


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] portName The name of the asyn port driver to be created.
[in] camserverPort The name of the asyn port previously created with drvAsynIPPortConfigure to communicate with camserver.
[in] maxSizeX The size of the Pilatus detector in the X direction.
[in] maxSizeY The size of the Pilatus detector in the Y direction.
[in] portName The name of the asyn port driver to be created.
[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

void pilatusDetector::pilatusTask (  ) 

This thread controls acquisition, reads TIFF 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] fp File pointed passed by caller where the output is written to.
[in] details If >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] pasynUser pasynUser structure that encodes the reason and address.
[in] value Value 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] pasynUser pasynUser structure that encodes the reason and address.
[in] value Value 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] 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


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

Generated on Thu May 20 18:01:44 2010 for areaDetector by  doxygen 1.5.7.1