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

Inheritance diagram for pilatusDetector:

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. 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...

virtual asynStatus	writeOctet (asynUser pasynUser, const char value, size_t nChars, size_t *nActual)
	Called when asyn clients call pasynOctet->write(). More...

void	report (FILE *fp, int details)
	Report status of the driver. More...

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

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	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	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...

virtual void	updateTimeStamps (NDArray *pArray)

asynStatus	incrementQueuedArrayCount ()

asynStatus	decrementQueuedArrayCount ()

int	getQueuedArrayCount ()

void	updateQueuedArrayCount ()

Protected Attributes
int	PilatusDelayTime

int	PilatusThreshold

int	PilatusThresholdApply

int	PilatusThresholdAutoApply

int	PilatusEnergy

int	PilatusArmed

int	PilatusResetPower

int	PilatusResetPowerTime

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	PilatusPhiIncr

int	PilatusChi

int	PilatusChiIncr

int	PilatusOmega

int	PilatusOmegaIncr

int	PilatusOscillAxis

int	PilatusNumOscill

int	PilatusPixelCutOff

int	PilatusThTemp0

int	PilatusThTemp1

int	PilatusThTemp2

int	PilatusThHumid0

int	PilatusThHumid1

int	PilatusThHumid2

int	PilatusTvxVersion

int	PilatusCbfTemplateFile

int	PilatusHeaderString

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	NDFileFreeCapture

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	NDPoolPreAllocBuffers

int	NDPoolNumPreAllocBuffers

int	NDPoolFreeBuffers

int	NDPoolMaxMemory

int	NDPoolUsedMemory

int	NDPoolEmptyFreeList

int	NDPoolPollStats

int	NDNumQueuedArrays

class NDArray **	pArrays
	An array of NDArray pointers used to store data in the driver. More...

class NDAttributeList *	pAttributeList
	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 NDArrayPool *	pNDArrayPool
	An NDArrayPool pointer that is initialized to pNDArrayPoolPvt_ in the constructor. More...

Detailed Description

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

Constructor & Destructor Documentation

◆ pilatusDetector()

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]	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

◆ pilatusTask()

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.

◆ report()

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.

◆ writeFloat64()

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.

◆ writeInt32()

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.

◆ writeOctet()

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

◆ PilatusAlpha

int pilatusDetector::PilatusAlpha

protected

◆ PilatusAngleIncr

int pilatusDetector::PilatusAngleIncr

protected

◆ PilatusArmed

int pilatusDetector::PilatusArmed

protected

◆ PilatusBadPixelFile

int pilatusDetector::PilatusBadPixelFile

protected

◆ PilatusBeamX

int pilatusDetector::PilatusBeamX

protected

◆ PilatusBeamY

int pilatusDetector::PilatusBeamY

protected

◆ PilatusCbfTemplateFile

int pilatusDetector::PilatusCbfTemplateFile

protected

◆ PilatusChi

int pilatusDetector::PilatusChi

protected

◆ PilatusChiIncr

int pilatusDetector::PilatusChiIncr

protected

◆ PilatusDelayTime

int pilatusDetector::PilatusDelayTime

protected

◆ PilatusDet2theta

int pilatusDetector::PilatusDet2theta

protected

◆ PilatusDetDist

int pilatusDetector::PilatusDetDist

protected

◆ PilatusDetVOffset

int pilatusDetector::PilatusDetVOffset

protected

◆ PilatusEnergy

int pilatusDetector::PilatusEnergy

protected

◆ PilatusEnergyHigh

int pilatusDetector::PilatusEnergyHigh

protected

◆ PilatusEnergyLow

int pilatusDetector::PilatusEnergyLow

protected

◆ PilatusFilterTransm

int pilatusDetector::PilatusFilterTransm

protected

◆ PilatusFlatFieldFile

int pilatusDetector::PilatusFlatFieldFile

protected

◆ PilatusFlatFieldValid

int pilatusDetector::PilatusFlatFieldValid

protected

◆ PilatusFlux

int pilatusDetector::PilatusFlux

protected

◆ PilatusGapFill

int pilatusDetector::PilatusGapFill

protected

◆ PilatusHeaderString

int pilatusDetector::PilatusHeaderString

protected

◆ PilatusImageFileTmot

int pilatusDetector::PilatusImageFileTmot

protected

◆ PilatusKappa

int pilatusDetector::PilatusKappa

protected

◆ PilatusMinFlatField

int pilatusDetector::PilatusMinFlatField

protected

◆ PilatusNumBadPixels

int pilatusDetector::PilatusNumBadPixels

protected

◆ PilatusNumOscill

int pilatusDetector::PilatusNumOscill

protected

◆ PilatusOmega

int pilatusDetector::PilatusOmega

protected

◆ PilatusOmegaIncr

int pilatusDetector::PilatusOmegaIncr

protected

◆ PilatusOscillAxis

int pilatusDetector::PilatusOscillAxis

protected

◆ PilatusPhi

int pilatusDetector::PilatusPhi

protected

◆ PilatusPhiIncr

int pilatusDetector::PilatusPhiIncr

protected

◆ PilatusPixelCutOff

int pilatusDetector::PilatusPixelCutOff

protected

◆ PilatusPolarization

int pilatusDetector::PilatusPolarization

protected

◆ PilatusResetPower

int pilatusDetector::PilatusResetPower

protected

◆ PilatusResetPowerTime

int pilatusDetector::PilatusResetPowerTime

protected

◆ PilatusStartAngle

int pilatusDetector::PilatusStartAngle

protected

◆ PilatusThHumid0

int pilatusDetector::PilatusThHumid0

protected

◆ PilatusThHumid1

int pilatusDetector::PilatusThHumid1

protected

◆ PilatusThHumid2

int pilatusDetector::PilatusThHumid2

protected

◆ PilatusThreshold

int pilatusDetector::PilatusThreshold

protected

◆ PilatusThresholdApply

int pilatusDetector::PilatusThresholdApply

protected

◆ PilatusThresholdAutoApply

int pilatusDetector::PilatusThresholdAutoApply

protected

◆ PilatusThTemp0

int pilatusDetector::PilatusThTemp0

protected

◆ PilatusThTemp1

int pilatusDetector::PilatusThTemp1

protected

◆ PilatusThTemp2

int pilatusDetector::PilatusThTemp2

protected

◆ PilatusTvxVersion

int pilatusDetector::PilatusTvxVersion

protected

◆ PilatusWavelength

int pilatusDetector::PilatusWavelength

protected

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

/home/runner/work/areaDetector/areaDetector/ADPilatus/pilatusApp/src/pilatusDetector.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pilatusDetector()

Member Function Documentation

◆ pilatusTask()

◆ report()

◆ writeFloat64()

◆ writeInt32()

◆ writeOctet()

Member Data Documentation

◆ PilatusAlpha

◆ PilatusAngleIncr

◆ PilatusArmed

◆ PilatusBadPixelFile

◆ PilatusBeamX

◆ PilatusBeamY

◆ PilatusCbfTemplateFile

◆ PilatusChi

◆ PilatusChiIncr

◆ PilatusDelayTime

◆ PilatusDet2theta

◆ PilatusDetDist

◆ PilatusDetVOffset

◆ PilatusEnergy

◆ PilatusEnergyHigh

◆ PilatusEnergyLow

◆ PilatusFilterTransm

◆ PilatusFlatFieldFile

◆ PilatusFlatFieldValid

◆ PilatusFlux

◆ PilatusGapFill

◆ PilatusHeaderString

◆ PilatusImageFileTmot

◆ PilatusKappa

◆ PilatusMinFlatField

◆ PilatusNumBadPixels

◆ PilatusNumOscill

◆ PilatusOmega

◆ PilatusOmegaIncr

◆ PilatusOscillAxis

◆ PilatusPhi

◆ PilatusPhiIncr

◆ PilatusPixelCutOff

◆ PilatusPolarization

◆ PilatusResetPower

◆ PilatusResetPowerTime

◆ PilatusStartAngle

◆ PilatusThHumid0

◆ PilatusThHumid1

◆ PilatusThHumid2

◆ PilatusThreshold

◆ PilatusThresholdApply

◆ PilatusThresholdAutoApply

◆ PilatusThTemp0

◆ PilatusThTemp1

◆ PilatusThTemp2

◆ PilatusTvxVersion

◆ PilatusWavelength