areaDetector 1-8
Public Member Functions | Public Attributes | Protected Attributes
marCCD Class Reference

Driver for marCCD (Rayonix) CCD detector; communicates with the marCCD program over a TCP/IP socket with the marccd_server_socket program that they distribute. More...

Inheritance diagram for marCCD:
ADDriver asynNDArrayDriver asynPortDriver

List of all members.

Public Member Functions

 marCCD (const char *portName, const char *marCCDPort, int maxBuffers, size_t maxMemory, int priority, int stackSize)
 Constructor for marCCD 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 void setShutter (int open)
 Set the shutter position.
virtual void report (FILE *fp, int details)
 Report status of the driver.
void marCCDTask ()
 This should be private but is called from C, must be public.
void getImageDataTask ()
 This should be private but is called from C, must be public.

Public Attributes

epicsEventId stopEventId
 This should be private but is accessed from C, must be public.

Protected Attributes

int marCCDTiffTimeout
int marCCDOverlap
int marCCDState
int marCCDStatus
int marCCDTaskAcquireStatus
int marCCDTaskReadoutStatus
int marCCDTaskCorrectStatus
int marCCDTaskWritingStatus
int marCCDTaskDezingerStatus
int marCCDStability
int marCCDFrameShift
int marCCDDetectorDistance
int marCCDBeamX
int marCCDBeamY
int marCCDStartPhi
int marCCDRotationAxis
int marCCDRotationRange
int marCCDTwoTheta
int marCCDWavelength
int marCCDFileComments
int marCCDDatasetComments

Detailed Description

Driver for marCCD (Rayonix) CCD detector; communicates with the marCCD program over a TCP/IP socket with the marccd_server_socket program that they distribute.

The marCCD program must be set into Acquire/Remote Control/Start to use this driver.


Constructor & Destructor Documentation

marCCD::marCCD ( const char *  portName,
const char *  serverPort,
int  maxBuffers,
size_t  maxMemory,
int  priority,
int  stackSize 
)

Constructor for marCCD 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 the parameters defined in this class, asynNDArrayDriver, and ADDriver.

Parameters:
[in]portNameThe name of the asyn port driver to be created.
[in]serverPortThe name of the asyn port driver previously created with drvAsynIPPortConfigure connected to the marccd_server program.
[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 marCCD::getImageDataTask ( )

This should be private but is called from C, must be public.

This task does the correction and file saving in the background, so that acquisition can be overlapped with these operations.

void marCCD::marCCDTask ( )

This should be private but is called from C, must be public.

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

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

void marCCD::setShutter ( int  open) [virtual]

Set the shutter position.

This method will open (1) or close (0) the shutter if ADShutterMode==ADShutterModeEPICS. Drivers will implement setShutter if they support ADShutterModeDetector. If ADShutterMode=ADShutterModeDetector they will control the shutter directly, else they will call this method.

Parameters:
[in]open1 (open) or 0 (closed)

Reimplemented from ADDriver.

asynStatus marCCD::writeFloat64 ( asynUser *  pasynUser,
epicsFloat64  value 
) [virtual]

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

This function performs actions for some parameters. 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 marCCD::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]pasynUserpasynUser structure that encodes the reason and address.
[in]valueValue to write.

Reimplemented from ADDriver.


Member Data Documentation

int marCCD::marCCDBeamX [protected]
int marCCD::marCCDBeamY [protected]
int marCCD::marCCDFileComments [protected]
int marCCD::marCCDFrameShift [protected]
int marCCD::marCCDOverlap [protected]
int marCCD::marCCDRotationAxis [protected]
int marCCD::marCCDRotationRange [protected]
int marCCD::marCCDStability [protected]
int marCCD::marCCDStartPhi [protected]
int marCCD::marCCDState [protected]
int marCCD::marCCDStatus [protected]
int marCCD::marCCDTiffTimeout [protected]
int marCCD::marCCDTwoTheta [protected]
int marCCD::marCCDWavelength [protected]
epicsEventId marCCD::stopEventId

This should be private but is accessed from C, must be public.


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