Package gda.device.detector

Class NXDetectorSnappingDecorator

java.lang.Object

gda.device.detector.PassthroughDetectorWrapper

gda.device.detector.NXDetectorSnappingDecorator

All Implemented Interfaces:

Detector, NexusDetector, NXPluginDetector, DetectorSnapper, Device, Scannable, PositionCallableProvider<NexusTreeProvider>, Configurable, Findable, gda.observable.IObservable

public class NXDetectorSnappingDecorator
extends PassthroughDetectorWrapper
implements NXPluginDetector, DetectorSnapper

Decorator to extend an NXDetector to allow use in the "pos" command.

Uses a separate plugin list and collection strategy for use in the pos command and delegates to the decorated detector when used in a scan.

 
 <bean id="detector" class="NXDetectorSnappingDecorator">
 	<constructor-arg ref="_original_nxdetector_to_extend" />
 	<property name="snapperCollectionStrategy">
 		<bean class="SingleExposureStandard"> ... </bean>
 	</property>
 	<property name="snapperPluginList">
 		<list>
 			<bean class="SingleImagePerFileWriterWithNumTracker">
 				...
 			</bean>
 		</list>
 	</property>
 </bean>
 
 

Field Summary

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

Method Summary

Modifier and Type	Method	Description
org.python.core.PyString	__repr__()
org.python.core.PyString	__str__()
String[]	acquire()	Trigger an acquisition and block until complete.
void	atCommandFailure()	Hook to be used by Scan and pos commands to inform the Scannable that an exception, such as a DeviceExcpetion, has occurred.
void	atScanEnd()	Called for every Scannable at the end of a group of nested scans (or a single scan if that is the case).
void	atScanStart()	Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case)
double	getAcquirePeriod()	Return the acquisition period resulting from the last configured collection time.
double	getAcquireTime()	Return the acquisition time resulting from the last configured collection time.
List<NXPluginBase>	getAdditionalPluginList()
NXCollectionStrategyPlugin	getCollectionStrategy()
NXPluginDetector	getDelegate()
String[]	getExtraNames()	Additional names for extra values that returned by getPosition().
String	getName()	Get the object name.
List<NXPluginBase>	getPluginList()
Map<String,NXPluginBase>	getPluginMap()
Object	getPosition()	Returns the current position of the Scannable.
Callable<NexusTreeProvider>	getPositionCallable()
NXCollectionStrategyPlugin	getSnapperCollectionStrategy()
List<NXPluginBase>	getSnapperPluginList()
void	prepareForAcquisition(double collectionTime)	Sets the collection time for the next collection (implicitly a single image collection).
NexusTreeProvider	readout()	Returns the latest data collected.
void	setAdditionalPluginList(List<NXPluginBase> additionalPluginList)
void	setCollectionStrategy(NXCollectionStrategyPlugin collectionStrategy)
void	setName(String name)	Set or change the name of the object (as defined in XML).
void	setSnapperPluginList(List<NXPluginBase> pluginList)
void	setSnappingCollectionStrategy(NXCollectionStrategyPlugin collectionStrategy)
void	stop()	Stop the current move/operation.

Methods inherited from class gda.device.detector.PassthroughDetectorWrapper

addIObserver, asynchronousMoveTo, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, atScanLineStart, checkPositionValid, close, collectData, configure, createsOwnFiles, deleteIObserver, deleteIObservers, endCollection, getAttribute, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getInputNames, getLevel, getOutputFormat, getProtectionLevel, getStatus, isAt, isBusy, isConfigureAtStartup, isConfigured, moveTo, prepareForCollection, reconfigure, setAttribute, setCollectionTime, setExtraNames, setInputNames, setLevel, setOutputFormat, setProtectionLevel, toFormattedString, toString, waitWhileBusy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Detector

collectData, createsOwnFiles, endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getFileStructure, getStatus, prepareForCollection, setCollectionTime, waitWhileBusy

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.device.Scannable

asynchronousMoveTo, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, atScanLineStart, checkPositionValid, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, toFormattedString

Method Details

setSnappingCollectionStrategy

public void setSnappingCollectionStrategy(NXCollectionStrategyPlugin collectionStrategy)

setSnapperPluginList

public void setSnapperPluginList(List<NXPluginBase> pluginList)

getSnapperCollectionStrategy

public NXCollectionStrategyPlugin getSnapperCollectionStrategy()

getSnapperPluginList

public List<NXPluginBase> getSnapperPluginList()

getDelegate

public NXPluginDetector getDelegate()

Overrides:

getDelegate in class PassthroughDetectorWrapper

prepareForAcquisition

public void prepareForAcquisition(double collectionTime)
                           throws Exception

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:

collectionTime -

Throws:

Exception

getAcquireTime

public double getAcquireTime()
                      throws Exception

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:

Exception

getAcquirePeriod

public double getAcquirePeriod()
                        throws Exception

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:

Exception

acquire

public String[] acquire()
                 throws InterruptedException,
IllegalStateException,
Exception

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:

InterruptedException

IllegalStateException - if the detector was already acquiring

Exception

getPosition

public Object getPosition()
                   throws DeviceException

Description copied from interface: Scannable

Returns the current position of the Scannable. Called by ConcurentScan at the end of the point.

Specified by:

getPosition in interface Scannable

Overrides:

getPosition in class PassthroughDetectorWrapper

Returns:

Current position with an element for each input and extra field. null if their are no fields.

Throws:

DeviceException

setName

public void setName(String name)

Description copied from interface: Findable

Set or change the name of the object (as defined in XML).

Specified by:

setName in interface Findable

Overrides:

setName in class PassthroughDetectorWrapper

Parameters:

name - the object name

getName

public String getName()

Description copied from interface: Findable

Get the object name. Used by Castor to check if the object name has been set before calling the Findable.setName(String) method.

Specified by:

getName in interface Findable

Overrides:

getName in class PassthroughDetectorWrapper

Returns:

a String containing the object name.

getExtraNames

public String[] getExtraNames()

Description copied from interface: Scannable

Additional names for extra values that returned by getPosition().

Specified by:

getExtraNames in interface Scannable

Overrides:

getExtraNames in class PassthroughDetectorWrapper

Returns:

array of names of the extra elements if the array returned by getPosition is larger than the array required by moveTo

atScanStart

public void atScanStart()
                 throws DeviceException

Description copied from interface: Scannable

Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case)

Specified by:

atScanStart in interface Scannable

Overrides:

atScanStart in class PassthroughDetectorWrapper

Throws:

DeviceException

atScanEnd

public void atScanEnd()
               throws DeviceException

Description copied from interface: Scannable

Called for every Scannable at the end of a group of nested scans (or a single scan if that is the case).

Note that this is only called if the Scan finishes normally, or has been requested to finish early. This will not be called if the scan finishes due to an exception of any kind. See Scannable.atCommandFailure()

Specified by:

atScanEnd in interface Scannable

Overrides:

atScanEnd in class PassthroughDetectorWrapper

Throws:

DeviceException

atCommandFailure

public void atCommandFailure()
                      throws DeviceException

Description copied from interface: Scannable

Hook to be used by Scan and pos commands to inform the Scannable that an exception, such as a DeviceExcpetion, has occurred. However not called when the command is aborted using an InterruptionException. If a Scan is aborted then only Scannable.stop() will be called by the Scan or pos command.

Useful for telling Scannables which hold state during a scan for example, to reset themselves. Used for example by CoordinatedMotionScannables. This hook should be used not in the same way as the stop hook.

Specified by:

atCommandFailure in interface Scannable

Overrides:

atCommandFailure in class PassthroughDetectorWrapper

Throws:

DeviceException

stop

public void stop()
          throws DeviceException

Description copied from interface: Scannable

Stop the current move/operation.

Specified by:

stop in interface Scannable

Overrides:

stop in class PassthroughDetectorWrapper

Throws:

DeviceException

readout

public NexusTreeProvider 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

Specified by:

readout in interface NexusDetector

Overrides:

readout in class PassthroughDetectorWrapper

Returns:

the data collected

Throws:

DeviceException

getPositionCallable

public Callable<NexusTreeProvider> getPositionCallable()
                                                throws DeviceException

Specified by:

getPositionCallable in interface PositionCallableProvider<NexusTreeProvider>

Throws:

DeviceException

getPluginList

public List<NXPluginBase> getPluginList()

Specified by:

getPluginList in interface NXPluginDetector

getPluginMap

public Map<String,NXPluginBase> getPluginMap()

Specified by:

getPluginMap in interface NXPluginDetector

setAdditionalPluginList

public void setAdditionalPluginList(List<NXPluginBase> additionalPluginList)

Specified by:

setAdditionalPluginList in interface NXPluginDetector

getAdditionalPluginList

public List<NXPluginBase> getAdditionalPluginList()

Specified by:

getAdditionalPluginList in interface NXPluginDetector

setCollectionStrategy

public void setCollectionStrategy(NXCollectionStrategyPlugin collectionStrategy)

Specified by:

setCollectionStrategy in interface NXPluginDetector

getCollectionStrategy

public NXCollectionStrategyPlugin getCollectionStrategy()

Specified by:

getCollectionStrategy in interface NXPluginDetector

__str__

public org.python.core.PyString __str__()

__repr__

public org.python.core.PyString __repr__()