Package gda.device.zebra

Class ZebraExternallyTriggeredDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.zebra.ZebraExternallyTriggeredDetector

All Implemented Interfaces:

Detector, HardwareTriggeredDetector, Device, Scannable, ContinuouslyScannableViaController, PositionCallableProvider<Double>, Configurable, Findable, gda.observable.IObservable, DetectorWithReadoutTime, Serializable, org.springframework.beans.factory.InitializingBean

public class ZebraExternallyTriggeredDetector
extends DetectorBase
implements ContinuouslyScannableViaController, org.springframework.beans.factory.InitializingBean, PositionCallableProvider<Double>, HardwareTriggeredDetector, DetectorWithReadoutTime

Class to use with ZebraMonitorController and ConstantVelocityScanLine to monitor flyscans on a Zebra triggered by a ZebraConstantVelocityMoveController as a detector.

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

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
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.
ContinuousMoveController	getContinuousMoveController()
HardwareTriggerProvider	getHardwareTriggerProvider()	Get the HardwareTriggerProvider that represents the controller this Detector is wired to.
int	getPcCapture()
Callable<Double>	getPositionCallable()
double	getReadOutTime()
int	getStatus()	Returns the current collecting state of the device.
boolean	integratesBetweenPoints()	Detectors that sample some value at the time of a trigger should return False.
boolean	isOperatingContinously()	Indicates whether the Scannable has deferred control to the he configured ContinuousMoveController
void	prepareForCollection()	Default which should be overridden by subclasses.
Object	readout()	Returns the latest data collected.
void	setContinuousMoveController(ContinuousMoveController controller)
void	setNumberImagesToCollect(int numberImagesToCollect)	Tell the detector how many scan points to collect.
void	setOperatingContinuously(boolean b)	Enable or disable control through the configured ContinuousMoveController
void	setPcCapture(int pcCapture)
void	setZebraMonitorController(ZebraMonitorController continuousMoveController)

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

Constructor Details

ZebraExternallyTriggeredDetector

public ZebraExternallyTriggeredDetector()

Method Details

setZebraMonitorController

public void setZebraMonitorController(ZebraMonitorController continuousMoveController)

getPcCapture

public int getPcCapture()

setPcCapture

public void setPcCapture(int pcCapture)

setOperatingContinuously

public void setOperatingContinuously(boolean b)
                              throws DeviceException

Description copied from interface: ContinuouslyScannableViaController

Enable or disable control through the configured ContinuousMoveController

Specified by:

setOperatingContinuously in interface ContinuouslyScannableViaController

Parameters:

b -

Throws:

DeviceException

isOperatingContinously

public boolean isOperatingContinously()

Description copied from interface: ContinuouslyScannableViaController

Indicates whether the Scannable has deferred control to the he configured ContinuousMoveController

Specified by:

isOperatingContinously in interface ContinuouslyScannableViaController

Returns:

true if control is defered

getContinuousMoveController

public ContinuousMoveController getContinuousMoveController()

Specified by:

getContinuousMoveController in interface ContinuouslyScannableViaController

setContinuousMoveController

public void setContinuousMoveController(ContinuousMoveController controller)

Specified by:

setContinuousMoveController in interface ContinuouslyScannableViaController

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getPositionCallable

public Callable<Double> getPositionCallable()
                                     throws DeviceException

Specified by:

getPositionCallable in interface PositionCallableProvider<Double>

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

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

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

getReadOutTime

public double getReadOutTime()

Specified by:

getReadOutTime in interface DetectorWithReadoutTime

Returns:

DeadTime after an exposure before another image can be triggered in seconds

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

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 -

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