Package uk.ac.gda.devices.detector.xspress3

Class Xspress3QexafsDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

uk.ac.gda.devices.detector.xspress3.Xspress3QexafsDetector

All Implemented Interfaces:

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

public class Xspress3QexafsDetector
extends DetectorBase
implements BufferedDetector

Single detector class solution for QEXAFS. This solves some timing issues arising when using three separate detector classes (e.g. Xspress3QexafsDetector invalid input: '&' Xspress3BufferedDetectorv2 invalid input: '&' BufferedDetector) especially related to readout of data from Xspress3 HDF file.

See Also:

• Serialized Form

Field Summary

Fields inherited from class gda.device.detector.DetectorBase

collectionTime

Fields inherited from class gda.device.scannable.ScannableBase

__doc__, DEFAULT_INPUT_NAME, DEFAULT_OUTPUT_FORMAT, extraNames, inputNames, level, outputFormat

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

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

Constructor Summary

Constructors

Constructor	Description
Xspress3QexafsDetector()

Method Summary

Modifier and Type	Method	Description
void	atScanStart()	Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case)
void	clearMemory()	Clears the detector memory
void	collectData()	Tells the detector to begin to collect a set of data, then returns immediately.
boolean	createsOwnFiles()	Returns a value which indicates whether the detector creates its own files.
ContinuousParameters	getContinuousParameters()
String[]	getExtraNames()	Additional names for extra values that returned by getPosition().
int	getNumberFrames()
String[]	getOutputFormat()	Returns an array of strings which are the format strings to use when pretty printing parts of the output
int	getStatus()	Returns the current collecting state of the device.
boolean	isContinuousMode()
int	maximumReadFrames()	As certain detectors may cause memory issues if too many frames are attempted to be read in one go, this is the maximum for this detector based on its current configuration (i.e.
void	prepareForCollection()	Default which should be overridden by subclasses.
Object[]	readAllFrames()	An array of the data from the detector.
NXDetectorData[]	readFrames(int startFrame, int finalFrame)	An array of the data from the detector.
Object	readout()	Returns the latest data collected.
void	setContinuousMode(boolean on)	When in slave mode the detector will be triggered by an external signal to collect each frame of data.
void	setContinuousParameters(ContinuousParameters parameters)	Sets the parameters which define the continuous movement to use
void	setQexafsScaler(BufferedScaler scaler)
void	setQexafsXspress(Xspress3BufferedDetector qexafsXspress)

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getPosition, isBusy, setCollectionTime, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, externalToInternal, getInputNames, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, getAttribute, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setName, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

configure, isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Detector

endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getFileStructure, 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, checkPositionValid, getInputNames, getLevel, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString

Constructor Details

Xspress3QexafsDetector

public Xspress3QexafsDetector()

Method Details

setQexafsXspress

public void setQexafsXspress(Xspress3BufferedDetector qexafsXspress)

setQexafsScaler

public void setQexafsScaler(BufferedScaler scaler)

getExtraNames

public String[] getExtraNames()

Description copied from interface: Scannable

Additional names for extra values that returned by getPosition().

Specified by:

getExtraNames in interface Scannable

Overrides:

getExtraNames in class ScannableBase

Returns:

array of names of the extra elements if the array returned by getPosition is larger than the array required by moveTo

getOutputFormat

public String[] getOutputFormat()

Description copied from interface: Scannable

Returns an array of strings which are the format strings to use when pretty printing parts of the output

Specified by:

getOutputFormat in interface Scannable

Overrides:

getOutputFormat in class ScannableBase

Returns:

string array

atScanStart

public void atScanStart()
                 throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanStart in interface Scannable

Overrides:

atScanStart in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanStart()

prepareForCollection

public void prepareForCollection()
                          throws DeviceException

Description copied from class: DetectorBase

Default which should be overridden by subclasses.

Specified by:

prepareForCollection in interface Detector

Overrides:

prepareForCollection in class DetectorBase

Throws:

DeviceException

See Also:

• Detector.prepareForCollection()

readFrames

public NXDetectorData[] readFrames(int startFrame,
 int finalFrame)
                            throws DeviceException

Description copied from interface: BufferedDetector

An array of the data from the detector. Each element is one frame of data. The first frame is 0.

Specified by:

readFrames in interface BufferedDetector

Parameters:

startFrame -

finalFrame -

Returns:

Object

Throws:

DeviceException

collectData

public void collectData()
                 throws DeviceException

Description copied from interface: Detector

Tells the detector to begin to collect a set of data, then returns immediately. Should cause the hardware to start collecting immediately: if there is any delay then detectors used in the same scan would collect over different times when beam conditions may differ.

Specified by:

collectData in interface Detector

Throws:

DeviceException

getStatus

public int getStatus()
              throws DeviceException

Description copied from interface: Detector

Returns the current collecting state of the device.

Specified by:

getStatus in interface Detector

Returns:

BUSY if the detector has not finished the requested operation(s), IDLE if in an completely idle state and STANDBY if temporarily suspended.

Throws:

DeviceException

readout

public Object readout()
               throws DeviceException

Description copied from interface: Detector

Returns the latest data collected. The size of the Object returned must be consistent with the values returned by getDataDimensions and getExtraNames.

If LocalProperties.GDA_SCAN_CONCURRENTSCAN_READOUT_CONCURRENTLY is true then motors may be moved while the detector readouts. The value returned must not be effected by any concurrent motor or shutter movements. See Detector.waitWhileBusy() and ConcurrentScan. Readout must block until the detector is ready to respond quickly to Detector.collectData() again.

Specified by:

readout in interface Detector

Returns:

the data collected

Throws:

DeviceException

createsOwnFiles

public boolean createsOwnFiles()
                        throws DeviceException

Description copied from interface: Detector

Returns a value which indicates whether the detector creates its own files. If it does (return true) the readout() method returns the name of the latest file created as a string. If it does not (return false) the readout() method will return the data directly.

Specified by:

createsOwnFiles in interface Detector

Returns:

true if readout() returns filenames

Throws:

DeviceException

clearMemory

public void clearMemory()
                 throws DeviceException

Description copied from interface: BufferedDetector

Clears the detector memory

Specified by:

clearMemory in interface BufferedDetector

Throws:

DeviceException

setContinuousMode

public void setContinuousMode(boolean on)
                       throws DeviceException

Description copied from interface: BufferedDetector

When in slave mode the detector will be triggered by an external signal to collect each frame of data.

Specified by:

setContinuousMode in interface BufferedDetector

Parameters:

on -

Throws:

DeviceException

isContinuousMode

public boolean isContinuousMode()
                         throws DeviceException

Specified by:

isContinuousMode in interface BufferedDetector

Returns:

true if the detector is ready to accept trigger pulses

Throws:

DeviceException

setContinuousParameters

public void setContinuousParameters(ContinuousParameters parameters)
                             throws DeviceException

Description copied from interface: BufferedDetector

Sets the parameters which define the continuous movement to use

Specified by:

setContinuousParameters in interface BufferedDetector

Parameters:

parameters -

Throws:

DeviceException

getContinuousParameters

public ContinuousParameters getContinuousParameters()
                                             throws DeviceException

Specified by:

getContinuousParameters in interface BufferedDetector

Returns:

ContinuousParameters

Throws:

DeviceException

getNumberFrames

public int getNumberFrames()
                    throws DeviceException

Specified by:

getNumberFrames in interface BufferedDetector

Returns:

number of frames of data in memory which have been collected

Throws:

DeviceException

readAllFrames

public Object[] readAllFrames()
                       throws DeviceException

Description copied from interface: BufferedDetector

An array of the data from the detector. Each element is one frame of data.

Specified by:

readAllFrames in interface BufferedDetector

Returns:

Object

Throws:

DeviceException

maximumReadFrames

public int maximumReadFrames()
                      throws DeviceException

Description copied from interface: BufferedDetector

As certain detectors may cause memory issues if too many frames are attempted to be read in one go, this is the maximum for this detector based on its current configuration (i.e. after setContinuousMode(True) has been called.

The lowest value returned from any of the detectors in a continuous scan will be the limit set.

If there is no limit then this method should return Integer.MAX_VALUE.

Specified by:

maximumReadFrames in interface BufferedDetector

Returns:

int - the maximum number of frames which should be read at any one time from this detector

Throws:

DeviceException