DexelaDetector API: DexelaDetector Class Reference

Constructor for DexelaDetector. This version uses the DevInfo struct returned from a GetDevice, GetDeviceGE or GetDeviceCL call.

Parameters

devInfo

The DevInfo object for the desired detector.

Exceptions

DexelaException

Constructor for DexelaDetector. This version assumes you know the interface and the correct parameters to connect to the detector.

Parameters

transport	The DetectorInterface for the detector (i.e. CL or GIGE)
unit	The unit number for CL type detectors. For GIGE detectors this can be set to 0
params	The parameter string for connection to the detector. For GIGE detectors this should be the detector IP address. For CL detectors this parameter will be ignored.

Exceptions

DexelaException

Destructor for DexelaDetector.

This function will check to see if any errors have occurred in the background thread that is running when using callbacks. This thread is activated after a call to SetCallback and terminated with a call to StopCallback. If no error has occurred this method will just return. if an error has occurred a DexelaException will be thrown.

Exceptions

DexelaException

This function will check to see if any errors have occurred in the background thread that is running when using live-mode. This thread is activated after a call to GoLiveSeq and terminated with a call to GoUnLive. If no error has occurred this method will just return. if an error has occurred a DexelaException will be thrown.

Exceptions

DexelaException

Clears all the camera buffers

Exceptions

DexelaException

Clears (i.e. zero-out) the specified camera buffer.

Parameters

i	The buffer number to clear.

Exceptions

DexelaException

Closes the connection to the detector.

Exceptions

DexelaException

This function will disable Pulse Generator mode. After calling this you should be able to use the SoftwareTrigger call.

Exceptions

DexelaException

Enables displaying the framecounter in the image (being the 2nd pixel).

Parameters

usEnable

Enables / disabled frame counter within image.

Exceptions

DexelaException

This function will enable the pulse generator software trigger signal. In this mode the software trigger can be continuously sent to the detector at the desired frequency.
Note: In order to use this mode the trigger source should be set to Internal_Software
Note2: To actually enable the pulse train you must call ToggleGenerator. A SoftwareTrigger call will not work when in this mode.

Parameters

frequency

The frequency that the software trigger signal will be run at.

Exceptions

DexelaException

This function is identical to EnablePulseGenerator, except that the frequency of the pulse train is set automatically. The frequency will be set such as to ensure continuous image acquisition for the current detector/binning mode.
Note: In order to use this mode the trigger source should be set to Internal_Software
Note2: To actually enable the pulse train you must call ToggleGenerator. A SoftwareTrigger call will not work when in this mode.

Exceptions

DexelaException

This method activates or deactivates the ROI mode of the detector.

Parameters

bEnableROI

This parameter can have the following values: value 0: Disable ROI mode value 1: Enable ROI mode

Exceptions

DexelaException

Gets the current state of the detector binning mode

Returns

A member of the bins enumeration detailing the current detetor binning mode.

Exceptions

DexelaException

Get the x dimension of the transport buffer (in bytes)

Returns

The x dimension of the transport buffer (in bytes)

Exceptions

DexelaException

Get the y dimension of the transport buffer (in pixels)

Returns

The y dimension of the transport buffer (in pixels)

Exceptions

DexelaException

Gets the number of the buffer just captured. This can be used to determine which buffer to read-out.

Returns

The number of the last buffer, which the last captured image was written to.

Exceptions

DexelaException

Returns the current settings of the detector in the form of a DetStatus object.

Returns

A DetStatus structure containing settings retrieved.

Exceptions

DexelaException

Gets the ExposureMode parameter of the detector.

Returns

The ExposureModes enumeration member that the detector is currently set to.

Exceptions

DexelaException

Gets the exposure time parameter of the detector (ms).

Returns

The exposure time (ms) that the detector is currently set to.

Exceptions

DexelaException

Gets the number of fields(frames) captured so far.

Returns

The number of fields captured.

Exceptions

DexelaException

Gets the detector firmware build date.
Note: This feature may not be supported on older detectors

Parameters

iDayAndMonth	The day and month of the firmware build (DDMM format)
iYear	The year of the firwmare build (YYYY format).
iTime	The time of the firmware build (hhmm format).

Exceptions

DexelaException

Gets the detector firmware version number.

Returns

The detector firmware version number as read from the detector.

Exceptions

DexelaException

Gets the current detector well-mode.

Returns

A member of the FullWellModes enumeration detailing the current detetor Full-Well mode.

Exceptions

DexelaException

Gets the current gap-time setting of the detector. When run in Frame_Rate_exposure mode the detector will insert this gap period between consecutive frames in an image sequence.
Note: The minimum time for the gap-time setting is the current readout-time for the detector. Attempting to write anything smaller to the detector will result in a gap-time equal to the readout-time.

Returns

The gap-time in ms.

Exceptions

DexelaException

Gets the detector model number.

Returns

The detector model number as read from the detector.

Exceptions

DexelaException

Get the number of internal buffers that are currently allocated for the detector.

Returns

The number of internal buffers allocated

Exceptions

DexelaException

Gets the number of exposures setting from the detector. This is only relevant in Sequence_Exposure and Frame_Rate_exposure modes of operation.

Returns

The number of exposues that will be acquired each trigger recieved.

Exceptions

DexelaException

Gets the ReadoutModes parameter of the detector.

Returns

The ReadoutModes enumeration member that the detector is currently set to.

Exceptions

DexelaException

This method will return the read-out time of the detector (in ms) for it's current binning mode.

Returns

The read-out time (in ms) for the current settings of the detector.

Exceptions

DexelaException

This method retrieves the coordinates of the region of interest (ROI) set within the detector.

Parameters

usStartColumn	Index of first column of ROI.
usROIWidth	Height (number of columns) of the ROI.
usStartRow	Index of first row of ROI.
usROIHeight	Height (number of rows) of the ROI.

Exceptions

DexelaException

This method retrieves the enabled state of the region of interest of the detector.

Parameters

bEnableROI

This parameter can have the following values: value 0: ROI mode disabled value 1: ROI mode enabled

Exceptions

DexelaException

Gets the height of the sensor in pixels.

Parameters

usSensorID

ID of sensor FPGA to send the query to. For "global reads" sensor FPGA 1 has to be queried, using usSensorID=1/param> Exceptions DexelaException

Gets the width of the sensor in pixels.

Parameters

usSensorID

ID of sensor FPGA to send the query to. For "global reads" sensor FPGA 1 has to be queried, using usSensorID=1/param> Exceptions DexelaException

Gets the detector serial number.

Returns

The detector serial number as read from the detector.

Exceptions

DexelaException

Gets the current state of the detector test mode (on/off)

Returns

Boolean value containing the current state of the detector test mode.

Exceptions

DexelaException

Returns the communication method (i.e. interface) for the detector object.

Returns

The DetectorInterface enumeration used by the detector

Exceptions

DexelaException

Gets the current trigger source setting from the detector

Returns

A member of the ExposureTriggerSource enumeration detailing the current trigger source of the detector.

Exceptions

DexelaException

Sets the host computer up to be ready to recieve images into the specified buffer range.

Parameters

start	Number of the first buffer to use for acquisition
stop	Number of the last buffer to use for acquisition
numBuf	Number of frames to acquire. If this is set to 0 the buffer will be circular (i.e. ring-buffer).

Exceptions

DexelaException

Sets the host computer up to be ready to recieve images. This call will use all available buffers in a circular fashion (i.e. ring-buffer).

Exceptions

DexelaException

Exits live mode. The host computer will no longer be ready to recieve transmitted images.

Exceptions

DexelaException

This method will inform the user if the callback mode (i.e. background thread) is currently active.

Returns

A boolean value indicating whether the callback mode is active.

Exceptions

DexelaException

Check to see if the connection to the detector is open (i.e. OpenBoard)

Returns

A boolean indicating whether the connection to detector is open.

Exceptions

DexelaException

Checks if framecounter is displayed within the image data (being the 2nd pixel).

Parameters

usEnable

0 if not enabled; 1 if enabled

Exceptions

DexelaException

This method will inform the user if detector is currently in Live mode.

Returns

A boolean value indicating whether the detector is in Live mode.

Exceptions

DexelaException

Loads the sensor configuration file into the detector. This file will write values to the ADC offset registers for each sensor in the detector.

Parameters

filename

The path to the sensor configuration to use.

Exceptions

DexelaException

Opens the connection to the detector. Every open should be matched with a close to free resources.

Exceptions

DexelaException

Reimplemented in DexelaDetectorCL, and DexelaDetectorGE.

Opens the connection to the detector and sets the number of buffers to use/allocate. Every open should be matched with a close to free resources.

Parameters

NumBufs

Number of buffers to use/allocate

Exceptions

DexelaException

Query the detector to see if the desired binning mode is present (i.e. available).
Note: Older detectors may not support the querying of features. In this case a value of -1 will be returned indicating that it is uknown whether the feature is present. In this case it is possible that the feature is present but that the detector is unable to report so. It may still be possible to use the feature in this case but no guarantees can be made on whether or not it will work.

Parameters

mode	The bins enumeration member to be checked for.

Returns

An integer value representing whether the feature is present. A value of 1 indicates that the feature is present. A value of 0 indicates that the feature is not present. A value of -1 indicates that it is uknown whether the feature is presetn.

Exceptions

DexelaException

Query the detector to see if the desired exposure mode is present (i.e. available).
Note: Older detectors may not support the querying of features. In this case a value of -1 will be returned indicating that it is uknown whether the feature is present. In this case it is possible that the feature is present but that the detector is unable to report so. It may still be possible to use the feature in this case but no guarantees can be made on whether or not it will work.

Parameters

mode	The ExposureModes enumeration member to be checked for.

Returns

An integer value representing whether the feature is present. A value of 1 indicates that the feature is present. A value of 0 indicates that the feature is not present. A value of -1 indicates that it is uknown whether the feature is presetn.

Exceptions

DexelaException

Query the detector to see if the desired full-well mode is present (i.e. available).
Note: Older detectors may not support the querying of features. In this case a value of -1 will be returned indicating that it is uknown whether the feature is present. In this case it is possible that the feature is present but that the detector is unable to report so. It may still be possible to use the feature in this case but no guarantees can be made on whether or not it will work.

Parameters

mode	The FullWellModes enumeration member to be checked for.

Returns

An integer value representing whether the feature is present. A value of 1 indicates that the feature is present. A value of 0 indicates that the feature is not present. A value of -1 indicates that it is uknown whether the feature is presetn.

Exceptions

DexelaException

Query the detector to see if the desired readout mode is present (i.e. available).
Note: Older detectors may not support the querying of features. In this case a value of -1 will be returned indicating that it is uknown whether the feature is present. In this case it is possible that the feature is present but that the detector is unable to report so. It may still be possible to use the feature in this case but no guarantees can be made on whether or not it will work.

Parameters

mode	The ReadoutModes enumeration member to be checked for.

Returns

An integer value representing whether the feature is present. A value of 1 indicates that the feature is present. A value of 0 indicates that the feature is not present. A value of -1 indicates that it is uknown whether the feature is presetn.

Exceptions

DexelaException

Query the detector to see if the desired trigger source is present (i.e. available).
Note: Older detectors may not support the querying of features. In this case a value of -1 will be returned indicating that it is uknown whether the feature is present. In this case it is possible that the feature is present but that the detector is unable to report so. It may still be possible to use the feature in this case but no guarantees can be made on whether or not it will work.

Parameters

mode	The ExposureTriggerSource enumeration member to be checked for.

Returns

An integer value representing whether the feature is present. A value of 1 indicates that the feature is present. A value of 0 indicates that the feature is not present. A value of -1 indicates that it is uknown whether the feature is presetn.

Exceptions

DexelaException

Reads the specified transport buffer into the passed in buffer (byte*).
Note: GetCapturedBuffer can be used to get the number of the lastest buffer to be filled.

Parameters

bufNum	The index of the transport buffer to read from.
buffer	The user-created (byte*) buffer to write the image to.

Exceptions

DexelaException

Reads the specified transport buffer into the passed in DexImage object at the passed in plane.
Note: GetCapturedBuffer can be used to get the number of the lastest buffer to be filled.

Parameters

bufNum	The index of the transport buffer to read from.
img	The DexImage object that the image will be written into
iZ	The plane that the image should be written to in the DexImage object (defaults to 0).

Exceptions

DexelaException

Reads the specified register from the detector. The sensor number corresponds to the desired sensor from which to read the register. The SensorNumber will default to 1 (master-sensor) if not specified otherwise by the user.

Parameters

address	The address of the desired register to read.
sensorNum	The sensor number from which to read the register (defaults to master-sensor).

Returns

The integer value of the register.

Exceptions

DexelaException

Sets the binning mode of the detector.

Parameters

flag	The bins enumeration member to be set.

Exceptions

DexelaException

Sets the user defined callback funtction to be called for every image arrival event.

Parameters

func	The call back function (IMAGE_CALLBACK) to be called for every image arrival event.

Exceptions

DexelaException

Sets the ExposureMode parameter of the detector

Parameters

mode	The ExposureModes enumeration member to be set.

Exceptions

DexelaException

Sets the exposure time parameter of the detector

Parameters

timems

The exposure time (in milliseconds) to be set. Note: if you attempt to set an exposure time smaller then the current read-out time for the detector, it will be set to minimum.

Exceptions

DexelaException

Sets the full well mode parameter of the detector.

Parameters

fwm	The FullWellModes enumeration member to be set.

Exceptions

DexelaException

Sets the gap-time setting of the detector. When run in Frame_Rate_exposure mode the detector will insert this gap period between consecutive frames in an image sequence.
Note: The minimum time for the gap-time setting is the current readout-time for the detector. Attempting to write anything smaller to the detector will result in a gap-time equal to the readout-time.

Parameters

timems

The gap-time in ms.

Exceptions

DexelaException

Sets the number of exposures to acquire after a trigger. This is only relevant in Sequence_Exposure and Frame_Rate_exposure modes of operation.

Parameters

num	The number of exposues to acquire for each trigger recieved.

Exceptions

DexelaException

This method will set the exposure times for pre-programmed exposure mode.

Parameters

numExposures	The number of exposures to set. This number should correspond to the number of exposures that will be acquired in pre-programmed exposure mode and should be between 2-4.
exposuretimes_ms	An array of floating point numbers representing the exposure times for pre-programmed exposure mode. The number of exposure times should correspond to the numExposures parameter.

Exceptions

DexelaException

Sets the ReadoutMode parameter of the detector

Parameters

mode	The ReadoutModes enumeration member to be set.

Exceptions

DexelaException

This method can specify to the api that the detector being used is a slowed-down detector (e.g. mammo detector). This should not be necessary as the API should be able to determine most of the time whether the firmwarwe version is a slowed down one. However, for certain older detectors/firmwares this may not be possible. In this case this method can be used to inform the library that the firmware is slowed down and it will use the correct read-out times.

Parameters

numExposures

A boolean flag indicating wheter the detector is slowed down or not.

Exceptions

DexelaException

Enables/disables test mode. The detector will output a generated test pattern if this mode is turned on.

Parameters

SetTestOn

if set to true The test pattern is turned on.

Exceptions

DexelaException

Sets the trigger source setting on the detector

Parameters

ets	A member of the ExposureTriggerSource enumeration to be set to the detector

Exceptions

DexelaException

Snaps an image into the specified buffer.
Note: If the detector trigger source is set to Internal_Software, this call will automatically trigger the detector.

Parameters

buffer	The buffer number to snap to. The number of available buffers can be found by calling the GetNumBuffers method.
timeout	The amount of time (in ms) that the library will wait for an image before throwing a timeout exception.

Exceptions

DexelaException

Cycles the power on the detector

Exceptions

DexelaException

Sends a trigger to the detector (will only work if the trigger source is set to Internal_Software)

Exceptions

DexelaException

This function will terminate the callback loop (i.e. will wait for all spawned threads to finish exectuing).

Exceptions

DexelaException

This function will control the pulse train.
Note: In order to use this mode the pulse generator must be enabled. See EnablePulseGenerator.

Parameters

onOff

Boolean that will control the state of the pulse train (true = on, false = off).

Exceptions

DexelaException

This function will wait for the specified amount of time for an image to arrive.
Note: If the image arrives before then it will return as soon as it does (i.e. it won't wait for the duration of the timeout period). If the image does not arrive in the specified time a DexelaException will be thrown.

Parameters

timeout

The timeout period (in ms) for which to wait before throwing a DexelaException.

Exceptions

DexelaException

Writes data to the specified transport buffer.

Parameters

bufNum	The index of the transport buffer to write to.
buffer	The user-created data (byte*) buffer to write to the transport buffer.

Exceptions

DexelaException

Writes the value to the specified register from the detector. The sensor number corresponds to the desired sensor to which the value will be written. The SensorNumber will default to 0 (broadcast to all sensors) if not specified otherwise by the user.

Parameters

address

The address of the desired register to write to.

+

Parameters

value	The value to write into the register
sensorNum	The sensor number that the register will be written to. This defaults to 0 which is a broadcast to all detector sensors.

Exceptions

DexelaException