Package uk.ac.gda.server.ncd.detectorsystem

Class NcdDetectorSystem

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

uk.ac.gda.server.ncd.detectorsystem.NcdDetectorSystem

All Implemented Interfaces:

Detector, NexusDetector, Device, ProcessingRequestProvider, Scannable, PositionCallableProvider<NexusTreeProvider>, Configurable, Findable, gda.observable.IObservable, Serializable, NcdDetector

@ServiceInterface(NcdDetector.class)
public class NcdDetectorSystem
extends DetectorBase
implements NcdDetector, PositionCallableProvider<NexusTreeProvider>, ProcessingRequestProvider

Detector system of non crystalline diffraction to allow scans to take time series at each point.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CALIBRATION_DETECTOR
static final String[]	detectorTypes	array of valid/known detector types
static final String	FLUORESCENCE_DETECTOR
static final String	OTHER_DETECTOR
static final String[]	physicalDetectors
static final String	REDUCTION_DETECTOR
static final String	SAXS_DETECTOR
protected Collection<INcdSubDetector>	subDetectors	Map of names to configured ncd sub detectors
static final String	SYSTEM_DETECTOR
static final String	TIMES_DETECTOR
static final String	WAXS_DETECTOR

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

Method Summary

Modifier and Type	Method	Description
void	addDetector(INcdSubDetector det)
void	addIObserver(gda.observable.IObserver observer)
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)
void	clear()
void	close()	Close and unconfigure the device.
void	collectData()	Tells the detector to begin to collect a set of data, then returns immediately.
void	configCalibLabels()
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.
void	deleteIObserver(gda.observable.IObserver observer)
Object	getAttribute(String attributeName)	Get the value of the specified attribute
CalibrationLabels	getCalibrationLabels()
double	getCollectionTime()	Returns the time, in seconds, the detector collects for during the next call to collectData()
String	getDescription()
String	getDetectorID()
Collection<INcdSubDetector>	getDetectors()
String	getDetectorType()
String[]	getExtraNames()	Additional names for extra values that returned by getPosition().
String[]	getInputNames()	gets a array of InputNames used by moveTo of this scannable.
int	getNumberOfFrames()
Callable<NexusTreeProvider>	getPositionCallable()
Map<String,Collection<Object>>	getProcessingRequest()
int	getStatus()	Returns the current collecting state of the device.
String	getTfgName()
Timer	getTimer()
void	notifyRateCollection(Collection<Object> rateCollection)
NexusTreeProvider	readout()	Returns the latest data collected as well as general detector information
void	removeDetector(INcdSubDetector det)
void	setAttribute(String attributeName, Object value)	Set any attribute the implementing classes may provide
void	setCollectionTime(double collectionTime)	Sets the collection time, in seconds, to be used during the next call of collectData.
void	setDetectors(Collection<INcdSubDetector> dets)
void	setProcessingRequest(Map<String,Collection<Object>> request)
void	setScanEndActions(Collection<NcdAction> scanEndActions)
void	setScanStartActions(Collection<NcdAction> scanStartActions)
void	setTimer(Timer timer)
void	start()
void	stop()	Stop the current move/operation.

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, getDataDimensions, getPosition, isBusy, prepareForCollection, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, atScanLineStart, externalToInternal, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

deleteIObservers, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, 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, getFileStructure, prepareForCollection, waitWhileBusy

Methods inherited from interface gda.device.Device

getProtectionLevel, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

deleteIObservers

Methods inherited from interface gda.device.Scannable

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

Field Details

SAXS_DETECTOR

public static final String SAXS_DETECTOR

See Also:

• Constant Field Values

WAXS_DETECTOR

public static final String WAXS_DETECTOR

See Also:

• Constant Field Values

CALIBRATION_DETECTOR

public static final String CALIBRATION_DETECTOR

See Also:

• Constant Field Values

FLUORESCENCE_DETECTOR

public static final String FLUORESCENCE_DETECTOR

See Also:

• Constant Field Values

OTHER_DETECTOR

public static final String OTHER_DETECTOR

See Also:

• Constant Field Values

TIMES_DETECTOR

public static final String TIMES_DETECTOR

See Also:

• Constant Field Values

SYSTEM_DETECTOR

public static final String SYSTEM_DETECTOR

See Also:

• Constant Field Values

REDUCTION_DETECTOR

public static final String REDUCTION_DETECTOR

See Also:

• Constant Field Values

detectorTypes

public static final String[] detectorTypes

array of valid/known detector types

physicalDetectors

public static final String[] physicalDetectors

subDetectors

protected Collection<INcdSubDetector> subDetectors

Map of names to configured ncd sub detectors

Constructor Details

NcdDetectorSystem

public NcdDetectorSystem()

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

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

getPositionCallable

public Callable<NexusTreeProvider> getPositionCallable()
                                                throws DeviceException

Specified by:

getPositionCallable in interface PositionCallableProvider<NexusTreeProvider>

Throws:

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

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

clear

public void clear()
           throws DeviceException

Specified by:

clear in interface NcdDetector

Throws:

DeviceException

start

public void start()
           throws DeviceException

Specified by:

start in interface NcdDetector

Throws:

DeviceException

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

getNumberOfFrames

public int getNumberOfFrames()
                      throws DeviceException

Specified by:

getNumberOfFrames in interface NcdDetector

Returns:

number of collected frames

Throws:

DeviceException

getTfgName

public String getTfgName()
                  throws DeviceException

Specified by:

getTfgName in interface NcdDetector

Throws:

DeviceException

close

public void close()
           throws DeviceException

Description copied from interface: Device

Close and unconfigure the device.

Specified by:

close in interface Device

Overrides:

close in class DeviceBase

Throws:

DeviceException

addIObserver

public void addIObserver(gda.observable.IObserver observer)

Specified by:

addIObserver in interface gda.observable.IObservable

Overrides:

addIObserver in class DeviceBase

deleteIObserver

public void deleteIObserver(gda.observable.IObserver observer)

Specified by:

deleteIObserver in interface gda.observable.IObservable

Overrides:

deleteIObserver in class DeviceBase

getDescription

public String getDescription()
                      throws DeviceException

Specified by:

getDescription in interface Detector

Overrides:

getDescription in class DetectorBase

Returns:

A description of the detector.

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

getCollectionTime

public double getCollectionTime()

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

setCollectionTime

public void setCollectionTime(double collectionTime)

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

addDetector

public void addDetector(INcdSubDetector det)
                 throws DeviceException

Specified by:

addDetector in interface NcdDetector

Throws:

DeviceException

removeDetector

public void removeDetector(INcdSubDetector det)

Specified by:

removeDetector in interface NcdDetector

getTimer

public Timer getTimer()

setTimer

public void setTimer(Timer timer)

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

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

getDetectors

public Collection<INcdSubDetector> getDetectors()

setDetectors

public void setDetectors(Collection<INcdSubDetector> dets)

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

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

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

getAttribute

public Object getAttribute(String attributeName)
                    throws DeviceException

Description copied from interface: Device

Get the value of the specified attribute

Specified by:

getAttribute in interface Device

Overrides:

getAttribute in class DeviceBase

Parameters:

attributeName - is the name of the attribute

Returns:

the value of the attribute as an Object type

Throws:

DeviceException - if an attribute cannot be retrieved

setAttribute

public void setAttribute(String attributeName,
 Object value)
                  throws DeviceException

Description copied from interface: Device

Set any attribute the implementing classes may provide

Specified by:

setAttribute in interface Device

Overrides:

setAttribute in class DeviceBase

Parameters:

attributeName - is the name of the attribute

value - is the value of the attribute

Throws:

DeviceException - if an attribute cannot be set

getCalibrationLabels

public CalibrationLabels getCalibrationLabels()

configCalibLabels

public void configCalibLabels()

setScanStartActions

public void setScanStartActions(Collection<NcdAction> scanStartActions)

setScanEndActions

public void setScanEndActions(Collection<NcdAction> scanEndActions)

notifyRateCollection

public void notifyRateCollection(Collection<Object> rateCollection)

setProcessingRequest

public void setProcessingRequest(Map<String,Collection<Object>> request)

getProcessingRequest

public Map<String,Collection<Object>> getProcessingRequest()

Specified by:

getProcessingRequest in interface ProcessingRequestProvider