Package gda.device.detector.addetector

Class HardwareTriggerableADDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.addetector.ADDetector

gda.device.detector.addetector.HardwareTriggerableADDetector

All Implemented Interfaces:

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

Direct Known Subclasses:

ADPilatus

public class HardwareTriggerableADDetector
extends ADDetector
implements HardwareTriggerableDetector

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class gda.device.detector.addetector.ADDetector

ADDetector.NullFileWriter

Field Summary

Fields inherited from class gda.device.detector.addetector.ADDetector

afterPropertiesSetCalled, FILEPATH_EXTRANAME, firstReadoutInScan

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

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
void	atScanLineStart()	Read settings of filewriter for later use when predicting filenames to put into callables
void	atScanStart()	Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case)
void	collectData()	Tells the detector to begin to collect a set of data, then returns immediately.
protected String	createFileName()
protected String	createFileNameForExposure(int exposureNumber)
double	getExposureCompletionTimeoutS()
NXCollectionStrategyPlugin	getHardwareTriggeredCollectionStrategy()
HardwareTriggerProvider	getHardwareTriggerProvider()	Get the HardwareTriggerProvider that represents the controller this Detector is wired to.
NXCollectionStrategyPlugin	getNonHardwareTriggeredCollectionStrategy()
int	getNumberImagesToCollect()
Callable<NexusTreeProvider>	getPositionCallable()
boolean	integratesBetweenPoints()	Detectors that sample some value at the time of a trigger should return False.
boolean	isExposureCompleteWhenArrayCounterSaysSo()
boolean	isExposureCompleteWhenFileIsVisible()
boolean	isHardwareTriggering()
void	setExposureCompleteWhenArrayCounterSaysSo(boolean exposureCompleteWhenArrayCounterSaysSo)
void	setExposureCompleteWhenFileIsVisible(boolean exposureCompleteWhenFileIsVisible)
void	setExposureCompletionTimeoutS(double exposureCompletionTimeoutS)
void	setHardwareTriggeredCollectionStrategy(NXCollectionStrategyPlugin hardwareTriggeredCollectionStrategy)
void	setHardwareTriggering(boolean hardwareTriggering)	Configure the Detector to trigger on hardware triggers, or not.
void	setHardwareTriggerProvider(HardwareTriggerProvider triggerProvider)
void	setIntegratesBetweenPoints(boolean integratesBetweenPoints)
void	setNonHardwareTriggeredCollectionStrategy(NXCollectionStrategyPlugin nonHardwareTriggeredCollectionStrategy)
void	setNumberImagesToCollect(int numberImagesToCollect)	Tell the detector how many scan points to collect.
void	waitWhileExposureCompletes(int exposureNumber)

Methods inherited from class gda.device.detector.addetector.ADDetector

addDoubleItemToNXData, addMultipleDoubleItemsToNXData, appendDataAxes, appendNXDetectorDataFromCollectionStrategy, asynchronousMoveTo, atCommandFailure, atScanEnd, clearCachedCallable, configure, configureExtraNamesAndOutputFormat, createNXDetectorData, createsOwnFiles, endCollection, getAdBase, getCollectionStrategy, getDataChunking, getDescription, getDetectorID, getDetectorType, getFileWriter, getMetaDataProvider, getNdArray, getNdFile, getNdOverlays, getNdPython, getNdStats, getPosition, getStatus, isBusy, isCheckFileExists, isComputeCentroid, isComputeStats, isDisableCallbacks, isReadAcquisitionPeriod, isReadAcquisitionTime, isReadArray, isReadCapturedFramesCount, isReadFilepath, isUsePipeline, prepareForArrayAndStatsCollection, prepareForCollection, readout, readoutArrayIntoNXDetectorData, reset, setAdBase, setCheckFileExists, setCollectionStrategy, setComputeCentroid, setComputeStats, setDataChunking, setDescription, setDetectorID, setDetectorType, setDisableCallbacks, setFileWriter, setMetaDataProvider, setNdArray, setNdFile, setNdOverlays, setNdPython, setNdStats, setReadAcquisitionPeriod, setReadAcquisitionTime, setReadArray, setReadCapturedFramesCount, setReadFilepath, setUsePipeline, stop, waitWhileBusy

Methods inherited from class gda.device.detector.DetectorBase

checkPositionValid, getCollectionTime, getDataDimensions, 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, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, 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

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

Constructor Details

HardwareTriggerableADDetector

public HardwareTriggerableADDetector()

Method Details

setIntegratesBetweenPoints

public void setIntegratesBetweenPoints(boolean integratesBetweenPoints)

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

setExposureCompleteWhenFileIsVisible

public void setExposureCompleteWhenFileIsVisible(boolean exposureCompleteWhenFileIsVisible)

isExposureCompleteWhenFileIsVisible

public boolean isExposureCompleteWhenFileIsVisible()

setExposureCompleteWhenArrayCounterSaysSo

public void setExposureCompleteWhenArrayCounterSaysSo(boolean exposureCompleteWhenArrayCounterSaysSo)

isExposureCompleteWhenArrayCounterSaysSo

public boolean isExposureCompleteWhenArrayCounterSaysSo()

getExposureCompletionTimeoutS

public double getExposureCompletionTimeoutS()

setExposureCompletionTimeoutS

public void setExposureCompletionTimeoutS(double exposureCompletionTimeoutS)

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 hardwareTriggering)
                           throws DeviceException

Description copied from interface: HardwareTriggerableDetector

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

Specified by:

setHardwareTriggering in interface HardwareTriggerableDetector

Parameters:

hardwareTriggering -

Throws:

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

atScanStart

public void atScanStart()
                 throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanStart in interface Scannable

Overrides:

atScanStart in class ADDetector

Throws:

DeviceException

See Also:

• Scannable.atScanStart()

isHardwareTriggering

public boolean isHardwareTriggering()

Specified by:

isHardwareTriggering in interface HardwareTriggerableDetector

Returns:

true if configured to triger on hardware triggers.

atScanLineStart

public void atScanLineStart()
                     throws DeviceException

Read settings of filewriter for later use when predicting filenames to put into callables

Specified by:

atScanLineStart in interface Scannable

Overrides:

atScanLineStart in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanLineStart()

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 ADDetector

Throws:

DeviceException

createFileName

protected String createFileName()
                         throws Exception

Overrides:

createFileName in class ADDetector

Throws:

Exception

createFileNameForExposure

protected String createFileNameForExposure(int exposureNumber)

getPositionCallable

public Callable<NexusTreeProvider> getPositionCallable()
                                                throws DeviceException

Specified by:

getPositionCallable in interface PositionCallableProvider<NexusTreeProvider>

Overrides:

getPositionCallable in class ADDetector

Throws:

DeviceException

waitWhileExposureCompletes

public void waitWhileExposureCompletes(int exposureNumber)
                                throws InterruptedException,
Exception

Throws:

InterruptedException

Exception

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Overrides:

afterPropertiesSet in class ADDetector

Throws:

Exception

getHardwareTriggeredCollectionStrategy

public NXCollectionStrategyPlugin getHardwareTriggeredCollectionStrategy()

setHardwareTriggeredCollectionStrategy

public void setHardwareTriggeredCollectionStrategy(NXCollectionStrategyPlugin hardwareTriggeredCollectionStrategy)

getNonHardwareTriggeredCollectionStrategy

public NXCollectionStrategyPlugin getNonHardwareTriggeredCollectionStrategy()

setNonHardwareTriggeredCollectionStrategy

public void setNonHardwareTriggeredCollectionStrategy(NXCollectionStrategyPlugin nonHardwareTriggeredCollectionStrategy)