Package gda.device.detector

Class NXDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.NXDetector

All Implemented Interfaces:

Detector, NexusDetector, NXPluginDetector, Device, Scannable, PositionCallableProvider<NexusTreeProvider>, Configurable, Findable, gda.observable.IObservable, Serializable, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

AbstractWriteRegionsImmediatelyNXDetector, HardwareTriggeredNXDetector, MbsAnalyser, PixiumNXDetector, SpecsPhoibosAnalyser, SpecsPhoibosAnalyserSeparateIterations

public class NXDetector
extends DetectorBase
implements org.springframework.beans.factory.InitializingBean, NXPluginDetector

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected NexusTreeProvider	lastReadoutValue
protected static final String	UNSUPPORTED_PART_OF_SCANNABLE_INTERFACE
protected static final String	UNSUPPORTED_SET_FUNCTION

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

Constructor	Description
NXDetector()	Creates an ADDetector with name, collectionStrategy and probably additionalPluginList yet to configure.
NXDetector(String name, NXCollectionStrategyPlugin collectionStrategy, List<NXPluginBase> additionalPluginList)

Method Summary

Modifier and Type	Method	Description
NXPluginBase	__getattr__(String name)	Returns the NXPlugin with the given name (configuration methods will have prevented duplicate plugin names).
String	__str__()	When printed from Jython show the standard detector state followed by a representation of all the plugins.
void	afterPropertiesSet()
void	asynchronousMoveTo(Object collectionTime)	Default implementation is to set the collection time and to call the collectData method
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	atScanLineEnd()	Called for every Scannable at the end of every scan
void	atScanLineStart()	Called for every Scannable at the start of every scan
void	atScanStart()	Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case)
void	collectData()	Tells the detector to begin to collect a set of data, then returns immediately.
boolean	createsOwnFiles()	Returns a value which indicates whether the detector creates its own files.
final void	endCollection()	Default which should be overridden by subclasses.
List<NXPluginBase>	getAdditionalPluginList()
NXCollectionStrategyPlugin	getCollectionStrategy()
String[]	getExtraNames()	Additional names for extra values that returned by getPosition().
NexusTreeProvider	getFileStructure()	Returns the initial file structure for this detector including all of its plugins.
String[]	getInputNames()	gets a array of InputNames used by moveTo of this scannable.
String[]	getOutputFormat()	Returns an array of strings which are the format strings to use when pretty printing parts of the output
NXPluginBase	getPlugin(String name)	Return a plugin by its name (configuration methods will have prevented duplicate plugin names).
List<NXPluginBase>	getPluginList()	Return all plugins: collection-strategy and then additional plugins
Map<String,NXPluginBase>	getPluginMap()	Return map of all plugins: collection-strategy and then additional plugins
Object	getPosition()	Returns the current position of the Scannable.
Callable<NexusTreeProvider>	getPositionCallable()
int	getStatus()	Returns the current collecting state of the device.
boolean	isAddCollectTimeMs()
boolean	isBusy()	Check if the Scannable is moving/operating.
protected void	prepareCollectionStrategyAtScanStart(int numberImagesPerCollection, ScanInformation scanInfo)
void	prepareForCollection()	Default which should be overridden by subclasses.
NexusTreeProvider	readout()	Returns the latest data collected as well as general detector information
void	setAddCollectTimeMs(boolean addCollectTimeMs)
void	setAdditionalPluginList(List<NXPluginBase> additionalPluginList)	Set plugins in addition to the collection-strategy plugin.
void	setCollectionStrategy(NXCollectionStrategyPlugin collectionStrategy)
void	setExtraNames(String[] names)	Sets the array of names returned by getExtraNames of this scannable.
void	setInputNames(String[] names)	sets the array of names returned by getInputNames method of this scannable.
void	setOutputFormat(String[] names)	Sets the array of strings describing how best to format the positions from this scannable
void	stop()	Stop the current move/operation.
void	waitWhileBusy()	Returns when operation carried out by moveTo has completed

Methods inherited from class gda.device.detector.DetectorBase

checkPositionValid, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, setCollectionTime, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, externalToInternal, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setLevel, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, 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

configure, isConfigured, reconfigure, 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

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Detector

getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, setCollectionTime

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

atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, checkPositionValid, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setLevel, setScanMetadataAttribute, setScanMetadataAttributes, toFormattedString

Field Details

UNSUPPORTED_PART_OF_SCANNABLE_INTERFACE

protected static final String UNSUPPORTED_PART_OF_SCANNABLE_INTERFACE

See Also:

• Constant Field Values

UNSUPPORTED_SET_FUNCTION

protected static final String UNSUPPORTED_SET_FUNCTION

See Also:

• Constant Field Values

lastReadoutValue

protected NexusTreeProvider lastReadoutValue

Constructor Details

NXDetector

public NXDetector(String name,
 NXCollectionStrategyPlugin collectionStrategy,
 List<NXPluginBase> additionalPluginList)

NXDetector

public NXDetector()

Creates an ADDetector with name, collectionStrategy and probably additionalPluginList yet to configure. A metadataProvider could also be provided.

Method Details

isAddCollectTimeMs

public boolean isAddCollectTimeMs()

setAddCollectTimeMs

public void setAddCollectTimeMs(boolean addCollectTimeMs)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

setCollectionStrategy

public void setCollectionStrategy(NXCollectionStrategyPlugin collectionStrategy)

Specified by:

setCollectionStrategy in interface NXPluginDetector

setAdditionalPluginList

public void setAdditionalPluginList(List<NXPluginBase> additionalPluginList)

Set plugins in addition to the collection-strategy plugin.

Specified by:

setAdditionalPluginList in interface NXPluginDetector

Parameters:

additionalPluginList -

getCollectionStrategy

public NXCollectionStrategyPlugin getCollectionStrategy()

Specified by:

getCollectionStrategy in interface NXPluginDetector

getAdditionalPluginList

public List<NXPluginBase> getAdditionalPluginList()

Specified by:

getAdditionalPluginList in interface NXPluginDetector

getPluginList

public List<NXPluginBase> getPluginList()

Return all plugins: collection-strategy and then additional plugins

Specified by:

getPluginList in interface NXPluginDetector

getPluginMap

public Map<String,NXPluginBase> getPluginMap()

Return map of all plugins: collection-strategy and then additional plugins

Specified by:

getPluginMap in interface NXPluginDetector

getPlugin

public NXPluginBase getPlugin(String name)

Return a plugin by its name (configuration methods will have prevented duplicate plugin names).

Parameters:

name -

Returns:

plugin

__str__

public String __str__()

When printed from Jython show the standard detector state followed by a representation of all the plugins.

Overrides:

__str__ in class ScannableBase

Returns:

the result of the toString method

__getattr__

public NXPluginBase __getattr__(String name)

Returns the NXPlugin with the given name (configuration methods will have prevented duplicate plugin names).

Parameters:

name -

setInputNames

public void setInputNames(String[] names)

Description copied from interface: Scannable

sets the array of names returned by getInputNames method of this scannable.

Specified by:

setInputNames in interface Scannable

Overrides:

setInputNames in class ScannableBase

Parameters:

names -

setExtraNames

public void setExtraNames(String[] names)

Description copied from interface: Scannable

Sets the array of names returned by getExtraNames of this scannable.

Specified by:

setExtraNames in interface Scannable

Overrides:

setExtraNames in class ScannableBase

Parameters:

names -

setOutputFormat

public void setOutputFormat(String[] names)

Description copied from interface: Scannable

Sets the array of strings describing how best to format the positions from this scannable

Specified by:

setOutputFormat in interface Scannable

Overrides:

setOutputFormat in class ScannableBase

Parameters:

names -

asynchronousMoveTo

public void asynchronousMoveTo(Object collectionTime)
                        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:

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

Throws:

DeviceException

See Also:

• Scannable.asynchronousMoveTo(java.lang.Object)

isBusy

public boolean isBusy()

Description copied from class: DetectorBase

Check if the Scannable is moving/operating. default implementation is to call the getStatus method

Specified by:

isBusy in interface Scannable

Overrides:

isBusy in class DetectorBase

Returns:

true - if operation carried out by moveTo has not completed yet

See Also:

• Scannable.isBusy()

getPosition

public Object getPosition()
                   throws DeviceException

Description copied from class: DetectorBase

Returns the current position of the Scannable. Called by ConcurentScan at the end of the point. Reads an internal (hardware) position from rawGetPosition, converts this to an external (user) position and returns it. Also, if createsOwnFiles attempts to register the file with all FileRegistrars (primarily for data archiving). Note that this method will be called if the detector is triggered from a 'pos' command but not if the detector is triggered by the scan command (which ignores the detector's scannable interface).

Specified by:

getPosition in interface Scannable

Overrides:

getPosition in class DetectorBase

Returns:

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

Throws:

DeviceException

See Also:

• Scannable.getPosition()

prepareForCollection

public void prepareForCollection()
                          throws DeviceException

Description copied from class: DetectorBase

Default which should be overridden by subclasses.

Specified by:

prepareForCollection in interface Detector

Overrides:

prepareForCollection in class DetectorBase

Throws:

DeviceException

See Also:

• Detector.prepareForCollection()

endCollection

public final void endCollection()
                         throws DeviceException

Description copied from class: DetectorBase

Default which should be overridden by subclasses.

Specified by:

endCollection in interface Detector

Overrides:

endCollection in class DetectorBase

Throws:

DeviceException

See Also:

• Detector.endCollection()

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

getInputNames

public String[] getInputNames()

Description copied from interface: Scannable

gets a array of InputNames used by moveTo of this scannable.

Specified by:

getInputNames in interface Scannable

Overrides:

getInputNames in class ScannableBase

Returns:

array of the names of the elements of the object returned by getPosition

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 ScannableBase

Returns:

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

getOutputFormat

public String[] getOutputFormat()

Description copied from interface: Scannable

Returns an array of strings which are the format strings to use when pretty printing parts of the output

Specified by:

getOutputFormat in interface Scannable

Overrides:

getOutputFormat in class ScannableBase

Returns:

string array

atScanStart

public void atScanStart()
                 throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanStart in interface Scannable

Overrides:

atScanStart in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanStart()

prepareCollectionStrategyAtScanStart

protected void prepareCollectionStrategyAtScanStart(int numberImagesPerCollection,
 ScanInformation scanInfo)
                                             throws Exception,
DeviceException

Throws:

Exception

DeviceException

atScanLineStart

public void atScanLineStart()
                     throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the start of every scan Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanLineStart in interface Scannable

Overrides:

atScanLineStart in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanLineStart()

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

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

waitWhileBusy

public void waitWhileBusy()
                   throws InterruptedException,
DeviceException

Description copied from class: ScannableBase

Returns when operation carried out by moveTo has completed If this is to be overriden, isBusy must also be valid. Although the pos and scan command currently use this method to determine if the Scannable is busy, this must not be relied upon.

Specified by:

waitWhileBusy in interface Detector

Specified by:

waitWhileBusy in interface Scannable

Overrides:

waitWhileBusy in class ScannableBase

Throws:

InterruptedException

DeviceException

readout

public NexusTreeProvider readout()
                          throws DeviceException

Description copied from interface: NexusDetector

Returns the latest data collected as well as general detector information

Specified by:

readout in interface Detector

Specified by:

readout in interface NexusDetector

Returns:

the data collected

Throws:

DeviceException

getFileStructure

public NexusTreeProvider getFileStructure()
                                   throws DeviceException

Returns the initial file structure for this detector including all of its plugins. This is used if property NexusScanDataWriter#PROPERTY_NAME_CREATE_FILE_AT_SCAN_START is true to allow this detector to still be compatible with data writing.

Specified by:

getFileStructure in interface Detector

Returns:

the nexus file structure

Throws:

DeviceException

getPositionCallable

public Callable<NexusTreeProvider> getPositionCallable()
                                                throws DeviceException

Specified by:

getPositionCallable in interface PositionCallableProvider<NexusTreeProvider>

Throws:

DeviceException

atScanLineEnd

public void atScanLineEnd()
                   throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the end of every scan Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanLineEnd in interface Scannable

Overrides:

atScanLineEnd in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanLineEnd()

atScanEnd

public void atScanEnd()
               throws DeviceException

Description copied from class: ScannableBase

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() Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanEnd in interface Scannable

Overrides:

atScanEnd in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanEnd()

stop

public void stop()
          throws DeviceException

Description copied from class: ScannableBase

Stop the current move/operation. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

stop in interface Scannable

Overrides:

stop in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.stop()

atCommandFailure

public void atCommandFailure()
                      throws DeviceException

Description copied from class: ScannableBase

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. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atCommandFailure in interface Scannable

Overrides:

atCommandFailure in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atCommandFailure()