Package gda.device.detector.countertimer

Class TFGTriggeredScaler

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.TfgScaler

gda.device.detector.countertimer.TfgScalerWithDarkCurrent

gda.device.detector.countertimer.TfgScalerWithLogValues

gda.device.detector.countertimer.TFGTriggeredScaler

All Implemented Interfaces:

CounterTimer, Detector, DarkCurrentDetector, HardwareTriggeredDetector, Device, Scannable, PositionCallableProvider<double[]>, Configurable, Findable, gda.observable.IObservable, Serializable

public class TFGTriggeredScaler
extends TfgScalerWithLogValues
implements HardwareTriggeredDetector, PositionCallableProvider<double[]>

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class gda.device.detector.countertimer.TfgScalerWithDarkCurrent

TfgScalerWithDarkCurrent.DarkCurrentBean

Field Summary

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

LNI0IT_LABEL, LNITIREF_LABEL

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

numChannelsToRead, scaler, timeChannelRequired

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

Method Summary

Modifier and Type	Method	Description
void	atCommandFailure()	Hook to be used by Scan and pos commands to inform the Scannable that an exception, such as a DeviceExcpetion, has occurred.
void	atScanLineStart()	Called for every Scannable at the start of every scan
void	clearMemory()
void	collectData()	Tells the detector to begin to collect a set of data, then returns immediately.
DAServer	getDaserver()
HardwareTriggerProvider	getHardwareTriggerProvider()	Get the HardwareTriggerProvider that represents the controller this Detector is wired to.
int	getNumberFrames()
Callable<double[]>	getPositionCallable()
int	getTtlSocket()
boolean	integratesBetweenPoints()	Detectors that sample some value at the time of a trigger should return False.
boolean	isBusy()	Check if the Scannable is moving/operating.
Object[]	readFrames(int startFrame, int finalFrame)
double[]	readout()	Returns the latest data collected.
void	setDaserver(DAServer daserver)
void	setHardwareTriggerProvider(HardwareTriggerProvider triggerProvider)
void	setIntegrateBetweenPoints(boolean integrateBetweenPoints)
void	setNumberImagesToCollect(int numberImagesToCollect)	Tell the detector how many scan points to collect.
void	setReturnCountRates(Boolean returnCountRates)
void	setTtlSocket(int ttlSocket)
void	waitForReadoutCompletion()

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

addScalerOutputConfig, appendLogValues, clearScalerOutputConfig, configureScalerOutputProcessor, getI0ScalerChannel, getiRefScalerChannel, getItScalerChannel, getScalerOutputConfig, getScalerOutputProcessor, getTimeChannelName, getTotalChans, getUseCustomisedOutput, isOutputLogValues, performCorrections, readFrame, restoreExtraNamesFormats, saveExtraNamesFormats, setI0ScalerChannel, setiRefScalerChannel, setItScalerChannel, setOutputLogValues, setScalerOutputConfig, setTimeChannelName, setUseCustomisedOutput

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

acquireDarkCurrent, adjustChannelForDarkCurrent, adjustForDarkCurrent, atScanEnd, atScanStart, getDarkCurrent, getDarkCurrentCollectionTime, getDarkCurrentResults, isDarkCurrentRequired, isUseReset, setDarkCurrent, setDarkCurrentCollectionTime, setDarkCurrentRequired, setUseReset

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

addFrameSet, addFrameSet, clearFrameSets, configure, countAsync, createsOwnFiles, getAttribute, getDescription, getDetectorID, getDetectorType, getFirstDataChannel, getInputNames, getMinimumReadoutDelay, getNumChannelsToRead, getScaler, getScalerName, isTimeChannelRequired, readChannel, readChans, readFrame, readoutCurrentFrame, readoutFrames, setAttribute, setFirstDataChannel, setMinimumReadoutDelay, setNumChannelsToRead, setScaler, setScalerName, setTimeChannelRequired, start, stop

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

isTFGv2, setTFGv2

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

getCurrentCycle, getCurrentFrame, getMaximumFrames, getStatus, getTimer, getTimerName, isSlave, loadFrameSets, restart, setCycles, setSlave, setTimer, setTimerName

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, getCollectionTime, getDataDimensions, getPosition, prepareForCollection, setCollectionTime, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, externalToInternal, getExtraNames, getLevel, getOutputFormat, 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, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, 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

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Detector

createsOwnFiles, endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getFileStructure, getStatus, 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, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString

Constructor Details

TFGTriggeredScaler

public TFGTriggeredScaler()

Method Details

setHardwareTriggerProvider

public void setHardwareTriggerProvider(HardwareTriggerProvider triggerProvider)

getHardwareTriggerProvider

public HardwareTriggerProvider getHardwareTriggerProvider()

Description copied from interface: HardwareTriggeredDetector

Get the HardwareTriggerProvider that represents the controller this Detector is wired to.

Specified by:

getHardwareTriggerProvider in interface HardwareTriggeredDetector

Returns:

the trigger provider

setIntegrateBetweenPoints

public void setIntegrateBetweenPoints(boolean integrateBetweenPoints)

clearMemory

public void clearMemory()
                 throws DeviceException

Throws:

DeviceException

getNumberFrames

public int getNumberFrames()
                    throws DeviceException

Throws:

DeviceException

readFrames

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

Throws:

DeviceException

setReturnCountRates

public void setReturnCountRates(Boolean returnCountRates)

waitForReadoutCompletion

public void waitForReadoutCompletion()
                              throws InterruptedException

Throws:

InterruptedException

atCommandFailure

public void atCommandFailure()
                      throws DeviceException

Description copied from class: ScannableBase

Hook to be used by Scan and pos commands to inform the Scannable that an exception, such as a DeviceExcpetion, has occurred. However not called when the command is aborted using an InterruptionException. If a Scan is aborted then only Scannable.stop() will be called by the Scan or pos command.

Useful for telling Scannables which hold state during a scan for example, to reset themselves. Used for example by CoordinatedMotionScannables. This hook should be used not in the same way as the stop hook. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atCommandFailure in interface Scannable

Overrides:

atCommandFailure in class TfgScaler

Throws:

DeviceException

See Also:

• Scannable.atCommandFailure()

readout

public double[] 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

Overrides:

readout in class TfgScalerWithLogValues

Returns:

the data collected

Throws:

DeviceException

See Also:

• Detector.readout()

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from class: DetectorBase

Check if the Scannable is moving/operating. default implementation is to call the getStatus method

Specified by:

isBusy in interface Scannable

Overrides:

isBusy in class DetectorBase

Returns:

true - if operation carried out by moveTo has not completed yet

Throws:

DeviceException

See Also:

• Scannable.isBusy()

getPositionCallable

public Callable<double[]> getPositionCallable()
                                       throws DeviceException

Specified by:

getPositionCallable in interface PositionCallableProvider<double[]>

Throws:

DeviceException

integratesBetweenPoints

public boolean integratesBetweenPoints()

Description copied from interface: HardwareTriggeredDetector

Detectors that sample some value at the time of a trigger should return False. Detectors such as counter timers should return True. If true ,TrajectoryScanLine will generate a trigger half a point before the motor reaches a demanded point such that the resulting bin of data is centred on the demand position. Area detectors that will be triggered by the first pulse should also return true.

Specified by:

integratesBetweenPoints in interface HardwareTriggeredDetector

Returns:

true for detectors that integrates b

setNumberImagesToCollect

public void setNumberImagesToCollect(int numberImagesToCollect)

Description copied from interface: HardwareTriggeredDetector

Tell the detector how many scan points to collect. (Unfortunately named images).

Specified by:

setNumberImagesToCollect in interface HardwareTriggeredDetector

Parameters:

numberImagesToCollect -

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

Overrides:

collectData in class TfgScaler

Throws:

DeviceException

atScanLineStart

public void atScanLineStart()
                     throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the start of every scan Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanLineStart in interface Scannable

Overrides:

atScanLineStart in class TfgScaler

Throws:

DeviceException

See Also:

• Scannable.atScanLineStart()

getDaserver

public DAServer getDaserver()

setDaserver

public void setDaserver(DAServer daserver)

getTtlSocket

public int getTtlSocket()

setTtlSocket

public void setTtlSocket(int ttlSocket)