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
- See Also:
-
Field Summary
Fields inherited from class gda.device.detector.NXDetector
lastReadoutValue, UNSUPPORTED_PART_OF_SCANNABLE_INTERFACE, UNSUPPORTED_SET_FUNCTIONFields inherited from class gda.device.detector.DetectorBase
collectionTimeFields inherited from class gda.device.scannable.ScannableBase
__doc__, DEFAULT_INPUT_NAME, DEFAULT_OUTPUT_FORMAT, extraNames, inputNames, level, outputFormatFields inherited from class gda.device.DeviceBase
DEFAULT_PROTECTION_LEVEL_PROPERTYFields inherited from interface gda.device.Scannable
ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidTells the detector to begin to collect a set of data, then returns immediately.Get theHardwareTriggerProviderthat represents the controller this Detector is wired to.intbooleanDetectors that sample some value at the time of a trigger should return False.booleanprotected voidprepareCollectionStrategyAtScanStart(int numberImagesPerCollection, ScanInformation scanInfo) readout()Returns the latest data collected as well as general detector informationvoidsetHardwareTriggering(boolean b) Configure the Detector to trigger on hardware triggers, or not.voidsetHardwareTriggerProvider(HardwareTriggerProvider hardwareTriggerProvider) voidsetNumberImagesToCollect(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, waitWhileBusyMethods inherited from class gda.device.detector.DetectorBase
checkPositionValid, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, setCollectionTime, toFormattedStringMethods 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, waitWhileBusyMethods inherited from class gda.device.DeviceBase
addIObserver, close, deleteIObserver, deleteIObservers, getAttribute, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setName, setProtectionLevelMethods inherited from class gda.factory.ConfigurableBase
configure, isConfigured, reconfigure, setConfiguredMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface gda.factory.Configurable
configure, isConfigureAtStartup, isConfigured, reconfigureMethods inherited from interface gda.device.Detector
createsOwnFiles, endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getFileStructure, getStatus, prepareForCollection, setCollectionTime, waitWhileBusyMethods inherited from interface gda.device.Device
close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevelMethods inherited from interface gda.observable.IObservable
addIObserver, deleteIObserver, deleteIObserversMethods 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
-
prepareCollectionStrategyAtScanStart
protected void prepareCollectionStrategyAtScanStart(int numberImagesPerCollection, ScanInformation scanInfo) throws Exception, DeviceException - Overrides:
prepareCollectionStrategyAtScanStartin classNXDetector- Throws:
ExceptionDeviceException
-
setNumberImagesToCollect
public void setNumberImagesToCollect(int numberImagesToCollect) Description copied from interface:HardwareTriggeredDetectorTell the detector how many scan points to collect. (Unfortunately named images).- Specified by:
setNumberImagesToCollectin interfaceHardwareTriggeredDetector- Parameters:
numberImagesToCollect-
-
getNumberImagesToCollect
public int getNumberImagesToCollect() -
collectData
Description copied from interface:DetectorTells 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:
collectDatain interfaceDetector- Overrides:
collectDatain classNXDetector- Throws:
DeviceException
-
readout
Description copied from interface:NexusDetectorReturns the latest data collected as well as general detector information- Specified by:
readoutin interfaceDetector- Specified by:
readoutin interfaceNexusDetector- Overrides:
readoutin classNXDetector- Returns:
- the data collected
- Throws:
DeviceException
-
getHardwareTriggerProvider
Description copied from interface:HardwareTriggeredDetectorGet theHardwareTriggerProviderthat represents the controller this Detector is wired to.- Specified by:
getHardwareTriggerProviderin interfaceHardwareTriggeredDetector- Returns:
- the trigger provider
-
integratesBetweenPoints
public boolean integratesBetweenPoints()Description copied from interface:HardwareTriggeredDetectorDetectors 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:
integratesBetweenPointsin interfaceHardwareTriggeredDetector- Returns:
- true for detectors that integrates b
-
setHardwareTriggering
Description copied from interface:HardwareTriggerableDetectorConfigure the Detector to trigger on hardware triggers, or not.- Specified by:
setHardwareTriggeringin interfaceHardwareTriggerableDetector- Parameters:
b-- Throws:
DeviceException
-
isHardwareTriggering
public boolean isHardwareTriggering()- Specified by:
isHardwareTriggeringin interfaceHardwareTriggerableDetector- Returns:
- true if configured to triger on hardware triggers.
-