Package gda.device.detector.xmap

Class HardwareTriggeredNexusXmapImpl

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.hardwaretriggerable.HardwareTriggerableDetectorBase

gda.device.detector.xmap.HardwareTriggeredNexusXmapImpl

All Implemented Interfaces:

SimulatedTriggerObserver, Detector, HardwareTriggerableDetector, HardwareTriggeredDetector, NexusDetector, HardwareTriggeredNexusXmap, Device, Scannable, PositionCallableProvider<NexusTreeProvider>, XmapDetector, Configurable, Findable, gda.observable.IObservable, gda.observable.IObserver, Serializable

public class HardwareTriggeredNexusXmapImpl
extends HardwareTriggerableDetectorBase
implements HardwareTriggeredNexusXmap

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

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	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	clear()	Clear all MCA's
void	clearAndStart()	Clears all MCAs and starts data collection
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.
double	getAcquisitionTime()	Returns the time for which the detector is set to acquire data
List<String>	getChannelLabels()	Lightly to be only implemented on the server.
EDXDMappingController	getController()
int[][]	getData()	Returns the data array of all the MCAs
int[]	getData(int mcaNumber)	Returns the data array of the specified MCA
String	getDescription()
String	getDetectorID()
String	getDetectorType()
String[]	getExtraNames()	Additional names for extra values that returned by getPosition().
String	getHDFFileName()
String[]	getInputNames()	gets a array of InputNames used by moveTo of this scannable.
int	getNumberOfBins()	Returns current number of Bins/channels for spectrum acquisition in each MCA
int	getNumberOfMca()	Returns the number of MCAs currently connected to the XMap detector
int	getNumberOfROIs()	Returns the total number of ROIs currently set
String[]	getOutputFormat()	Returns an array of strings which are the format strings to use when pretty printing parts of the output
Callable<NexusTreeProvider>	getPositionCallable()
double	getReadRate()	Returns the current rate at which data is read in the Epics interface
double	getRealTime()	Returns the elapsed real time after a read status operation
double[]	getROICounts(int iRoi)	Gets the count for each mca for a given ROI.
double[]	getROIsSum()	Returns the sum of the corresponding ROIs of all the MCA.
int	getScanNumberOfPoints()
int	getStatus()	Returns the status of the detector
double	getStatusRate()	Returns the current set rate at which status is read in the Epics interface
NexusXmap	getXmap()
boolean	integratesBetweenPoints()	Detectors that sample some value at the time of a trigger should return False.
boolean	isBusy()	Check if the Scannable is moving/operating.
boolean	isInBufferMode()
boolean	isIntegrateBetweenPoints()
boolean	isSlave()
boolean	isStillWriting(String fileName)
void	prepareForCollection()	Default which should be overridden by subclasses.
NexusTreeProvider	readout()	Returns the latest data collected.
double	readoutScalerData()	Reads out the scaler data of the roi counts, corrects for deadtime and returns the sum.
void	setAcquisitionTime(double time)	Tells the detector for how many seconds to acquire data
void	setController(EDXDMappingController controller)
void	setIntegrateBetweenPoints(boolean integrateBetweenPoints)
void	setNthROI(double[][] rois, int roiIndex)	Sets a ROI for all of the MCAs
void	setNumberOfBins(int numberOfBins)	Sets maximum numbers of bins/channels to use for spectrum acquisition in each MCA
void	setReadRate(double readRate)	Sets the rate at which data is read in the Epics interface
void	setROIs(double[][] rois)	Sets the ROIs of all the MCA.
void	setScanNumberOfPoints(int scanNumberOfPoints)
void	setSlave(boolean slave)
void	setStatusRate(double statusRate)	Sets the rate at which status is read in the Epics interface
void	setXmap(NexusXmap xmap)
void	start()	Start data acquisition in all MCA's
void	stop()	Stop the current move/operation.
void	update(Object source, Object arg)
void	waitForCurrentScanFile()
void	waitForFile(String fileName)

Methods inherited from class gda.device.detector.hardwaretriggerable.HardwareTriggerableDetectorBase

getHardwareTriggerProvider, getNumberImagesToCollect, isHardwareTriggering, setHardwareTriggering, setHardwareTriggerProvider, setNumberImagesToCollect

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, getCollectionTime, getDataDimensions, getPosition, setCollectionTime, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, externalToInternal, getLevel, 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

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, getCollectionTime, getDataDimensions, getFileStructure, setCollectionTime, waitWhileBusy

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.device.detector.hardwaretriggerable.HardwareTriggerableDetector

isHardwareTriggering, setHardwareTriggering

Methods inherited from interface gda.device.detector.hardwaretriggerable.HardwareTriggeredDetector

getHardwareTriggerProvider, setNumberImagesToCollect

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.device.Scannable

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

Constructor Details

HardwareTriggeredNexusXmapImpl

public HardwareTriggeredNexusXmapImpl()

Method Details

getXmap

public NexusXmap getXmap()

Specified by:

getXmap in interface HardwareTriggeredNexusXmap

setXmap

public void setXmap(NexusXmap xmap)

getController

public EDXDMappingController getController()

setController

public void setController(EDXDMappingController controller)

getScanNumberOfPoints

public int getScanNumberOfPoints()

setScanNumberOfPoints

public void setScanNumberOfPoints(int scanNumberOfPoints)

configure

public void configure()

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

clear

public void clear()
           throws DeviceException

Description copied from interface: XmapDetector

Clear all MCA's

Specified by:

clear in interface XmapDetector

Throws:

DeviceException

clearAndStart

public void clearAndStart()
                   throws DeviceException

Description copied from interface: XmapDetector

Clears all MCAs and starts data collection

Specified by:

clearAndStart in interface XmapDetector

Throws:

DeviceException

getAcquisitionTime

public double getAcquisitionTime()
                          throws DeviceException

Description copied from interface: XmapDetector

Returns the time for which the detector is set to acquire data

Specified by:

getAcquisitionTime in interface XmapDetector

Returns:

time

Throws:

DeviceException

getChannelLabels

public List<String> getChannelLabels()

Description copied from interface: XmapDetector

Lightly to be only implemented on the server.

Specified by:

getChannelLabels in interface XmapDetector

Returns:

the labels for the channels defined by the user.

getData

public int[] getData(int mcaNumber)
              throws DeviceException

Description copied from interface: XmapDetector

Returns the data array of the specified MCA

Specified by:

getData in interface XmapDetector

Parameters:

mcaNumber -

Returns:

data array

Throws:

DeviceException

getData

public int[][] getData()
                throws DeviceException

Description copied from interface: XmapDetector

Returns the data array of all the MCAs

Specified by:

getData in interface XmapDetector

Returns:

array of data arrays

Throws:

DeviceException

getNumberOfBins

public int getNumberOfBins()
                    throws DeviceException

Description copied from interface: XmapDetector

Returns current number of Bins/channels for spectrum acquisition in each MCA

Specified by:

getNumberOfBins in interface XmapDetector

Returns:

numberOfBins

Throws:

DeviceException

getNumberOfMca

public int getNumberOfMca()
                   throws DeviceException

Description copied from interface: XmapDetector

Returns the number of MCAs currently connected to the XMap detector

Specified by:

getNumberOfMca in interface XmapDetector

Returns:

number of MCA

Throws:

DeviceException

getNumberOfROIs

public int getNumberOfROIs()
                    throws DeviceException

Description copied from interface: XmapDetector

Returns the total number of ROIs currently set

Specified by:

getNumberOfROIs in interface XmapDetector

Returns:

number of ROIs

Throws:

DeviceException

getROICounts

public double[] getROICounts(int iRoi)
                      throws DeviceException

Description copied from interface: XmapDetector

Gets the count for each mca for a given ROI.

Specified by:

getROICounts in interface XmapDetector

Parameters:

iRoi -

Returns:

double[] of counts per mca for this roi

Throws:

DeviceException

getROIsSum

public double[] getROIsSum()
                    throws DeviceException

Description copied from interface: XmapDetector

Returns the sum of the corresponding ROIs of all the MCA. For e.g if the MCAs have three ROIs each say R0, R1 and R2. This method sums up the R0 of all the MCA R1 of all the MCAs and so on

Specified by:

getROIsSum in interface XmapDetector

Returns:

ROI sum array

Throws:

DeviceException

getReadRate

public double getReadRate()
                   throws DeviceException

Description copied from interface: XmapDetector

Returns the current rate at which data is read in the Epics interface

Specified by:

getReadRate in interface XmapDetector

Returns:

readRate

Throws:

DeviceException

getRealTime

public double getRealTime()
                   throws DeviceException

Description copied from interface: XmapDetector

Returns the elapsed real time after a read status operation

Specified by:

getRealTime in interface XmapDetector

Returns:

real time

Throws:

DeviceException

getStatus

public int getStatus()
              throws DeviceException

Description copied from interface: XmapDetector

Returns the status of the detector

Specified by:

getStatus in interface Detector

Specified by:

getStatus in interface XmapDetector

Returns:

Detector.IDLE/BUSY

Throws:

DeviceException

getStatusRate

public double getStatusRate()
                     throws DeviceException

Description copied from interface: XmapDetector

Returns the current set rate at which status is read in the Epics interface

Specified by:

getStatusRate in interface XmapDetector

Returns:

status rate

Throws:

DeviceException

readoutScalerData

public double readoutScalerData()
                         throws DeviceException

Description copied from interface: XmapDetector

Reads out the scaler data of the roi counts, corrects for deadtime and returns the sum.

Specified by:

readoutScalerData in interface XmapDetector

Returns:

The FF data

Throws:

DeviceException

setAcquisitionTime

public void setAcquisitionTime(double time)
                        throws DeviceException

Description copied from interface: XmapDetector

Tells the detector for how many seconds to acquire data

Specified by:

setAcquisitionTime in interface XmapDetector

Parameters:

time -

Throws:

DeviceException

setNthROI

public void setNthROI(double[][] rois,
 int roiIndex)
               throws DeviceException

Description copied from interface: XmapDetector

Sets a ROI for all of the MCAs

Specified by:

setNthROI in interface XmapDetector

Parameters:

rois - This array length should be same as the number of MCAs

roiIndex -

Throws:

DeviceException

setNumberOfBins

public void setNumberOfBins(int numberOfBins)
                     throws DeviceException

Description copied from interface: XmapDetector

Sets maximum numbers of bins/channels to use for spectrum acquisition in each MCA

Specified by:

setNumberOfBins in interface XmapDetector

Parameters:

numberOfBins -

Throws:

DeviceException

setROIs

public void setROIs(double[][] rois)
             throws DeviceException

Description copied from interface: XmapDetector

Sets the ROIs of all the MCA. Use this method only if you want to set all the MCA with the same ROIs.To set different ROI for each of the MCA use setNthROI method.

Specified by:

setROIs in interface XmapDetector

Parameters:

rois - array. Each roi should have a low and high value.

Throws:

DeviceException

setReadRate

public void setReadRate(double readRate)
                 throws DeviceException

Description copied from interface: XmapDetector

Sets the rate at which data is read in the Epics interface

Specified by:

setReadRate in interface XmapDetector

Parameters:

readRate -

Throws:

DeviceException

setStatusRate

public void setStatusRate(double statusRate)
                   throws DeviceException

Description copied from interface: XmapDetector

Sets the rate at which status is read in the Epics interface

Specified by:

setStatusRate in interface XmapDetector

Parameters:

statusRate -

Throws:

DeviceException

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

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

start

public void start()
           throws DeviceException

Description copied from interface: XmapDetector

Start data acquisition in all MCA's

Specified by:

start in interface XmapDetector

Throws:

DeviceException

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

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

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

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

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

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

Specified by:

stop in interface XmapDetector

Overrides:

stop in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.stop()

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver

getPositionCallable

public Callable<NexusTreeProvider> getPositionCallable()
                                                throws DeviceException

Specified by:

getPositionCallable in interface PositionCallableProvider<NexusTreeProvider>

Throws:

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

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

waitForCurrentScanFile

public void waitForCurrentScanFile()
                            throws DeviceException,
InterruptedException

Specified by:

waitForCurrentScanFile in interface HardwareTriggeredNexusXmap

Throws:

DeviceException

InterruptedException

waitForFile

public void waitForFile(String fileName)
                 throws DeviceException,
InterruptedException

Specified by:

waitForFile in interface HardwareTriggeredNexusXmap

Throws:

DeviceException

InterruptedException

isStillWriting

public boolean isStillWriting(String fileName)
                       throws DeviceException

Throws:

DeviceException

integratesBetweenPoints

public boolean integratesBetweenPoints()

Description copied from interface: HardwareTriggeredDetector

Detectors that sample some value at the time of a trigger should return False. Detectors such as counter timers should return True. If true ,TrajectoryScanLine will generate a trigger half a point before the motor reaches a demanded point such that the resulting bin of data is centred on the demand position. Area detectors that will be triggered by the first pulse should also return true.

Specified by:

integratesBetweenPoints in interface HardwareTriggeredDetector

Returns:

true for detectors that integrates b

getHDFFileName

public String getHDFFileName()
                      throws DeviceException

Specified by:

getHDFFileName in interface HardwareTriggeredNexusXmap

Throws:

DeviceException

isInBufferMode

public boolean isInBufferMode()
                       throws Exception

Specified by:

isInBufferMode in interface HardwareTriggeredNexusXmap

Throws:

Exception

isSlave

public boolean isSlave()

setSlave

public void setSlave(boolean slave)

isIntegrateBetweenPoints

public boolean isIntegrateBetweenPoints()

setIntegrateBetweenPoints

public void setIntegrateBetweenPoints(boolean integrateBetweenPoints)

isBusy

public boolean isBusy()
               throws DeviceException

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

Throws:

DeviceException

See Also:

• Scannable.isBusy()