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

Driver for Andor sCMOS cameras using version 3 of their SDK; inherits from ADDriver class in ADCore. More...

Inheritance diagram for andor3:
ADDriver asynNDArrayDriver

Public Member Functions

 andor3 (const char *portName, int cameraId, int maxBuffers, size_t maxMemory, int priority, int stackSize, int maxFrames)
 Constructor for Andor3 driver; most parameters are simply passed to ADDriver::ADDriver. More...
 
virtual asynStatus writeInt32 (asynUser *pasynUser, epicsInt32 value)
 Sets an int32 parameter. More...
 
virtual asynStatus writeFloat64 (asynUser *pasynUser, epicsFloat64 value)
 
virtual asynStatus readEnum (asynUser *pasynUser, char *strings[], int values[], int severities[], size_t nElements, size_t *nIn)
 
virtual void report (FILE *fp, int details)
 Report status of the driver. More...
 
void shutdown ()
 
void imageTask ()
 
void tempTask ()
 
int getFeature (int paramIndex)
 
- 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 Andor3FrameRate
 
int Andor3PixelEncoding
 
int Andor3FullAOIControl
 
int Andor3Binning
 
int Andor3ShutterMode
 
int Andor3SoftwareTrigger
 
int Andor3SensorCooling
 
int Andor3TempControl
 
int Andor3TempStatus
 
int Andor3SerialNumber
 
int Andor3FirmwareVersion
 
int Andor3SoftwareVersion
 
int Andor3ControllerID
 
int Andor3Overlap
 
int Andor3ReadoutRate
 
int Andor3ReadoutTime
 
int Andor3TransferRate
 
int Andor3PreAmpGain
 
int Andor3NoiseFilter
 
int Andor3FanSpeed
 
- 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 Andor sCMOS cameras using version 3 of their SDK; inherits from ADDriver class in ADCore.

Constructor & Destructor Documentation

◆ andor3()

andor3::andor3 ( const char *  portName,
int  cameraId,
int  maxBuffers,
size_t  maxMemory,
int  priority,
int  stackSize,
int  maxFrames 
)

Constructor for Andor3 driver; most parameters are simply passed to ADDriver::ADDriver.

After calling the base class constructor this method creates a thread to collect the images from the detector 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]cameraIdThe id number of the Andor camera (see listdevices example for number).
[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.
[in]maxFramesThe number of frame buffers to use in driver.

Member Function Documentation

◆ getFeature()

int andor3::getFeature ( int  paramIndex)

◆ imageTask()

void andor3::imageTask ( )

◆ readEnum()

asynStatus andor3::readEnum ( asynUser *  pasynUser,
char *  strings[],
int  values[],
int  severities[],
size_t  nElements,
size_t *  nIn 
)
virtual

◆ report()

void andor3::report ( FILE *  fp,
int  details 
)
virtual

Report status of the driver.

This method calls the report function in the asynPortDriver base class. It then calls the NDArrayPool::report() method if details >5.

Parameters
[in]fpFile pointed passed by caller where the output is written to.
[in]detailsIf >5 then NDArrayPool::report and NDAttributeList::report are both called.

Reimplemented from asynNDArrayDriver.

◆ shutdown()

void andor3::shutdown ( void  )

◆ tempTask()

void andor3::tempTask ( void  )

◆ writeFloat64()

asynStatus andor3::writeFloat64 ( asynUser *  pasynUser,
epicsFloat64  value 
)
virtual

◆ writeInt32()

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

Sets an int32 parameter.

Parameters
[in]pasynUserasynUser structure that contains the function code in pasynUser->reason.
[in]valueThe value for this parameter

Takes action if the function code requires it. Currently only ADShutterControl requires action here. This method is normally called from the writeInt32 method in derived classes, which should set the value of the parameter in the parameter library.

Reimplemented from ADDriver.

Member Data Documentation

◆ Andor3Binning

int andor3::Andor3Binning
protected

◆ Andor3ControllerID

int andor3::Andor3ControllerID
protected

◆ Andor3FanSpeed

int andor3::Andor3FanSpeed
protected

◆ Andor3FirmwareVersion

int andor3::Andor3FirmwareVersion
protected

◆ Andor3FrameRate

int andor3::Andor3FrameRate
protected

◆ Andor3FullAOIControl

int andor3::Andor3FullAOIControl
protected

◆ Andor3NoiseFilter

int andor3::Andor3NoiseFilter
protected

◆ Andor3Overlap

int andor3::Andor3Overlap
protected

◆ Andor3PixelEncoding

int andor3::Andor3PixelEncoding
protected

◆ Andor3PreAmpGain

int andor3::Andor3PreAmpGain
protected

◆ Andor3ReadoutRate

int andor3::Andor3ReadoutRate
protected

◆ Andor3ReadoutTime

int andor3::Andor3ReadoutTime
protected

◆ Andor3SensorCooling

int andor3::Andor3SensorCooling
protected

◆ Andor3SerialNumber

int andor3::Andor3SerialNumber
protected

◆ Andor3ShutterMode

int andor3::Andor3ShutterMode
protected

◆ Andor3SoftwareTrigger

int andor3::Andor3SoftwareTrigger
protected

◆ Andor3SoftwareVersion

int andor3::Andor3SoftwareVersion
protected

◆ Andor3TempControl

int andor3::Andor3TempControl
protected

◆ Andor3TempStatus

int andor3::Andor3TempStatus
protected

◆ Andor3TransferRate

int andor3::Andor3TransferRate
protected

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