Package gda.device.vmxm.mirrorcommissioning

Class MirrorCommissioningDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.vmxm.mirrorcommissioning.MirrorCommissioningDetector

All Implemented Interfaces:

Detector, DetectorSnapper, Device, Scannable, Configurable, Findable, gda.observable.IObservable, Serializable

Direct Known Subclasses:

AndorZylaDetector, Cam4Detector

public abstract class MirrorCommissioningDetector
extends DetectorBase
implements DetectorSnapper

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	MirrorCommissioningDetector.Acquire
protected static enum	MirrorCommissioningDetector.Capture
protected static enum	MirrorCommissioningDetector.FileWriteMode
protected static enum	MirrorCommissioningDetector.WriteFile

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	AUTO_INCREMENT_PV_NAME
protected final String	basePVName
protected static final String	CAPTURE_PV_NAME
protected static final String	DEFAULT_FILE_TYPE
protected static final String	DUMMY_IMAGE_PATH
protected static final String	EMPTY_STRING
protected static final String	FILE_NAME_PV_NAME
protected static final String	FILE_PATH_PV_NAME
protected static final String	FILE_WRITE_MODE_PV_NAME
protected final String	filename
protected final String	filePath
protected final String	fileType
protected static final String	FULL_FILE_NAME_PV_NAME
protected String	lastImagePathName
protected static final org.slf4j.Logger	logger
protected static final String	WRITE_FILE_PV_NAME

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

Modifier	Constructor	Description
protected	MirrorCommissioningDetector()

Method Summary

Modifier and Type	Method	Description
String[]	acquire()	Trigger an acquisition and block until complete.
void	asynchronousMoveTo(Object position)	Default implementation is to set the collection time and to call the collectData method
void	collectData()	Tells the detector to begin to collect a set of data, then returns immediately.
void	configure()	Default implementation for classes that do not have to do any specific configuration. Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
boolean	createsOwnFiles()	Returns a value which indicates whether the detector creates its own files.
protected void	doAcquire()
double	getAcquirePeriod()	Return the acquisition period resulting from the last configured collection time.
protected PV<MirrorCommissioningDetector.Acquire>	getAcquirePV()
protected abstract String	getAcquirePVName()
double	getAcquireTime()	Return the acquisition time resulting from the last configured collection time.
protected PV<Double>	getAcquireTimePV()
protected abstract String	getAcquireTimePVName()
protected PV<EpicsConstants.YesNo>	getAutoIncPV()
protected abstract String	getBasePVPropertyName()
protected PV<MirrorCommissioningDetector.Capture>	getCapturePV()
protected abstract String	getDefaultBasePVName()
protected String	getDefaultFileType()
String	getDetectorID()
String	getDetectorType()
protected abstract String	getFilenamePropertyName()
protected abstract String	getFilePathPropertyName()
protected PV<String>	getFilePathPV()
protected String	getFilePathPVName()
protected abstract String	getFileTypePropertyName()
protected PV<MirrorCommissioningDetector.FileWriteMode>	getFileWriteModePV()
protected String	getLastImagePathName()
protected PV<String>	getOutputFilePV()
String	getOutputFolderRoot()
protected String	getPVName(String pvName)
protected String	getPVName(String fileType, String pvName)
int	getStatus()	Returns the current collecting state of the device.
protected PV<MirrorCommissioningDetector.WriteFile>	getWriteFilePV()
void	prepareForAcquisition(double acquisitionTime)	Sets the collection time for the next collection (implicitly a single image collection).
Object	readout()	Returns the latest data collected.
void	reconfigure()	Re-initialisation of values and states.
protected void	setAcquireTime()
protected void	setAutoInc()
protected void	setCapture()
void	setCollectionTime(double collectionTime)	Sets the collection time, in seconds, to be used during the next call of collectData.
protected void	setFileName()
protected void	setFilePath()
protected void	setFileWriteMode()
protected abstract void	setImageMode()
protected void	setNumCapture()
void	setOutputFolderRoot(String outputFolderRoot)
protected void	writeFile()

Methods inherited from class gda.device.detector.DetectorBase

checkPositionValid, endCollection, getCollectionTime, getDataDimensions, getDescription, getPosition, isBusy, prepareForCollection, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy, 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, 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

isConfigureAtStartup, isConfigured

Methods inherited from interface gda.device.Detector

getFileStructure, 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

atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop

Field Details

DEFAULT_FILE_TYPE

protected static final String DEFAULT_FILE_TYPE

See Also:

• Constant Field Values

FULL_FILE_NAME_PV_NAME

protected static final String FULL_FILE_NAME_PV_NAME

See Also:

• Constant Field Values

WRITE_FILE_PV_NAME

protected static final String WRITE_FILE_PV_NAME

See Also:

• Constant Field Values

CAPTURE_PV_NAME

protected static final String CAPTURE_PV_NAME

See Also:

• Constant Field Values

FILE_WRITE_MODE_PV_NAME

protected static final String FILE_WRITE_MODE_PV_NAME

See Also:

• Constant Field Values

AUTO_INCREMENT_PV_NAME

protected static final String AUTO_INCREMENT_PV_NAME

See Also:

• Constant Field Values

FILE_NAME_PV_NAME

protected static final String FILE_NAME_PV_NAME

See Also:

• Constant Field Values

FILE_PATH_PV_NAME

protected static final String FILE_PATH_PV_NAME

See Also:

• Constant Field Values

EMPTY_STRING

protected static final String EMPTY_STRING

See Also:

• Constant Field Values

logger

protected static final org.slf4j.Logger logger

DUMMY_IMAGE_PATH

protected static final String DUMMY_IMAGE_PATH

See Also:

• Constant Field Values

basePVName

protected final String basePVName

fileType

protected final String fileType

filePath

protected final String filePath

filename

protected final String filename

lastImagePathName

protected String lastImagePathName

Constructor Details

MirrorCommissioningDetector

protected MirrorCommissioningDetector()

Method Details

configure

public void configure()

Description copied from class: ConfigurableBase

Default implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.

Specified by:

configure in interface Configurable

Overrides:

configure in class ConfigurableBase

reconfigure

public void reconfigure()

Description copied from interface: Configurable

Re-initialisation of values and states.

Moved from Reconfigurable which has been deleted

Specified by:

reconfigure in interface Configurable

Overrides:

reconfigure in class ConfigurableBase

asynchronousMoveTo

public void asynchronousMoveTo(Object position)
                        throws DeviceException

Description copied from class: DetectorBase

Default implementation is to set the collection time and to call the collectData method

Specified by:

asynchronousMoveTo in interface Scannable

Overrides:

asynchronousMoveTo in class DetectorBase

Parameters:

position - Position to move to should have an element for each input field.

Throws:

DeviceException

See Also:

• Scannable.asynchronousMoveTo(java.lang.Object)

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

Throws:

DeviceException

acquire

public String[] acquire()
                 throws DeviceException

Description copied from interface: DetectorSnapper

Trigger an acquisition and block until complete.

Specified by:

acquire in interface DetectorSnapper

Returns:

list of all resulting files.

Throws:

DeviceException

setCollectionTime

public void setCollectionTime(double collectionTime)
                       throws DeviceException

Description copied from interface: Detector

Sets the collection time, in seconds, to be used during the next call of collectData.

Specified by:

setCollectionTime in interface Detector

Overrides:

setCollectionTime in class DetectorBase

Parameters:

collectionTime - the collection time in seconds

Throws:

DeviceException

getFilePathPV

protected PV<String> getFilePathPV()

getAutoIncPV

protected PV<EpicsConstants.YesNo> getAutoIncPV()

getFileWriteModePV

protected PV<MirrorCommissioningDetector.FileWriteMode> getFileWriteModePV()

getCapturePV

protected PV<MirrorCommissioningDetector.Capture> getCapturePV()

getAcquireTimePV

protected PV<Double> getAcquireTimePV()

getAcquirePV

protected PV<MirrorCommissioningDetector.Acquire> getAcquirePV()

getWriteFilePV

protected PV<MirrorCommissioningDetector.WriteFile> getWriteFilePV()

getOutputFilePV

protected PV<String> getOutputFilePV()

getPVName

protected String getPVName(String pvName)

getPVName

protected String getPVName(String fileType,
 String pvName)

prepareForAcquisition

public void prepareForAcquisition(double acquisitionTime)
                           throws DeviceException

Description copied from interface: DetectorSnapper

Sets the collection time for the next collection (implicitly a single image collection).

Specified by:

prepareForAcquisition in interface DetectorSnapper

Parameters:

acquisitionTime -

Throws:

DeviceException

getAcquireTime

public double getAcquireTime()
                      throws DeviceException

Description copied from interface: DetectorSnapper

Return the acquisition time resulting from the last configured collection time. This will depend on the collection strategy.

Specified by:

getAcquireTime in interface DetectorSnapper

Returns:

acquisition time in seconds

Throws:

DeviceException

getAcquirePeriod

public double getAcquirePeriod()
                        throws DeviceException

Description copied from interface: DetectorSnapper

Return the acquisition period resulting from the last configured collection time. This will depend on the collection strategy.

Specified by:

getAcquirePeriod in interface DetectorSnapper

Returns:

acquisition time in seconds

Throws:

DeviceException

readout

public Object readout()
               throws DeviceException

Description copied from interface: Detector

Returns the latest data collected. The size of the Object returned must be consistent with the values returned by getDataDimensions and getExtraNames.

If LocalProperties.GDA_SCAN_CONCURRENTSCAN_READOUT_CONCURRENTLY is true then motors may be moved while the detector readouts. The value returned must not be effected by any concurrent motor or shutter movements. See Detector.waitWhileBusy() and ConcurrentScan. Readout must block until the detector is ready to respond quickly to Detector.collectData() again.

Specified by:

readout in interface Detector

Returns:

the data collected

Throws:

DeviceException

getStatus

public int getStatus()
              throws DeviceException

Description copied from interface: Detector

Returns the current collecting state of the device.

Specified by:

getStatus in interface Detector

Returns:

BUSY if the detector has not finished the requested operation(s), IDLE if in an completely idle state and STANDBY if temporarily suspended.

Throws:

DeviceException

createsOwnFiles

public boolean createsOwnFiles()
                        throws DeviceException

Description copied from interface: Detector

Returns a value which indicates whether the detector creates its own files. If it does (return true) the readout() method returns the name of the latest file created as a string. If it does not (return false) the readout() method will return the data directly.

Specified by:

createsOwnFiles in interface Detector

Returns:

true if readout() returns filenames

Throws:

DeviceException

getDetectorID

public String getDetectorID()
                     throws DeviceException

Specified by:

getDetectorID in interface Detector

Overrides:

getDetectorID in class DetectorBase

Returns:

A identifier for this detector.

Throws:

DeviceException

getDetectorType

public String getDetectorType()
                       throws DeviceException

Specified by:

getDetectorType in interface Detector

Overrides:

getDetectorType in class DetectorBase

Returns:

The type of detector.

Throws:

DeviceException

getDefaultBasePVName

protected abstract String getDefaultBasePVName()

getDefaultFileType

protected String getDefaultFileType()

getFilePathPVName

protected String getFilePathPVName()

getAcquirePVName

protected abstract String getAcquirePVName()

getAcquireTimePVName

protected abstract String getAcquireTimePVName()

setFilePath

protected void setFilePath()
                    throws IOException

Throws:

IOException

setFileName

protected void setFileName()
                    throws IOException

Throws:

IOException

setAutoInc

protected void setAutoInc()
                   throws IOException

Throws:

IOException

setFileWriteMode

protected void setFileWriteMode()
                         throws IOException

Throws:

IOException

setNumCapture

protected void setNumCapture()
                      throws IOException

Throws:

IOException

setCapture

protected void setCapture()
                   throws IOException

Throws:

IOException

setAcquireTime

protected void setAcquireTime()
                       throws IOException,
DeviceException

Throws:

IOException

DeviceException

setImageMode

protected abstract void setImageMode()
                              throws IOException

Throws:

IOException

doAcquire

protected void doAcquire()
                  throws IOException,
IllegalStateException,
TimeoutException,
InterruptedException

Throws:

IOException

IllegalStateException

TimeoutException

InterruptedException

writeFile

protected void writeFile()
                  throws IOException

Throws:

IOException

getLastImagePathName

protected String getLastImagePathName()
                               throws IOException

Throws:

IOException

getOutputFolderRoot

public String getOutputFolderRoot()

setOutputFolderRoot

public void setOutputFolderRoot(String outputFolderRoot)

getFilenamePropertyName

protected abstract String getFilenamePropertyName()

getFilePathPropertyName

protected abstract String getFilePathPropertyName()

getFileTypePropertyName

protected abstract String getFileTypePropertyName()

getBasePVPropertyName

protected abstract String getBasePVPropertyName()