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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static enumprotected static enumprotected static enumprotected static enum -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final Stringprotected final Stringprotected static final Stringprotected static final Stringprotected static final Stringprotected static final Stringprotected static final Stringprotected static final Stringprotected static final Stringprotected final Stringprotected final Stringprotected final Stringprotected static final Stringprotected Stringprotected static final org.slf4j.Loggerprotected static final StringFields 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 TypeMethodDescriptionString[]acquire()Trigger an acquisition and block until complete.voidasynchronousMoveTo(Object position) Default implementation is to set the collection time and to call the collectData methodvoidTells the detector to begin to collect a set of data, then returns immediately.voidDefault 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.booleanReturns a value which indicates whether the detector creates its own files.protected voiddoubleReturn the acquisition period resulting from the last configured collection time.protected PV<MirrorCommissioningDetector.Acquire> protected abstract StringdoubleReturn the acquisition time resulting from the last configured collection time.protected abstract Stringprotected PV<EpicsConstants.YesNo> protected abstract Stringprotected PV<MirrorCommissioningDetector.Capture> protected abstract Stringprotected Stringprotected abstract Stringprotected abstract Stringprotected Stringprotected abstract Stringprotected PV<MirrorCommissioningDetector.FileWriteMode> protected Stringprotected Stringprotected StringintReturns the current collecting state of the device.protected PV<MirrorCommissioningDetector.WriteFile> voidprepareForAcquisition(double acquisitionTime) Sets the collection time for the next collection (implicitly a single image collection).readout()Returns the latest data collected.voidRe-initialisation of values and states.protected voidprotected voidprotected voidvoidsetCollectionTime(double collectionTime) Sets the collection time, in seconds, to be used during the next call of collectData.protected voidprotected voidprotected voidprotected abstract voidprotected voidvoidsetOutputFolderRoot(String outputFolderRoot) protected voidMethods inherited from class gda.device.detector.DetectorBase
checkPositionValid, endCollection, getCollectionTime, getDataDimensions, getDescription, getPosition, isBusy, prepareForCollection, toFormattedStringMethods 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, 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
isConfigured, setConfiguredMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface gda.factory.Configurable
isConfigureAtStartup, isConfiguredMethods inherited from interface gda.device.Detector
getFileStructure, 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
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
- See Also:
-
FULL_FILE_NAME_PV_NAME
- See Also:
-
WRITE_FILE_PV_NAME
- See Also:
-
CAPTURE_PV_NAME
- See Also:
-
FILE_WRITE_MODE_PV_NAME
- See Also:
-
AUTO_INCREMENT_PV_NAME
- See Also:
-
FILE_NAME_PV_NAME
- See Also:
-
FILE_PATH_PV_NAME
- See Also:
-
EMPTY_STRING
- See Also:
-
logger
protected static final org.slf4j.Logger logger -
DUMMY_IMAGE_PATH
- See Also:
-
basePVName
-
fileType
-
filePath
-
filename
-
lastImagePathName
-
-
Constructor Details
-
MirrorCommissioningDetector
protected MirrorCommissioningDetector()
-
-
Method Details
-
configure
public void configure()Description copied from class:ConfigurableBaseDefault 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:
configurein interfaceConfigurable- Overrides:
configurein classConfigurableBase
-
reconfigure
public void reconfigure()Description copied from interface:ConfigurableRe-initialisation of values and states.Moved from Reconfigurable which has been deleted
- Specified by:
reconfigurein interfaceConfigurable- Overrides:
reconfigurein classConfigurableBase
-
asynchronousMoveTo
Description copied from class:DetectorBaseDefault implementation is to set the collection time and to call the collectData method- Specified by:
asynchronousMoveToin interfaceScannable- Overrides:
asynchronousMoveToin classDetectorBase- Parameters:
position- Position to move to should have an element for each input field.- Throws:
DeviceException- See Also:
-
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- Throws:
DeviceException
-
acquire
Description copied from interface:DetectorSnapperTrigger an acquisition and block until complete.- Specified by:
acquirein interfaceDetectorSnapper- Returns:
- list of all resulting files.
- Throws:
DeviceException
-
setCollectionTime
Description copied from interface:DetectorSets the collection time, in seconds, to be used during the next call of collectData.- Specified by:
setCollectionTimein interfaceDetector- Overrides:
setCollectionTimein classDetectorBase- Parameters:
collectionTime- the collection time in seconds- Throws:
DeviceException
-
getFilePathPV
-
getAutoIncPV
-
getFileWriteModePV
-
getCapturePV
-
getAcquireTimePV
-
getAcquirePV
-
getWriteFilePV
-
getOutputFilePV
-
getPVName
-
getPVName
-
prepareForAcquisition
Description copied from interface:DetectorSnapperSets the collection time for the next collection (implicitly a single image collection).- Specified by:
prepareForAcquisitionin interfaceDetectorSnapper- Parameters:
acquisitionTime-- Throws:
DeviceException
-
getAcquireTime
Description copied from interface:DetectorSnapperReturn the acquisition time resulting from the last configured collection time. This will depend on the collection strategy.- Specified by:
getAcquireTimein interfaceDetectorSnapper- Returns:
- acquisition time in seconds
- Throws:
DeviceException
-
getAcquirePeriod
Description copied from interface:DetectorSnapperReturn the acquisition period resulting from the last configured collection time. This will depend on the collection strategy.- Specified by:
getAcquirePeriodin interfaceDetectorSnapper- Returns:
- acquisition time in seconds
- Throws:
DeviceException
-
readout
Description copied from interface:DetectorReturns 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_CONCURRENTLYis true then motors may be moved while the detector readouts. The value returned must not be effected by any concurrent motor or shutter movements. SeeDetector.waitWhileBusy()andConcurrentScan. Readout must block until the detector is ready to respond quickly toDetector.collectData()again.- Specified by:
readoutin interfaceDetector- Returns:
- the data collected
- Throws:
DeviceException
-
getStatus
Description copied from interface:DetectorReturns the current collecting state of the device.- Specified by:
getStatusin interfaceDetector- 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
Description copied from interface:DetectorReturns 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:
createsOwnFilesin interfaceDetector- Returns:
- true if readout() returns filenames
- Throws:
DeviceException
-
getDetectorID
- Specified by:
getDetectorIDin interfaceDetector- Overrides:
getDetectorIDin classDetectorBase- Returns:
- A identifier for this detector.
- Throws:
DeviceException
-
getDetectorType
- Specified by:
getDetectorTypein interfaceDetector- Overrides:
getDetectorTypein classDetectorBase- Returns:
- The type of detector.
- Throws:
DeviceException
-
getDefaultBasePVName
-
getDefaultFileType
-
getFilePathPVName
-
getAcquirePVName
-
getAcquireTimePVName
-
setFilePath
- Throws:
IOException
-
setFileName
- Throws:
IOException
-
setAutoInc
- Throws:
IOException
-
setFileWriteMode
- Throws:
IOException
-
setNumCapture
- Throws:
IOException
-
setCapture
- Throws:
IOException
-
setAcquireTime
- Throws:
IOExceptionDeviceException
-
setImageMode
- Throws:
IOException
-
doAcquire
protected void doAcquire() throws IOException, IllegalStateException, TimeoutException, InterruptedException -
writeFile
- Throws:
IOException
-
getLastImagePathName
- Throws:
IOException
-
getOutputFolderRoot
-
setOutputFolderRoot
-
getFilenamePropertyName
-
getFilePathPropertyName
-
getFileTypePropertyName
-
getBasePVPropertyName
-