Package gda.device.detector.countertimer

Class PositionStreamingTfgScaler

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

All Implemented Interfaces:

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

public class PositionStreamingTfgScaler
extends TfgScalerWithLogValues
implements PositionCallableProvider<double[]>, PositionInputStream<double[]>

See Also:

• Serialized Form

Nested Class Summary

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

TfgScalerWithDarkCurrent.DarkCurrentBean

Field Summary

Fields

Modifier and Type	Field	Description
protected DAServer	daServer

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

Method Summary

Modifier and Type	Method	Description
void	atScanLineEnd()	Called for every Scannable at the end of every scan
void	atScanLineStart()	Called for every Scannable at the start of every scan
void	collectData()	Tells the detector to begin to collect a set of data, then returns immediately.
DAServer	getDaServer()
Callable<double[]>	getPositionCallable()
Double[]	getTimes()
List<double[]>	read(int maxToRead)	Return at least one element, but no more than maxToRead, waiting until able to do so.
void	setDaServer(DAServer daServer)
void	setTimes(Double[] times)

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

addScalerOutputConfig, appendLogValues, clearScalerOutputConfig, configureScalerOutputProcessor, getI0ScalerChannel, getiRefScalerChannel, getItScalerChannel, getScalerOutputConfig, getScalerOutputProcessor, getTimeChannelName, getTotalChans, getUseCustomisedOutput, isOutputLogValues, performCorrections, readFrame, readout, 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, atCommandFailure, 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, isBusy, prepareForCollection, setCollectionTime, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, 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

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, getProtectionLevel, 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, checkPositionValid, getExtraNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, toFormattedString

Field Details

daServer

protected DAServer daServer

Constructor Details

PositionStreamingTfgScaler

public PositionStreamingTfgScaler()

Method Details

getTimes

public Double[] getTimes()

setTimes

public void setTimes(Double[] times)

getDaServer

public DAServer getDaServer()

setDaServer

public void setDaServer(DAServer daServer)

read

public List<double[]> read(int maxToRead)
                    throws NoSuchElementException,
InterruptedException,
DeviceException

Description copied from interface: PositionInputStream

Return at least one element, but no more than maxToRead, waiting until able to do so. The parameter maxToRead is there to protect the caller from potentially receiving too much data in call, not to meet the needs of the detector.

Specified by:

read in interface PositionInputStream<double[]>

Parameters:

maxToRead - the maximum number of elements to read. Must be one or more.

Returns:

at least one element from the head of the stream, oldest on the left

Throws:

NoSuchElementException - if the stream will have nothing to return

InterruptedException

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

Overrides:

collectData in class TfgScaler

Throws:

DeviceException

getPositionCallable

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

Specified by:

getPositionCallable in interface PositionCallableProvider<double[]>

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

atScanLineEnd

public void atScanLineEnd()
                   throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the end 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:

atScanLineEnd in interface Scannable

Overrides:

atScanLineEnd in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanLineEnd()