Package gda.device.detector.countertimer

Class TfgXspress2

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.countertimer.CounterTimerBase

gda.device.detector.countertimer.TFGCounterTimer

gda.device.detector.countertimer.TfgXspress2

All Implemented Interfaces:

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

Direct Known Subclasses:

CallableTfgXspress2, TfgXspress2NoCorrection, TfgXspress2Raw

@Deprecated(since="GDA 8.44")
public class TfgXspress2
extends TFGCounterTimer

Deprecated.

Adapter class for the gda.device.detector.xspress.Xspress2System so that it acts as a CounterTimer.

Used for returning scaler data from the Xspress2 as an array of doubles rather than a Nexus tree.

This has a slave mode for when its used in the same scan as another class which triggers the tfg.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected XspressDetector	xspress	Deprecated.

Fields inherited from class gda.device.detector.countertimer.TFGCounterTimer

isTFGv2

Fields inherited from class gda.device.detector.countertimer.CounterTimerBase

slave, timer

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
TfgXspress2()	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	collectData()	Deprecated. Tells the detector to begin to collect a set of data, then returns immediately.
void	configure()	Deprecated. Default implementation for classes that do not have to do any specific configuration. Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
boolean	createsOwnFiles()	Deprecated. Returns a value which indicates whether the detector creates its own files.
String	getDescription()	Deprecated.
String	getDetectorID()	Deprecated.
String	getDetectorType()	Deprecated.
String[]	getExtraNames()	Deprecated. Override scannablebase to work in scans
String[]	getInputNames()	Deprecated. Override ScannableBase to work within scans
String[]	getOutputFormat()	Deprecated. Returns an array of strings which are the format strings to use when pretty printing parts of the output
Object	getPosition()	Deprecated. Override DetectorBase to work within scans
XspressDetector	getXspress()	Deprecated.
String	getXspressSystemName()	Deprecated. Get the Xspress system name
double[]	readChannel(int startFrame, int frameCount, int channel)	Deprecated. For a time framing counter-timer read out a specified channel, beginning from the specified start frame number using the requested frame count.
double[]	readFrame(int startChannel, int channelCount, int frame)	Deprecated. For a time framing counter-timer read out a specified frame, beginning from the specified start channel number using the requested channel count.
Object	readout()	Deprecated. Returns the latest data collected.
void	restart()	Deprecated. For a time framing counter-timer this restarts framing, from the paused state.
void	setXspress(XspressDetector xspress)	Deprecated.
void	setXspressSystemName(String xspressSystemName)	Deprecated. Set the Xspress system name
void	start()	Deprecated. For a time framing counter-timer this initiates framing.

Methods inherited from class gda.device.detector.countertimer.TFGCounterTimer

isTFGv2, setTFGv2

Methods inherited from class gda.device.detector.countertimer.CounterTimerBase

addFrameSet, addFrameSet, clearFrameSets, getCurrentCycle, getCurrentFrame, getMaximumFrames, getStatus, getTimer, getTimerName, isSlave, loadFrameSets, setCycles, setSlave, setTimer, setTimerName, stop

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, getCollectionTime, getDataDimensions, isBusy, prepareForCollection, 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, atScanStart, externalToInternal, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, 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

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

isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Detector

endCollection, getCollectionTime, getDataDimensions, getFileStructure, prepareForCollection, 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, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, toFormattedString

Field Details

xspress

protected XspressDetector xspress

Deprecated.

Constructor Details

TfgXspress2

public TfgXspress2()

Deprecated.

Method Details

configure

public void configure()
               throws FactoryException

Deprecated.

Description copied from class: ConfigurableBase

Default implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.

Specified by:

configure in interface Configurable

Overrides:

configure in class CounterTimerBase

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

setXspressSystemName

public void setXspressSystemName(String xspressSystemName)

Deprecated.

Set the Xspress system name

Parameters:

xspressSystemName - the Xspress system name

getXspressSystemName

public String getXspressSystemName()

Deprecated.

Get the Xspress system name

Returns:

the Xspress system name.

getXspress

public XspressDetector getXspress()

Deprecated.

Returns:

Returns the xspress.

setXspress

public void setXspress(XspressDetector xspress)

Deprecated.

Parameters:

xspress - The xspress to set.

readout

public Object readout()
               throws DeviceException

Deprecated.

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.

Returns:

the data collected

Throws:

DeviceException

collectData

public void collectData()
                 throws DeviceException

Deprecated.

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.

Throws:

DeviceException

readChannel

public double[] readChannel(int startFrame,
 int frameCount,
 int channel)
                     throws DeviceException

Deprecated.

Description copied from interface: CounterTimer

For a time framing counter-timer read out a specified channel, beginning from the specified start frame number using the requested frame count.

Parameters:

startFrame - starting frame number (1st=0)

frameCount - number of frames to read the counter data out from

channel - read this channel

Returns:

array of requested readout counter-timer data

Throws:

DeviceException

readFrame

public double[] readFrame(int startChannel,
 int channelCount,
 int frame)
                   throws DeviceException

Deprecated.

Description copied from interface: CounterTimer

For a time framing counter-timer read out a specified frame, beginning from the specified start channel number using the requested channel count.

Parameters:

startChannel - starting channel number (1st=0)

channelCount - number of channels to read the counter data out from

frame - read this frame

Returns:

array of requested readout counter-timer data

Throws:

DeviceException

restart

public void restart()
             throws DeviceException

Deprecated.

Description copied from interface: CounterTimer

For a time framing counter-timer this restarts framing, from the paused state.

Specified by:

restart in interface CounterTimer

Overrides:

restart in class CounterTimerBase

Throws:

DeviceException

start

public void start()
           throws DeviceException

Deprecated.

Description copied from interface: CounterTimer

For a time framing counter-timer this initiates framing.

Specified by:

start in interface CounterTimer

Overrides:

start in class CounterTimerBase

Throws:

DeviceException

createsOwnFiles

public boolean createsOwnFiles()
                        throws DeviceException

Deprecated.

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.

Returns:

true if readout() returns filenames

Throws:

DeviceException

getPosition

public Object getPosition()
                   throws DeviceException

Deprecated.

Override DetectorBase to work within scans

Specified by:

getPosition in interface Scannable

Overrides:

getPosition in class DetectorBase

Returns:

Current position with an element for each input and extra field. null if their are no fields.

Throws:

DeviceException

See Also:

• Scannable.getPosition()

getInputNames

public String[] getInputNames()

Deprecated.

Override ScannableBase to work within scans

Specified by:

getInputNames in interface Scannable

Overrides:

getInputNames in class ScannableBase

Returns:

array of the names of the elements of the object returned by getPosition

getExtraNames

public String[] getExtraNames()

Deprecated.

Override scannablebase to work in scans

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()

Deprecated.

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

getDescription

public String getDescription()
                      throws DeviceException

Deprecated.

Specified by:

getDescription in interface Detector

Overrides:

getDescription in class DetectorBase

Returns:

A description of the detector.

Throws:

DeviceException

getDetectorID

public String getDetectorID()
                     throws DeviceException

Deprecated.

Specified by:

getDetectorID in interface Detector

Overrides:

getDetectorID in class DetectorBase

Returns:

A identifier for this detector.

Throws:

DeviceException

getDetectorType

public String getDetectorType()
                       throws DeviceException

Deprecated.

Specified by:

getDetectorType in interface Detector

Overrides:

getDetectorType in class DetectorBase

Returns:

The type of detector.

Throws:

DeviceException