Package org.eclipse.scanning.example.detector

Class DarkImageDetector

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

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

org.eclipse.scanning.example.detector.DarkImageDetector

All Implemented Interfaces:

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

public class DarkImageDetector
extends AbstractRunnableDevice<DarkImageModel>
implements IWritableDetector<DarkImageModel>, INexusDevice<NXdetector>

A dummy detector which must be set up with references to two Scannables representing X and Y positions. When used in a step scan, this detector generates a value of 0 if the point (x, y) is in the Mandelbrot set, and greater than zero otherwise.

Note: values will always be high if used at (x, y) positions more than 2 units away from the origin.

Field Summary

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

Method Summary

Modifier and Type	Method	Description
void	abort()	Call to terminate the scan before it has finished.
void	clean()
void	configure(DarkImageModel model)	Call to configure the device.
NXdetector	createNexusObject(NexusScanInfo info)
NexusObjectProvider<NXdetector>	getNexusProvider(NexusScanInfo info)	Returns the object provider required for writing correct NeXus files.
void	pause()	Allowed when the device is in Running state.
void	resume()	Allowed when the device is in Paused state.
void	run(IPosition pos)	Blocking call to execute the scan.
boolean	write(IPosition pos)	For GDA9 detectors, returns a boolean for the readout completed, true for complete, false for error.

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

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, register, removeRunListener, reset, 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

seek

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

reset

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

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

Constructor Details

DarkImageDetector

public DarkImageDetector()
                  throws IOException

Throws:

IOException

Method Details

clean

public void clean()

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.

Specified by:

getNexusProvider in interface INexusDevice<NXdetector>

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

createNexusObject

public NXdetector createNexusObject(NexusScanInfo info)
                             throws NexusException

Throws:

NexusException

configure

public void configure(DarkImageModel 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<DarkImageModel>

Overrides:

configure in class AbstractRunnableDevice<DarkImageModel>

Parameters:

model -

Throws:

ScanningException

run

public void run(IPosition pos)
         throws ScanningException,
InterruptedException

Description copied from interface: IRunnableDevice

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

Specified by:

run in interface IRunnableDevice<DarkImageModel>

Throws:

ScanningException

InterruptedException

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.

Specified by:

write in interface IWritableDetector<DarkImageModel>

Returns:

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

Throws:

ScanningException

abort

public void abort()
           throws ScanningException

Description copied from interface: IRunnableDevice

Call to terminate the scan before it has finished.

Specified by:

abort in interface IRunnableDevice<DarkImageModel>

Overrides:

abort in class AbstractRunnableDevice<DarkImageModel>

Throws:

ScanningException

pause

public void pause()
           throws ScanningException

Description copied from interface: IPausableDevice

Allowed when the device is in Running state. Will block until the device is in a rest state. When paused the same thread must call resume() or abort() which has paused or an IllegalMonitorState Exception will be thrown.

Specified by:

pause in interface IPausableDevice<DarkImageModel>

Overrides:

pause in class AbstractRunnableDevice<DarkImageModel>

Throws:

ScanningException

resume

public void resume()
            throws ScanningException

Description copied from interface: IPausableDevice

Allowed when the device is in Paused state. Will block until the device is unpaused. When paused the same thread must call resume() or abort() which has paused or an IllegalMonitorState Exception will be thrown.

Specified by:

resume in interface IPausableDevice<DarkImageModel>

Overrides:

resume in class AbstractRunnableDevice<DarkImageModel>

Throws:

ScanningException