Package uk.ac.gda.beans.xspress

Interface XspressDetector

All Superinterfaces:

Configurable, Detector, Device, Findable, gda.observable.IObservable, Scannable

All Known Subinterfaces:

XspressFluorescenceDetector

All Known Implementing Classes:

Xspress2Detector, XspressSystem

public interface XspressDetector
extends Detector

Xspress systems must implement this to enable CORBA use

Field Summary

Fields

Modifier and Type	Field	Description
static final String	READOUT_MCA	readoutMode option - when this used Xspress will not use ROIs but return hardware scalers and full MCA
static final String	READOUT_ROIS	readoutMode option - when this used Xspress will not return data from ROIs and not use hardware scalers
static final String	READOUT_SCALERONLY	readoutMode option - when this used Xspress will not use ROIs but return hardware scalers only

Fields inherited from interface gda.device.Detector

BUSY, FAULT, IDLE, MONITORING, PAUSED, STANDBY

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear the xspress system memory
List<String>	getChannelLabels()	get the current channel label list;
Double	getDeadtimeCalculationEnergy()
DetectorElement	getDetector(int which)	Get the detector information
int[][][]	getMCData(int time)	Deprecated.
int	getNumberOfDetectors()	Get number of detectors
int	getNumberofGrades()
int[]	getRawScalerData()	Gets the raw hardware scaler values from the first frame of memory.
String	getReadoutMode()
String	getResGrade()
void	loadAndInitializeDetectors(String string)	Create and initialize detectors specified in a file.
Object	readoutScalerData()	Read out corrected scaler data
void	saveDetectors(String filename)	Save detector information to a file
void	setDeadtimeCalculationEnergy(Double energy)	The energy to use when calculating the energy-dependent deadtime correction factors.
void	setDetectorWindow(int which, int start, int end)	Set the channel range window for a particular detector
void	setReadoutMode(String readoutMode)	Sets the type of data which will be collected from the detector and returned by the readout and readoutCorrectData methods.
void	setResGrade(String grade)
void	start()	Enable the xspress system for data collection

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Detector

collectData, createsOwnFiles, endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getFileStructure, getStatus, prepareForCollection, readout, setCollectionTime, waitWhileBusy

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.device.Scannable

asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString

Field Details

READOUT_SCALERONLY

static final String READOUT_SCALERONLY

readoutMode option - when this used Xspress will not use ROIs but return hardware scalers only

See Also:

• Constant Field Values

READOUT_MCA

static final String READOUT_MCA

readoutMode option - when this used Xspress will not use ROIs but return hardware scalers and full MCA

See Also:

• Constant Field Values

READOUT_ROIS

static final String READOUT_ROIS

readoutMode option - when this used Xspress will not return data from ROIs and not use hardware scalers

See Also:

• Constant Field Values

Method Details

start

void start()
    throws DeviceException

Enable the xspress system for data collection

Throws:

DeviceException

clear

void clear()
    throws DeviceException

Clear the xspress system memory

Throws:

DeviceException

getNumberOfDetectors

int getNumberOfDetectors()
                  throws DeviceException

Get number of detectors

Returns:

the number of detectors

Throws:

DeviceException

getMCData

@Deprecated(since="GDA 8.52")
int[][][] getMCData(int time)
             throws DeviceException

Deprecated.

Get multi-channel data for all elements

Parameters:

time - the time to count for (mS)

Returns:

an array of readings from channels

Throws:

DeviceException

getRawScalerData

int[] getRawScalerData()
                throws DeviceException

Gets the raw hardware scaler values from the first frame of memory. This does not trigger any data collection. This for monitoring the Xspress status.

Will return an int array of size 4 * number of detectors (elements).

Returns:

int[] 4 values for each element in order: total number of events, TFG reset counts, in window events,TFG clock counts

Throws:

DeviceException

setDetectorWindow

void setDetectorWindow(int which,
 int start,
 int end)
                throws DeviceException

Set the channel range window for a particular detector

Parameters:

which - the detector number

start - the start channel number

end - the end channel number

Throws:

DeviceException

getDetector

DetectorElement getDetector(int which)
                     throws DeviceException

Get the detector information

Parameters:

which - the detector number to get information from

Returns:

detector information as a Detector object

Throws:

DeviceException

saveDetectors

void saveDetectors(String filename)
            throws DeviceException

Save detector information to a file

Parameters:

filename - the file to save detector information to

Throws:

DeviceException

loadAndInitializeDetectors

void loadAndInitializeDetectors(String string)
                         throws Exception

Create and initialize detectors specified in a file.

Parameters:

string - the file to read detector information from

Throws:

DeviceException

Exception

readoutScalerData

Object readoutScalerData()
                  throws DeviceException

Read out corrected scaler data

Returns:

the data as an object

Throws:

DeviceException

getChannelLabels

List<String> getChannelLabels()

get the current channel label list;

Returns:

the channel labels

getNumberofGrades

int getNumberofGrades()

Returns:

the number of resolution bins

getResGrade

String getResGrade()
            throws DeviceException

Returns:

the res grade

Throws:

DeviceException

setResGrade

void setResGrade(String grade)
          throws DeviceException

Parameters:

grade -

Throws:

DeviceException

getReadoutMode

String getReadoutMode()
               throws DeviceException

Returns:

the readoutMode

Throws:

DeviceException

setReadoutMode

void setReadoutMode(String readoutMode)
             throws DeviceException

Sets the type of data which will be collected from the detector and returned by the readout and readoutCorrectData methods.

Parameters:

readoutMode -

Throws:

DeviceException

setDeadtimeCalculationEnergy

void setDeadtimeCalculationEnergy(Double energy)
                           throws DeviceException

The energy to use when calculating the energy-dependent deadtime correction factors. This value is used internally and affects the values returned by the readout and readoutScalerData methods. This will not affect the results of the getRawScalerData method.

It is recommended that the energy used in EXAFS experiments, for example, is the edge energy. It should be near the peak counts in the spectrum being studied.

If the value null or 0.0 is entered then the deadtime calculation used will not be energy dependent.

Parameters:

energy -

Throws:

DeviceException

getDeadtimeCalculationEnergy

Double getDeadtimeCalculationEnergy()
                             throws DeviceException

Returns:

Double - the energy used in energy-dependent deadtime calculations.

Throws:

DeviceException