Package gda.device.detector

Class HardwareTriggeredNXDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.NXDetector

gda.device.detector.HardwareTriggeredNXDetector

All Implemented Interfaces:

Detector, HardwareTriggerableDetector, HardwareTriggeredDetector, NexusDetector, NXPluginDetector, Device, Scannable, PositionCallableProvider<NexusTreeProvider>, Configurable, Findable, gda.observable.IObservable, Serializable, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

HardwareTriggeredNXDetectorWithReadoutTime

public class HardwareTriggeredNXDetector
extends NXDetector
implements HardwareTriggerableDetector

See Also:

• Serialized Form

Field Summary

Fields inherited from class gda.device.detector.NXDetector

lastReadoutValue, UNSUPPORTED_PART_OF_SCANNABLE_INTERFACE, UNSUPPORTED_SET_FUNCTION

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

Method Summary

Modifier and Type	Method	Description
void	collectData()	Tells the detector to begin to collect a set of data, then returns immediately.
HardwareTriggerProvider	getHardwareTriggerProvider()	Get the HardwareTriggerProvider that represents the controller this Detector is wired to.
int	getNumberImagesToCollect()
boolean	integratesBetweenPoints()	Detectors that sample some value at the time of a trigger should return False.
boolean	isHardwareTriggering()
protected void	prepareCollectionStrategyAtScanStart(int numberImagesPerCollection, ScanInformation scanInfo)
NexusTreeProvider	readout()	Returns the latest data collected as well as general detector information
void	setHardwareTriggering(boolean b)	Configure the Detector to trigger on hardware triggers, or not.
void	setHardwareTriggerProvider(HardwareTriggerProvider hardwareTriggerProvider)
void	setNumberImagesToCollect(int numberImagesToCollect)	Tell the detector how many scan points to collect.

Methods inherited from class gda.device.detector.NXDetector

__getattr__, __str__, afterPropertiesSet, asynchronousMoveTo, atCommandFailure, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, createsOwnFiles, endCollection, getAdditionalPluginList, getCollectionStrategy, getExtraNames, getFileStructure, getInputNames, getOutputFormat, getPlugin, getPluginList, getPluginMap, getPosition, getPositionCallable, getStatus, isAddCollectTimeMs, isBusy, prepareForCollection, setAddCollectTimeMs, setAdditionalPluginList, setCollectionStrategy, setExtraNames, setInputNames, setOutputFormat, stop, waitWhileBusy

Methods inherited from class gda.device.detector.DetectorBase

checkPositionValid, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, setCollectionTime, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, externalToInternal, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setLevel, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, 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

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, 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

HardwareTriggeredNXDetector

public HardwareTriggeredNXDetector()

Method Details

setHardwareTriggerProvider

public void setHardwareTriggerProvider(HardwareTriggerProvider hardwareTriggerProvider)

prepareCollectionStrategyAtScanStart

protected void prepareCollectionStrategyAtScanStart(int numberImagesPerCollection,
 ScanInformation scanInfo)
                                             throws Exception,
DeviceException

Overrides:

prepareCollectionStrategyAtScanStart in class NXDetector

Throws:

Exception

DeviceException

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 -

getNumberImagesToCollect

public int getNumberImagesToCollect()

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 NXDetector

Throws:

DeviceException

readout

public NexusTreeProvider readout()
                          throws DeviceException

Description copied from interface: NexusDetector

Returns the latest data collected as well as general detector information

Specified by:

readout in interface Detector

Specified by:

readout in interface NexusDetector

Overrides:

readout in class NXDetector

Returns:

the data collected

Throws:

DeviceException

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

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

setHardwareTriggering

public void setHardwareTriggering(boolean b)
                           throws DeviceException

Description copied from interface: HardwareTriggerableDetector

Configure the Detector to trigger on hardware triggers, or not.

Specified by:

setHardwareTriggering in interface HardwareTriggerableDetector

Parameters:

b -

Throws:

DeviceException

isHardwareTriggering

public boolean isHardwareTriggering()

Specified by:

isHardwareTriggering in interface HardwareTriggerableDetector

Returns:

true if configured to triger on hardware triggers.