Main driver class inherited from areaDetectors ADDriver class. More...

Inheritance diagram for FirewireDCAM:

Public Member Functions
	FirewireDCAM (const char portName, const char camid, int speed, int maxBuffers, size_t maxMemory, int disableScalable)
	Constructor for the FirewireDCAM class Initialises the camera object by setting all the default parameters and initializing the camera hardware with it. More...

virtual asynStatus	writeInt32 (asynUser *pasynUser, epicsInt32 value)
	Write integer value to the drivers parameter table. More...

virtual asynStatus	writeFloat64 (asynUser *pasynUser, epicsFloat64 value)
	Write floating point value to the drivers parameter table and possibly to the hardware. More...

void	report (FILE *fp, int details)
	Print out a report. More...

asynStatus	err (asynUser *asynUser, dc1394error_t dc1394_err, int errOriginLine)
	Parse a dc1394 error code into a user readable string Defaults to printing out using the pasynUser. More...

void	imageGrabTask ()
	Task to grab images off the camera and send them up to areaDetector. More...

int	decodeFrame (dc1394video_frame_t *dc1394_frame)
	decodes a dc1394video_frame_t, turns it into an NDArray, finally clears the buffer off the dc1394 queue. More...

asynStatus	startCapture (asynUser *pasynUser)

asynStatus	stopCapture (asynUser *pasynUser)

asynStatus	stopCaptureAndWait (asynUser *pasynUser)

asynStatus	initCamera (unsigned long long int camUID)

asynStatus	setFeatureValue (asynUser pasynUser, int addr, epicsInt32 value, epicsInt32 rbValue)

asynStatus	setFeatureAbsValue (asynUser pasynUser, int addr, epicsFloat64 value, epicsFloat64 rbValue)

asynStatus	setFeatureMode (asynUser pasynUser, int addr, epicsInt32 value, epicsInt32 rbValue)

asynStatus	checkFeature (asynUser pasynUser, int addr, dc1394feature_info_t featInfo, char featureName, const char functionName)
	Check if a requested feature is valid. More...

asynStatus	setFrameRate (asynUser *pasynUser, epicsInt32 iframerate)
	Set the framerate in the camera. More...

asynStatus	setFrameRate (asynUser *pasynUser, epicsFloat64 dframerate)

int	getAllFeatures ()
	Read all the feature settings and values from the camera. More...

asynStatus	lookupColorMode (dc1394color_coding_t colorCoding, int colorMode, int dataType)
	Lookup a colorMode and dataType from a dc1394color_coding_t. More...

dc1394color_coding_t	lookupColorCoding (int colorMode, int dataType)
	Lookup a dc1394color_coding_t from a colorMode and dataType. More...

dc1394video_mode_t	lookupVideoMode (dc1394color_coding_t colorCoding)
	Look up a valid video mode based on a dc1394color_coding_t. More...

asynStatus	setVideoMode (asynUser *pasynUser)

asynStatus	setRoi (asynUser *pasynUser)

int	setAcquireParam (int acquire)

dc1394error_t	captureDequeueTimeout (dc1394camera_t camera, dc1394video_frame_t *frame, epicsFloat64 timeout)
	Run the dc1394_capture_dequeue() function in a polling loop until a frame is received or it times out. 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	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	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 ()

Public Attributes
NDArray *	pRaw

dc1394camera_t *	camera

epicsEventId	startEventId

epicsEventId	stopEventId

dc1394featureset_t	features

int	disableScalable

int	busSpeed

unsigned long long	camguid

epicsUInt32	latch_frames_behind

Public Attributes inherited from asynNDArrayDriver
class NDArrayPool *	pNDArrayPool
	An NDArrayPool pointer that is initialized to pNDArrayPoolPvt_ in the constructor. More...

Protected Attributes
int	FDC_feat_val

int	FDC_feat_val_max

int	FDC_feat_val_min
	Feature maximum boundry value (int32 read) addr: 0-17. More...

int	FDC_feat_val_abs
	Feature minimum boundry value (int32 read) addr: 0-17. More...

int	FDC_feat_val_abs_max
	Feature absolute value (float64 read/write) addr: 0-17. More...

int	FDC_feat_val_abs_min
	Feature absolute maximum boundry value (float64 read) addr: 0-17. More...

int	FDC_feat_mode
	Feature absolute minimum boundry value (float64 read) addr: 0-17. More...

int	FDC_feat_available
	Feature control mode: 0:manual or 1:automatic (camera controlled) (int32 read/write) More...

int	FDC_feat_absolute
	Is a given featurea available in the camera 1=available 0=not available (int32, read) More...

int	FDC_framerate
	Feature has absolute (floating point) controls available 1=available 0=not available (int32 read) More...

int	FDC_videomode
	Set and read back the frame rate (int32 (enums) read/write) More...

int	FDC_bandwidth
	Set and read back the video mode (int32 (enums) read/write) More...

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_

Detailed Description

Main driver class inherited from areaDetectors ADDriver class.

One instance of this class will control one firewire camera on the bus.

Constructor & Destructor Documentation

◆ FirewireDCAM()

FirewireDCAM::FirewireDCAM	(	const char *	portName,
		const char *	camid,
		int	speed,
		int	maxBuffers,
		size_t	maxMemory,
		int	disableScalable
	)

Constructor for the FirewireDCAM class Initialises the camera object by setting all the default parameters and initializing the camera hardware with it.

This function also reads out the current settings of the camera and prints out a selection of parameters to the shell.

Parameters

portName	The asyn port name to give the particular instance.
camid	The unique ID stored in the camera.
speed	The bus speed to use this camera at. Can be 800[Mb/s] for 1394B mode or 400[Mb/s] for 1394A mode.
maxBuffers	The largest number of image buffers this driver can create.
maxMemory	The maximum amount of memory in bytes that the driver can allocate for images.
disableScalable	Disable scalable (format 7) modes if this is 1

Member Function Documentation

◆ captureDequeueTimeout()

dc1394error_t FirewireDCAM::captureDequeueTimeout	(	dc1394camera_t *	camera,
		dc1394video_frame_t **	frame,
		epicsFloat64	timeout
	)

Run the dc1394_capture_dequeue() function in a polling loop until a frame is received or it times out.

◆ checkFeature()

asynStatus FirewireDCAM::checkFeature	(	asynUser *	pasynUser,
		int	addr,
		dc1394feature_info_t **	featInfo,
		char **	featureName,
		const char *	functionName
	)

Check if a requested feature is valid.

Checks for:

Valid range of the asyn request address against feature index.
Availability of the requested feature in the current camera.

Parameters

pasynUser	Asyn User to write messages to
addr	Address of the parameter to get
featInfo	Pointer to a feature info structure pointer. The function will write a valid feature info struct into this pointer or NULL on error.
featureName	The function will return a string in this parameter with a readable name for the given feature.
functionName	The caller can pass a string which contain the callers function name. For debugging/printing purposes only.

Returns: asyn status

◆ decodeFrame()

int FirewireDCAM::decodeFrame ( dc1394video_frame_t * dc1394_frame )

decodes a dc1394video_frame_t, turns it into an NDArray, finally clears the buffer off the dc1394 queue.

This function expects the mutex to be locked already by the caller!

◆ err()

asynStatus FirewireDCAM::err	(	asynUser *	asynUser,
		dc1394error_t	dc1394_err,
		int	errOriginLine
	)

Parse a dc1394 error code into a user readable string Defaults to printing out using the pasynUser.

Parameters

asynUser	The asyn user to print out with on ASYN_TRACE_ERR. If pasynUser == NULL just print to stderr.
dc1394_err	The error code, returned from the dc1394 function call. If the error code is OK we just ignore it.
errOriginLine	Line number where the error came from.

◆ getAllFeatures()

int FirewireDCAM::getAllFeatures ( )

Read all the feature settings and values from the camera.

This function will collect all the current values and settings from the camera, and set the appropriate integer/double parameters in the param lib. If a certain feature is not available in the given camera, this function will set all the parameters relating to that feature to -1 or -1.0 to indicate it is not available. Note the caller is responsible for calling any update callbacks if I/O interrupts are to be processed after calling this function.

Returns: asynStatus asynError or asynSuccess as an int.

◆ imageGrabTask()

void FirewireDCAM::imageGrabTask ( )

Task to grab images off the camera and send them up to areaDetector.

◆ initCamera()

asynStatus FirewireDCAM::initCamera ( unsigned long long int camUID )

◆ lookupColorCoding()

dc1394color_coding_t FirewireDCAM::lookupColorCoding	(	int	colorMode,
		int	dataType
	)

Lookup a dc1394color_coding_t from a colorMode and dataType.

◆ lookupColorMode()

asynStatus FirewireDCAM::lookupColorMode	(	dc1394color_coding_t	colorCoding,
		int *	colorMode,
		int *	dataType
	)

Lookup a colorMode and dataType from a dc1394color_coding_t.

◆ lookupVideoMode()

dc1394video_mode_t FirewireDCAM::lookupVideoMode ( dc1394color_coding_t colorCoding )

Look up a valid video mode based on a dc1394color_coding_t.

◆ report()

void FirewireDCAM::report	(	FILE *	fp,
		int	details
	)

virtual

Print out a report.

Not yet implemented!

Parameters

fp	Stream or file pointer to write the report to.
details	Configurable level of details in the report.

Returns: Nothing

Reimplemented from asynNDArrayDriver.

◆ setAcquireParam()

int FirewireDCAM::setAcquireParam ( int acquire )

◆ setFeatureAbsValue()

asynStatus FirewireDCAM::setFeatureAbsValue	(	asynUser *	pasynUser,
		int	addr,
		epicsFloat64	value,
		epicsFloat64 *	rbValue
	)

◆ setFeatureMode()

asynStatus FirewireDCAM::setFeatureMode	(	asynUser *	pasynUser,
		int	addr,
		epicsInt32	value,
		epicsInt32 *	rbValue
	)

◆ setFeatureValue()

asynStatus FirewireDCAM::setFeatureValue	(	asynUser *	pasynUser,
		int	addr,
		epicsInt32	value,
		epicsInt32 *	rbValue
	)

◆ setFrameRate() [1/2]

asynStatus FirewireDCAM::setFrameRate	(	asynUser *	pasynUser,
		epicsFloat64	dframerate
	)

◆ setFrameRate() [2/2]

asynStatus FirewireDCAM::setFrameRate	(	asynUser *	pasynUser,
		epicsInt32	iframerate
	)

Set the framerate in the camera.

Can set it with an enum when using the iframerate or as a double when using the dframerate parameter

◆ setRoi()

asynStatus FirewireDCAM::setRoi ( asynUser * pasynUser )

◆ setVideoMode()

asynStatus FirewireDCAM::setVideoMode ( asynUser * pasynUser )

◆ startCapture()

asynStatus FirewireDCAM::startCapture ( asynUser * pasynUser )

◆ stopCapture()

asynStatus FirewireDCAM::stopCapture ( asynUser * pasynUser )

◆ stopCaptureAndWait()

asynStatus FirewireDCAM::stopCaptureAndWait ( asynUser * pasynUser )

◆ writeFloat64()

asynStatus FirewireDCAM::writeFloat64	(	asynUser *	pasynUser,
		epicsFloat64	value
	)

virtual

Write floating point value to the drivers parameter table and possibly to the hardware.

Parameters

pasynUser
value

Returns: asynStatus Either asynError or asynSuccess

◆ writeInt32()

asynStatus FirewireDCAM::writeInt32	(	asynUser *	pasynUser,
		epicsInt32	value
	)

virtual

Write integer value to the drivers parameter table.

Parameters

pasynUser
value

Returns: asynStatus Either asynError or asynSuccess

Reimplemented from ADDriver.

Member Data Documentation

◆ busSpeed

int FirewireDCAM::busSpeed

◆ camera

dc1394camera_t* FirewireDCAM::camera

◆ camguid

unsigned long long FirewireDCAM::camguid

◆ disableScalable

int FirewireDCAM::disableScalable

◆ FDC_bandwidth

int FirewireDCAM::FDC_bandwidth

protected

Set and read back the video mode (int32 (enums) read/write)

◆ FDC_feat_absolute

int FirewireDCAM::FDC_feat_absolute

protected

Is a given featurea available in the camera 1=available 0=not available (int32, read)

◆ FDC_feat_available

int FirewireDCAM::FDC_feat_available

protected

Feature control mode: 0:manual or 1:automatic (camera controlled) (int32 read/write)

◆ FDC_feat_mode

int FirewireDCAM::FDC_feat_mode

protected

Feature absolute minimum boundry value (float64 read) addr: 0-17.

◆ FDC_feat_val

int FirewireDCAM::FDC_feat_val

protected

◆ FDC_feat_val_abs

int FirewireDCAM::FDC_feat_val_abs

protected

Feature minimum boundry value (int32 read) addr: 0-17.

◆ FDC_feat_val_abs_max

int FirewireDCAM::FDC_feat_val_abs_max

protected

Feature absolute value (float64 read/write) addr: 0-17.

◆ FDC_feat_val_abs_min

int FirewireDCAM::FDC_feat_val_abs_min

protected

Feature absolute maximum boundry value (float64 read) addr: 0-17.

◆ FDC_feat_val_max

int FirewireDCAM::FDC_feat_val_max

protected

◆ FDC_feat_val_min

int FirewireDCAM::FDC_feat_val_min

protected

Feature maximum boundry value (int32 read) addr: 0-17.

◆ FDC_framerate

int FirewireDCAM::FDC_framerate

protected

Feature has absolute (floating point) controls available 1=available 0=not available (int32 read)

◆ FDC_videomode

int FirewireDCAM::FDC_videomode

protected

Set and read back the frame rate (int32 (enums) read/write)

◆ features

dc1394featureset_t FirewireDCAM::features

◆ latch_frames_behind

epicsUInt32 FirewireDCAM::latch_frames_behind

◆ pRaw

NDArray* FirewireDCAM::pRaw

◆ startEventId

epicsEventId FirewireDCAM::startEventId

◆ stopEventId

epicsEventId FirewireDCAM::stopEventId

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

/home/runner/work/areaDetector/areaDetector/firewireDCAM/firewireDCAMApp/src/firewireDCAM.cpp

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FirewireDCAM()

Member Function Documentation

◆ captureDequeueTimeout()

◆ checkFeature()

◆ decodeFrame()

◆ err()

◆ getAllFeatures()

◆ imageGrabTask()

◆ initCamera()

◆ lookupColorCoding()

◆ lookupColorMode()

◆ lookupVideoMode()

◆ report()

◆ setAcquireParam()

◆ setFeatureAbsValue()

◆ setFeatureMode()

◆ setFeatureValue()

◆ setFrameRate() [1/2]

◆ setFrameRate() [2/2]

◆ setRoi()

◆ setVideoMode()

◆ startCapture()

◆ stopCapture()

◆ stopCaptureAndWait()

◆ writeFloat64()

◆ writeInt32()

Member Data Documentation

◆ busSpeed

◆ camera

◆ camguid

◆ disableScalable

◆ FDC_bandwidth

◆ FDC_feat_absolute

◆ FDC_feat_available

◆ FDC_feat_mode

◆ FDC_feat_val

◆ FDC_feat_val_abs

◆ FDC_feat_val_abs_max

◆ FDC_feat_val_abs_min

◆ FDC_feat_val_max

◆ FDC_feat_val_min

◆ FDC_framerate

◆ FDC_videomode

◆ features

◆ latch_frames_behind

◆ pRaw

◆ startEventId

◆ stopEventId