Package uk.ac.diamond.daq.detectors.addetector

Class AreaDetectorRunnableDevice

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

org.eclipse.scanning.api.device.AbstractRunnableDevice<AreaDetectorRunnableDeviceModel>

uk.ac.diamond.daq.detectors.addetector.AbstractAreaDetectorRunnableDevice

uk.ac.diamond.daq.detectors.addetector.AreaDetectorRunnableDevice

All Implemented Interfaces:

INexusDevice<NXdetector>, IActivatable, IPausableDevice<AreaDetectorRunnableDeviceModel>, IResettableDevice, IRunnableDevice<AreaDetectorRunnableDeviceModel>, IRunnableEventDevice<AreaDetectorRunnableDeviceModel>, IWritableDetector<AreaDetectorRunnableDeviceModel>, IDeviceRoleActor, IConfigurable<AreaDetectorRunnableDeviceModel>, ILevel, IModelProvider<AreaDetectorRunnableDeviceModel>, INameable, IScanAttributeContainer, IValidator<AreaDetectorRunnableDeviceModel>

Direct Known Subclasses:

AreaDetectorRunnableDeviceWaitForArray, AreaDetectorWritingFilesRunnableDevice

public class AreaDetectorRunnableDevice
extends AbstractAreaDetectorRunnableDevice

This is an implementation of a new style GDA detector that can connects to an area detector.

It gets the data back from the AD using the array plugin and then writes it out inside GDA.

Field Summary

Fields

Modifier and Type	Field	Description
protected ADDetector	adDetector

Fields inherited from class org.eclipse.scanning.api.device.AbstractRunnableDevice

connectorService, model, runnableDeviceService

Fields inherited from interface org.eclipse.scanning.api.ILevel

MAXIMUM

Constructor Summary

Constructors

Constructor	Description
AreaDetectorRunnableDevice()

Method Summary

Modifier and Type	Method	Description
void	configure(AreaDetectorRunnableDeviceModel model)	Call to configure the device.
protected void	configureAreaDetector(AreaDetectorRunnableDeviceModel model)
NexusObjectProvider<NXdetector>	getNexusProvider(NexusScanInfo info)	Returns the object provider required for writing correct NeXus files.
void	run(IPosition position)	Blocking call to execute the scan.
void	scanAbort(ScanInformation info)	NOTE: Arguments are filled with annotations using introspection.
void	scanEnd(ScanInformation info)	add call to ADDetector.atScanEnd() so decorators in collection strategy work to restore detector state.
void	scanFault(ScanInformation info)	Delegates to ADDetector.atCommandFailure()
void	scanStart(ScanInformation info)	add call to ADDetector.atScanStart() so decorators in collection strategy work to save detector state.
boolean	write(IPosition pos)	For GDA9 detectors, returns a boolean for the readout completed, true for complete, false for error.

Methods inherited from class uk.ac.diamond.daq.detectors.addetector.AbstractAreaDetectorRunnableDevice

levelEnd, levelStart, pointEnd, pointStart, postConfigure, preConfigure, scanFinally, scanPaused, scanResumed, writeComplete

Methods inherited from class org.eclipse.scanning.api.device.AbstractRunnableDevice

abort, addRunListener, disable, fireRunPerformed, fireRunWillPerform, fireStateChanged, fireWritePerformed, fireWriteWillPerform, getConfigureTime, getConnectorService, getDeviceHealth, getDeviceInformation, getDeviceInformation, getDeviceState, getLevel, getModel, getPublisher, getRole, getRunnableDeviceService, getScanAttribute, getScanAttributeNames, getScanId, getSupportedScanModes, isActivated, isAlive, isDeviceBusy, pause, register, removeRunListener, reset, resume, seek, setActivated, setAlive, setBusy, setConfigureTime, setConnectorService, setDeviceInformation, setDeviceState, setLevel, setModel, setPublisher, setRole, setRunnableDeviceService, setScanAttribute, setScanId, setSupportedScanMode, setSupportedScanModes, setSupportedScanModes, toString, validate

Methods inherited from class org.eclipse.scanning.api.AbstractNameable

equals, getName, hashCode, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.scanning.api.device.models.IDeviceRoleActor

getRole, getSupportedScanModes, setRole

Methods inherited from interface org.eclipse.scanning.api.ILevel

getLevel, setLevel

Methods inherited from interface org.eclipse.scanning.api.IModelProvider

setModel, updateModel

Methods inherited from interface org.eclipse.scanning.api.INameable

getName, setName

Methods inherited from interface org.eclipse.dawnsci.nexus.INexusDevice

getCustomNexusModification, getName, getNexusProviders, register

Methods inherited from interface org.eclipse.scanning.api.device.IPausableDevice

pause, resume, seek

Methods inherited from interface org.eclipse.scanning.api.device.IResettableDevice

reset

Methods inherited from interface org.eclipse.scanning.api.device.IRunnableDevice

abort, disable, getDeviceHealth, getDeviceState, getModel, isAlive, isDeviceBusy, latch, latch, run, setAlive, start, throwFirstRunException

Methods inherited from interface org.eclipse.scanning.api.device.IRunnableEventDevice

addRunListener, fireRunPerformed, fireRunWillPerform, fireWritePerformed, fireWriteWillPerform, removeRunListener

Methods inherited from interface org.eclipse.scanning.api.IValidator

setService, validate

Field Details

adDetector

protected ADDetector adDetector

Constructor Details

AreaDetectorRunnableDevice

public AreaDetectorRunnableDevice()

Method Details

run

public void run(IPosition position)
         throws ScanningException,
InterruptedException

Description copied from interface: IRunnableDevice

Blocking call to execute the scan. The position specified may be null.

Throws:

ScanningException

InterruptedException

configure

public void configure(AreaDetectorRunnableDeviceModel model)
               throws ScanningException

Description copied from interface: IConfigurable

Call to configure the device. If the model provided is invalid, a scanning exception will be thrown.

Specified by:

configure in interface IConfigurable<AreaDetectorRunnableDeviceModel>

Overrides:

configure in class AbstractRunnableDevice<AreaDetectorRunnableDeviceModel>

Parameters:

model -

Throws:

ScanningException

configureAreaDetector

protected void configureAreaDetector(AreaDetectorRunnableDeviceModel model)
                              throws ScanningException

Throws:

ScanningException

getNexusProvider

public NexusObjectProvider<NXdetector> getNexusProvider(NexusScanInfo info)
                                                 throws NexusException

Description copied from interface: INexusDevice

Returns the object provider required for writing correct NeXus files.

In this method you should prepare the LazyDatasets the device will fill during the scan. You can also write out static device metadata, which will not change during the scan.

Use the methods on NexusNodeFactory to create a NeXus object which matches the device e.g. a NXdetector. final NXdetector detector = NexusNodeFactory.createNXdetector();

On the detector object you can create LazyDatasets and keep references which you can later use during the scan to write data. e.g. imageData = detector.initializeLazyDataset(NXdetector.NX_DATA, info.getRank() + 2, Double.class); You should also set chunking on the LazyDatasets you create e.g. imageData.setChunking(info.createChunk(detectorXSize, detectorYSize));.

In this method you can also write static metadata such as the detector exposure e.g. detector.setField("exposure_time", model.getExposure());. Or static datasets such as the image axis data detector.setDataset("image_x_axis", DatasetFactory.createLinearSpace(DoubleDataset.class, minX, maxX, xPoints)); For fields that are defined in the NXDL base class definition for the returned nexus object, a setXXX or setXXXScalar method may be used as appropriate, e.g. detector.setLocalName(DatasetFactory.createFromObject("my detector")); or detector.setLocalNameScalar("my detector");

If this device is a 'metadata scannable', then the device should write its data at this point directly into the returned nexus object. This can be done with the NXobject.setField(String, Object) method, or the setXXXScalar methods for fields defined in the appropriate NXDL base class definition.

The default implementation of this method throws UnsupportedOperationException. One of either this method or INexusDevice.getNexusProviders(NexusScanInfo) must be overridden to create and return the nexus object(s) for this INexusDevice.

Parameters:

info - information about the scan which can be useful when creating datasets e.g. info.getRank()

Returns:

The NXobject created using the nodeFactory to represent this device

Throws:

NexusException - if the nexus object could not be created for any reason

write

public boolean write(IPosition pos)
              throws ScanningException

Description copied from interface: IWritableDetector

For GDA9 detectors, returns a boolean for the readout completed, true for complete, false for error. Generally detectors running in GDA9 will be IDetector. For GDA8 detectors, the readout will be overridden.

Returns:

true for a successful readout. If false the events will not be fired and the scan will continue.

Throws:

ScanningException

scanStart

public void scanStart(ScanInformation info)
               throws ScanningException

add call to ADDetector.atScanStart() so decorators in collection strategy work to save detector state.

Overrides:

scanStart in class AbstractAreaDetectorRunnableDevice

Parameters:

info -

Throws:

ScanningException

scanEnd

public void scanEnd(ScanInformation info)
             throws ScanningException

add call to ADDetector.atScanEnd() so decorators in collection strategy work to restore detector state.

Overrides:

scanEnd in class AbstractAreaDetectorRunnableDevice

Parameters:

info -

Throws:

ScanningException

scanAbort

public void scanAbort(ScanInformation info)
               throws ScanningException

Description copied from class: AbstractAreaDetectorRunnableDevice

NOTE: Arguments are filled with annotations using introspection. OSGi services may be requested (null if not found) NOTE: More than one method may be annotated.

Overrides:

scanAbort in class AbstractAreaDetectorRunnableDevice

Parameters:

info -

Throws:

ScanningException

scanFault

public void scanFault(ScanInformation info)
               throws ScanningException

Delegates to ADDetector.atCommandFailure()

Overrides:

scanFault in class AbstractAreaDetectorRunnableDevice

Parameters:

info -

Throws:

ScanningException