Package gda.device.detector.nxdetector

Class BufferedNXDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.nxdetector.BufferedNXDetector

All Implemented Interfaces:

Detector, BufferedDetector, NexusDetector, Device, Scannable, Configurable, Findable, gda.observable.IObservable, Serializable

public class BufferedNXDetector
extends DetectorBase
implements BufferedDetector, NexusDetector

A BufferedDetector to collect data from an NXDetector (area detector) in a ContinuousScan. Most of the functions are delegated to the underlying NXDetector; the values returned during a continuous scan (by readFrames(int, int)) are determined by the 'additional plugin' chain on the detector and are the same as returned during a step scan. (This detector class also works in a step scan.)

See Also:

• Serialized Form

Field Summary

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
BufferedNXDetector()

Method Summary

Modifier and Type	Method	Description
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	clearMemory()	Clears the detector memory
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.
String	getBaseRoiPvName()
String	getBaseStatPvName()
NXCollectionStrategyPlugin	getCollectionStrategy()
double	getCollectionTime()	Returns the time, in seconds, the detector collects for during the next call to collectData()
ContinuousParameters	getContinuousParameters()
String	getCurrentPointPointPvName()
NXDetector	getDetector()
String[]	getExtraNames()	Additional names for extra values that returned by getPosition().
int	getNumberFrames()
String[]	getOutputFormat()	Returns an array of strings which are the format strings to use when pretty printing parts of the output
int	getStatus()	Returns the current collecting state of the device.
boolean	isContinuousMode()
int	maximumReadFrames()	As certain detectors may cause memory issues if too many frames are attempted to be read in one go, this is the maximum for this detector based on its current configuration (i.e.
void	prepareForCollection()	Default which should be overridden by subclasses.
Object[]	readAllFrames()	An array of the data from the detector.
Object[]	readFrames(int startFrame, int finalFrame)	An array of the data from the detector.
NexusTreeProvider	readout()	Returns the latest data collected.
void	setBaseRoiPvName(String baseRoiPvName)	Set base PV name of ROI plugin to use (e.g.
void	setBaseStatPvName(String baseStatPvName)	Set base PV name of Stat plugin to use.
void	setCollectionStrategy(NXCollectionStrategyPlugin collectionStrategy)	Set the collection strategy to be used to prepare the detector for a ContinuousScan.
void	setCollectionTime(double collectionTime)	Sets the collection time, in seconds, to be used during the next call of collectData.
void	setContinuousMode(boolean on)	When in slave mode the detector will be triggered by an external signal to collect each frame of data.
void	setContinuousParameters(ContinuousParameters parameters)	Sets the parameters which define the continuous movement to use
void	setCurrentPointPointPvName(String currentPointPointPvName)	Set this to manually set the PV to use to get the current number of points in the time series array.
void	setDetector(NXDetector detector)
void	setMaximumReadFrames(int numFrames)
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

asynchronousMoveTo, checkPositionValid, endCollection, getDataDimensions, getDescription, getDetectorID, getDetectorType, getPosition, isBusy, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, externalToInternal, getInputNames, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, 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

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

isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Detector

endCollection, getDataDimensions, getDescription, getDetectorID, getDetectorType, getFileStructure

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

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

Constructor Details

BufferedNXDetector

public BufferedNXDetector()

Method Details

configure

public void configure()
               throws FactoryException

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

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

setContinuousParameters

public void setContinuousParameters(ContinuousParameters parameters)
                             throws DeviceException

Description copied from interface: BufferedDetector

Sets the parameters which define the continuous movement to use

Specified by:

setContinuousParameters in interface BufferedDetector

Parameters:

parameters -

Throws:

DeviceException

getContinuousParameters

public ContinuousParameters getContinuousParameters()
                                             throws DeviceException

Specified by:

getContinuousParameters in interface BufferedDetector

Returns:

ContinuousParameters

Throws:

DeviceException

setContinuousMode

public void setContinuousMode(boolean on)
                       throws DeviceException

Description copied from interface: BufferedDetector

When in slave mode the detector will be triggered by an external signal to collect each frame of data.

Specified by:

setContinuousMode in interface BufferedDetector

Parameters:

on -

Throws:

DeviceException

isContinuousMode

public boolean isContinuousMode()
                         throws DeviceException

Specified by:

isContinuousMode in interface BufferedDetector

Returns:

true if the detector is ready to accept trigger pulses

Throws:

DeviceException

readFrames

public Object[] readFrames(int startFrame,
 int finalFrame)
                    throws DeviceException

Description copied from interface: BufferedDetector

An array of the data from the detector. Each element is one frame of data. The first frame is 0.

Specified by:

readFrames in interface BufferedDetector

Parameters:

startFrame -

finalFrame -

Returns:

Object

Throws:

DeviceException

readAllFrames

public Object[] readAllFrames()
                       throws DeviceException

Description copied from interface: BufferedDetector

An array of the data from the detector. Each element is one frame of data.

Specified by:

readAllFrames in interface BufferedDetector

Returns:

Object

Throws:

DeviceException

getNumberFrames

public int getNumberFrames()
                    throws DeviceException

Specified by:

getNumberFrames in interface BufferedDetector

Returns:

number of frames of data in memory which have been collected

Throws:

DeviceException

clearMemory

public void clearMemory()
                 throws DeviceException

Description copied from interface: BufferedDetector

Clears the detector memory

Specified by:

clearMemory in interface BufferedDetector

Throws:

DeviceException

maximumReadFrames

public int maximumReadFrames()
                      throws DeviceException

Description copied from interface: BufferedDetector

As certain detectors may cause memory issues if too many frames are attempted to be read in one go, this is the maximum for this detector based on its current configuration (i.e. after setContinuousMode(True) has been called.

The lowest value returned from any of the detectors in a continuous scan will be the limit set.

If there is no limit then this method should return Integer.MAX_VALUE.

Specified by:

maximumReadFrames in interface BufferedDetector

Returns:

int - the maximum number of frames which should be read at any one time from this detector

Throws:

DeviceException

setMaximumReadFrames

public void setMaximumReadFrames(int numFrames)

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

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()

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

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

Returns:

the data collected

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

getCollectionTime

public double getCollectionTime()
                         throws DeviceException

Description copied from interface: Detector

Returns the time, in seconds, the detector collects for during the next call to collectData()

Specified by:

getCollectionTime in interface Detector

Overrides:

getCollectionTime in class DetectorBase

Returns:

double

Throws:

DeviceException

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()

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()

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()

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()

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()

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()

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

getDetector

public NXDetector getDetector()

setDetector

public void setDetector(NXDetector detector)

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

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

getBaseStatPvName

public String getBaseStatPvName()

setBaseStatPvName

public void setBaseStatPvName(String baseStatPvName)

Set base PV name of Stat plugin to use. (e.g. "ws146-AD-SIM-01:STAT:")

getBaseRoiPvName

public String getBaseRoiPvName()

setBaseRoiPvName

public void setBaseRoiPvName(String baseRoiPvName)

Set base PV name of ROI plugin to use (e.g. "ws146-AD-SIM-01:ROI:")

getCollectionStrategy

public NXCollectionStrategyPlugin getCollectionStrategy()

setCollectionStrategy

public void setCollectionStrategy(NXCollectionStrategyPlugin collectionStrategy)

Set the collection strategy to be used to prepare the detector for a ContinuousScan.

Parameters:

collectionStrategy -

getCurrentPointPointPvName

public String getCurrentPointPointPvName()

setCurrentPointPointPvName

public void setCurrentPointPointPvName(String currentPointPointPvName)

Set this to manually set the PV to use to get the current number of points in the time series array. If not set (or set to empty string), the PV provided by NXDetector ADRoiStatsPair plugin will be used. (i.e. TSCurrentPoint, or TS:TSCurrentPoint for RHEL7)

Parameters:

currentPointPointPvName -