Package uk.ac.gda.devices.odin.control

Class OdinDetectorDecorator

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

uk.ac.gda.devices.odin.control.OdinDetectorDecorator

All Implemented Interfaces:

Device, Configurable, Findable, gda.observable.IObservable, OdinDetectorController

Direct Known Subclasses:

OdinDetectorEiger, OdinDetectorEigerThresholdScan, OdinDetectorExcalibur

public abstract class OdinDetectorDecorator
extends DeviceBase
implements OdinDetectorController

Odin detectors share many common components but each individual detector behaves slightly differently. This decorator can be used to define specific detector behaviour

Field Summary

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OdinDetectorDecorator(OdinDetectorController delegate)

Method Summary

Modifier and Type	Method	Description
void	endRecording()	Stop the data writer
double	getAcquirePeriod()
double	getAcquireTime()
String	getLatestFilename()	Get the full path to the most recent file written
int	getNumFramesCaptured()
int	getNumImages()
int	getStatus()	Get status, this will return Detector.BUSY if either the datawriter or the detector acquisition is busy
void	prepareCamera(int frames, double requestedLiveTime, double requestedDeadTime, String imageMode, String triggerMode)	Get camera ready for acquisition e.g set the exposure time and wait time (in ms).
void	prepareDataWriter(int frames)	Prepare the Odin Data writer this may include setting the number of expected frames or ensuring that the compression settings are as required
void	setAcquirePeriod(double acquirePeriod)
void	setAcquireTime(double acquireTime)
void	setCompressionMode(String mode)
void	setDataOutput(String directory, String filePrefix)	Set the directory and the file prefix for the Odin datawriter
void	setNumImages(int numImages)
void	setOffsetAndUid(int offset, int uid)	Set the offet and uid for the filewriter.
void	startCollection()	Start the camera acquiring
void	startRecording()	Start the data writer
void	stopCollection()	Stop the camera acquiring
void	waitForWrittenFrames(int noFrames)
void	waitWhileAcquiring()	Wait until the detector acquisition (exposure) is 'Done'
void	waitWhileWriting()	Wait until the datawriter is 'Done'

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

Methods inherited from interface gda.factory.Configurable

configure, isConfigured, reconfigure

Constructor Details

OdinDetectorDecorator

protected OdinDetectorDecorator(OdinDetectorController delegate)

Method Details

setDataOutput

public void setDataOutput(String directory,
 String filePrefix)
                   throws DeviceException

Description copied from interface: OdinDetectorController

Set the directory and the file prefix for the Odin datawriter

Specified by:

setDataOutput in interface OdinDetectorController

Throws:

DeviceException

startCollection

public void startCollection()
                     throws DeviceException

Description copied from interface: OdinDetectorController

Start the camera acquiring

Specified by:

startCollection in interface OdinDetectorController

Throws:

DeviceException

stopCollection

public void stopCollection()
                    throws DeviceException

Description copied from interface: OdinDetectorController

Stop the camera acquiring

Specified by:

stopCollection in interface OdinDetectorController

Throws:

DeviceException

startRecording

public void startRecording()
                    throws DeviceException

Description copied from interface: OdinDetectorController

Start the data writer

Specified by:

startRecording in interface OdinDetectorController

Throws:

DeviceException

endRecording

public void endRecording()

Description copied from interface: OdinDetectorController

Stop the data writer

Specified by:

endRecording in interface OdinDetectorController

prepareCamera

public void prepareCamera(int frames,
 double requestedLiveTime,
 double requestedDeadTime,
 String imageMode,
 String triggerMode)
                   throws DeviceException

Description copied from interface: OdinDetectorController

Get camera ready for acquisition e.g set the exposure time and wait time (in ms). Things that only need to be set at the beginning of the scan

Specified by:

prepareCamera in interface OdinDetectorController

Throws:

DeviceException

getLatestFilename

public String getLatestFilename()

Description copied from interface: OdinDetectorController

Get the full path to the most recent file written

Specified by:

getLatestFilename in interface OdinDetectorController

getStatus

public int getStatus()

Description copied from interface: OdinDetectorController

Get status, this will return Detector.BUSY if either the datawriter or the detector acquisition is busy

Specified by:

getStatus in interface OdinDetectorController

Returns:

integer as defined on the Detector interface

waitWhileAcquiring

public void waitWhileAcquiring()

Description copied from interface: OdinDetectorController

Wait until the detector acquisition (exposure) is 'Done'

Specified by:

waitWhileAcquiring in interface OdinDetectorController

waitWhileWriting

public void waitWhileWriting()

Description copied from interface: OdinDetectorController

Wait until the datawriter is 'Done'

Specified by:

waitWhileWriting in interface OdinDetectorController

prepareDataWriter

public void prepareDataWriter(int frames)
                       throws DeviceException

Description copied from interface: OdinDetectorController

Prepare the Odin Data writer this may include setting the number of expected frames or ensuring that the compression settings are as required

Specified by:

prepareDataWriter in interface OdinDetectorController

Parameters:

frames - number of frames Odin Data will be expecting

Throws:

DeviceException

getAcquireTime

public double getAcquireTime()
                      throws DeviceException

Specified by:

getAcquireTime in interface OdinDetectorController

Throws:

DeviceException

setOffsetAndUid

public void setOffsetAndUid(int offset,
 int uid)
                     throws DeviceException

Description copied from interface: OdinDetectorController

Set the offet and uid for the filewriter. This may be required between frames depending on collection strategy.

Specified by:

setOffsetAndUid in interface OdinDetectorController

Parameters:

offset -

uid -

Throws:

DeviceException

getNumFramesCaptured

public int getNumFramesCaptured()

Specified by:

getNumFramesCaptured in interface OdinDetectorController

waitForWrittenFrames

public void waitForWrittenFrames(int noFrames)

Specified by:

waitForWrittenFrames in interface OdinDetectorController

setNumImages

public void setNumImages(int numImages)
                  throws DeviceException

Specified by:

setNumImages in interface OdinDetectorController

Throws:

DeviceException

getNumImages

public int getNumImages()
                 throws DeviceException

Specified by:

getNumImages in interface OdinDetectorController

Throws:

DeviceException

setCompressionMode

public void setCompressionMode(String mode)
                        throws DeviceException

Specified by:

setCompressionMode in interface OdinDetectorController

Throws:

DeviceException

setAcquireTime

public void setAcquireTime(double acquireTime)
                    throws DeviceException

Specified by:

setAcquireTime in interface OdinDetectorController

Throws:

DeviceException

setAcquirePeriod

public void setAcquirePeriod(double acquirePeriod)
                      throws DeviceException

Specified by:

setAcquirePeriod in interface OdinDetectorController

Throws:

DeviceException

getAcquirePeriod

public double getAcquirePeriod()
                        throws DeviceException

Specified by:

getAcquirePeriod in interface OdinDetectorController

Throws:

DeviceException