Package gda.device.detector.analyser

Class EpicsMCASimple

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.analyser.AnalyserBase

gda.device.detector.analyser.EpicsMCASimple

All Implemented Interfaces:

Analyser, Detector, IEpicsMCA, IEpicsMCASimple, Device, Scannable, Configurable, Findable, gda.observable.IObservable, Serializable

public class EpicsMCASimple
extends AnalyserBase
implements IEpicsMCASimple

Class to communicate with an epics MCA record. The MCA record controls and acquires data from a multichannel analyser (MCA). It connects to the Epics channels via an EpicsDevice whose name is set by the method setEpicsDeviceName. Observers are notified of change of status - either MCAStatus.READY or MCAStatus.BUSY getStatus - returns either Detector.IDLE or Detector.BUSY eraseStartAcquisition - starts acquisition

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

Method Summary

Modifier and Type	Method	Description
void	_fireReadingDone()	method used for testing only
void	_setRegionsOfInterestCount(int index, Double val)	method used for testing only
void	_setRegionsOfInterestNetCount(int index, Double val)	method used for testing only
void	addRegionOfInterest(int regionIndex, double regionLow, double regionHigh, int regionBackground, double regionPreset, String regionName)	Method to add a new region of interest to the analyser
void	clear()	Method to erase the analyzer data, sets all channels to zero
void	clearWaitForCompletion()	Clears the mca, but does not return until the clear has been done.
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.
void	deleteRegionOfInterest(int regionIndex)	Method to remove a region of interest from the analyser
void	dispose()	Closes currently unused epics channels.
void	eraseStartAcquisition()	Activates the MCA using the Erase invalid input: '&' Start button.
Object	getAttribute(String attributeName)	Get the value of the specified attribute
String	getCalibrationName()
Object	getCalibrationParameters()	Returns calibration parameters for the analyser.
int	getChannelForEnergy(double energy)
Object	getData()	Method to get data from the analyser
int[]	getDataDimensions()	Default which should be overridden by subclasses.
String	getDescription()
String	getDetectorID()
String	getDetectorType()
double	getDwellTime()	Gets the Dwell Time (DWEL).
Object	getElapsedParameters()	Method to get the elapsed parameters for the analyser Not sure if it is specific to MCA
double	getEnergyForChannel(int channel)
FindableEpicsDevice	getEpicsDevice()
String	getEpicsDeviceName()
int	getIndexForRawROI()
String	getMcaPV()
EpicsMCARegionOfInterest	getNthRegionOfInterest(int regionIndex)	Get specified region of interest
long	getNumberOfChannels()	Method to read the number of channels for the analyser
int	getNumberOfRegions()	Method to read the number of regions for the analyser
int	getNumberOfValsPerRegionOfInterest()
Object	getPresets()	Method to read the preset parameters for the analyser
Object	getRegionsOfInterest()	Method to get regions of interest for the analyser
double[][]	getRegionsOfInterestCount()	Method to return net and total counts of each region of interest in the analyser
double	getRoiCount(int index)	Counts for the specified channel
double	getRoiNetCount(int index)	Net counts for the specified ROI
long	getSequence()	Method to return the current sequence number of the analyser.
int	getStatus()	Returns the current collecting state of the device.
boolean	isReadingDoneIfNotAquiring()
boolean	isReadNetCounts()
Object	readout()	Returns the latest data collected.
void	setCalibration(EpicsMCACalibration calibrate)	sets calibration fields for MCA
void	setCalibration(Object calibrate)	Sets the calibration parameters for the analyser.
void	setCalibrationName(String calibrationName)
void	setData(Object data)	Writes data to the Analyser
void	setDwellTime(double time)	Sets the dwell time (DWEL)
void	setEpicsDevice(FindableEpicsDevice epicsDevice)
void	setEpicsDeviceName(String deviceName)
void	setMcaPV(String mcaPV)	Set PV for the MCA
void	setNumberOfChannels(long channels)	Set number of Channels
void	setNumberOfRegions(int numberOfRegions)	Set number of regions
void	setPresets(Object data)	Sets the preset parameters for the Analyser
void	setReadingDoneIfNotAquiring(boolean readingDoneIfNotAquiring)
void	setReadNetCounts(boolean readNetCounts)
void	setRegionsOfInterest(EpicsMCARegionOfInterest[] epicsMcaRois)	Set the regions of interest for the MCA
void	setRegionsOfInterest(Object highLow)	Sets the regions of interest for the Analyser
void	setSequence(long sequence)	Sets sequence for the Analyser
void	startAcquisition()	Method to turn on acquisition of the analyser
void	stopAcquisition()	Method to turn off acquisition of the analyser
void	waitWhileBusy()	Returns when operation carried out by moveTo has completed

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, getCollectionTime, getPosition, isBusy, prepareForCollection, setCollectionTime, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

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

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, 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, getFileStructure, prepareForCollection, setCollectionTime

Methods inherited from interface gda.device.Device

close, 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, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString

Constructor Details

EpicsMCASimple

public EpicsMCASimple()

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

getEpicsDevice

public FindableEpicsDevice getEpicsDevice()

setEpicsDevice

public void setEpicsDevice(FindableEpicsDevice epicsDevice)

addRegionOfInterest

public void addRegionOfInterest(int regionIndex,
 double regionLow,
 double regionHigh,
 int regionBackground,
 double regionPreset,
 String regionName)
                         throws DeviceException

Description copied from interface: Analyser

Method to add a new region of interest to the analyser

Specified by:

addRegionOfInterest in interface Analyser

Parameters:

regionIndex - the region number

regionLow - the start value of region

regionHigh - the end value of region

regionBackground - the region background

regionPreset - the region preset

regionName - the region name

Throws:

DeviceException

clear

public void clear()
           throws DeviceException

Description copied from interface: Analyser

Method to erase the analyzer data, sets all channels to zero

Specified by:

clear in interface Analyser

Throws:

DeviceException

clearWaitForCompletion

public void clearWaitForCompletion()
                            throws DeviceException

Clears the mca, but does not return until the clear has been done.

Specified by:

clearWaitForCompletion in interface IEpicsMCA

Throws:

DeviceException

deleteRegionOfInterest

public void deleteRegionOfInterest(int regionIndex)
                            throws DeviceException

Description copied from interface: Analyser

Method to remove a region of interest from the analyser

Specified by:

deleteRegionOfInterest in interface Analyser

Parameters:

regionIndex - the region number

Throws:

DeviceException

getCalibrationParameters

public Object getCalibrationParameters()
                                throws DeviceException

Description copied from interface: Analyser

Returns calibration parameters for the analyser. Return calibration offset, calibration slope, calibration quadratic , two theta angle of the detector.

Specified by:

getCalibrationParameters in interface Analyser

Returns:

calibration parameters

Throws:

DeviceException

getData

public Object getData()
               throws DeviceException

Description copied from interface: Analyser

Method to get data from the analyser

Specified by:

getData in interface Analyser

Returns:

the analyser data

Throws:

DeviceException

getDataDimensions

public int[] getDataDimensions()
                        throws DeviceException

Description copied from class: DetectorBase

Default which should be overridden by subclasses.

Specified by:

getDataDimensions in interface Detector

Overrides:

getDataDimensions in class DetectorBase

Returns:

the dimensions of the data object returned by the Detector.readout() method

Throws:

DeviceException

See Also:

• Detector.getDataDimensions()

dispose

public void dispose()
             throws DeviceException

Closes currently unused epics channels. Only run this if you suspect you need to as the next attempt to read a value will re-create the channel.

Throws:

DeviceException

getElapsedParameters

public Object getElapsedParameters()
                            throws DeviceException

Description copied from interface: Analyser

Method to get the elapsed parameters for the analyser Not sure if it is specific to MCA

Specified by:

getElapsedParameters in interface Analyser

Returns:

the elapsed paramters

Throws:

DeviceException

getDwellTime

public double getDwellTime()
                    throws DeviceException

Gets the Dwell Time (DWEL).

Specified by:

getDwellTime in interface IEpicsMCA

Returns:

Dwell Time

Throws:

DeviceException

getNumberOfRegions

public int getNumberOfRegions()
                       throws DeviceException

Description copied from interface: Analyser

Method to read the number of regions for the analyser

Specified by:

getNumberOfRegions in interface Analyser

Returns:

the number of regions

Throws:

DeviceException

getPresets

public Object getPresets()
                  throws DeviceException

Description copied from interface: Analyser

Method to read the preset parameters for the analyser

Specified by:

getPresets in interface Analyser

Returns:

the preset parameters

Throws:

DeviceException

getRegionsOfInterest

public Object getRegionsOfInterest()
                            throws DeviceException

Description copied from interface: Analyser

Method to get regions of interest for the analyser

Specified by:

getRegionsOfInterest in interface Analyser

Returns:

the regions of interest

Throws:

DeviceException

getNumberOfValsPerRegionOfInterest

public int getNumberOfValsPerRegionOfInterest()

getIndexForRawROI

public int getIndexForRawROI()

isReadNetCounts

public boolean isReadNetCounts()

setReadNetCounts

public void setReadNetCounts(boolean readNetCounts)

getRoiCount

public double getRoiCount(int index)
                   throws DeviceException

Description copied from interface: IEpicsMCASimple

Counts for the specified channel

Specified by:

getRoiCount in interface IEpicsMCASimple

Parameters:

index - Index of the channel

Returns:

counts for this channel

Throws:

DeviceException

getRoiNetCount

public double getRoiNetCount(int index)
                      throws DeviceException

Description copied from interface: IEpicsMCASimple

Net counts for the specified ROI

Specified by:

getRoiNetCount in interface IEpicsMCASimple

Parameters:

index - Index of the ROI required

Returns:

Counts for this ROI

Throws:

DeviceException

getRegionsOfInterestCount

public double[][] getRegionsOfInterestCount()
                                     throws DeviceException

Description copied from interface: Analyser

Method to return net and total counts of each region of interest in the analyser

Specified by:

getRegionsOfInterestCount in interface Analyser

Returns:

two dimensional array of net and total counts

Throws:

DeviceException

getSequence

public long getSequence()
                 throws DeviceException

Description copied from interface: Analyser

Method to return the current sequence number of the analyser. Might be specific to MCAs

Specified by:

getSequence in interface Analyser

Returns:

the current sequence number

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

setCalibration

public void setCalibration(EpicsMCACalibration calibrate)
                    throws DeviceException

Description copied from interface: IEpicsMCASimple

sets calibration fields for MCA

Specified by:

setCalibration in interface IEpicsMCASimple

Parameters:

calibrate - The calibration fields

Throws:

DeviceException

setCalibration

public void setCalibration(Object calibrate)
                    throws DeviceException

Description copied from interface: Analyser

Sets the calibration parameters for the analyser.

Specified by:

setCalibration in interface Analyser

Parameters:

calibrate - the calibration parameters to set

Throws:

DeviceException

setData

public void setData(Object data)
             throws DeviceException

Description copied from interface: Analyser

Writes data to the Analyser

Specified by:

setData in interface Analyser

Parameters:

data - the data to write back to the analyser

Throws:

DeviceException

setDwellTime

public void setDwellTime(double time)
                  throws DeviceException

Sets the dwell time (DWEL)

Specified by:

setDwellTime in interface IEpicsMCA

Parameters:

time -

Throws:

DeviceException

setNumberOfRegions

public void setNumberOfRegions(int numberOfRegions)
                        throws DeviceException

Description copied from interface: Analyser

Set number of regions

Specified by:

setNumberOfRegions in interface Analyser

Parameters:

numberOfRegions - the number of regions to set

Throws:

DeviceException

setPresets

public void setPresets(Object data)
                throws DeviceException

Description copied from interface: Analyser

Sets the preset parameters for the Analyser

Specified by:

setPresets in interface Analyser

Parameters:

data - the preset parameters

Throws:

DeviceException

setRegionsOfInterest

public void setRegionsOfInterest(EpicsMCARegionOfInterest[] epicsMcaRois)
                          throws DeviceException

Description copied from interface: IEpicsMCASimple

Set the regions of interest for the MCA

Specified by:

setRegionsOfInterest in interface IEpicsMCASimple

Parameters:

epicsMcaRois - The ROIs to set

Throws:

DeviceException

setRegionsOfInterest

public void setRegionsOfInterest(Object highLow)
                          throws DeviceException

Sets the regions of interest for the Analyser

Specified by:

setRegionsOfInterest in interface Analyser

Parameters:

highLow - the upper and lower bounds of the region

Throws:

DeviceException

See Also:

• * the input parameter highLow object should actually be an array of EpicsMCARegionsOfInterest objects

setSequence

public void setSequence(long sequence)
                 throws DeviceException

Description copied from interface: Analyser

Sets sequence for the Analyser

Specified by:

setSequence in interface Analyser

Parameters:

sequence - the sequence

Throws:

DeviceException

eraseStartAcquisition

public void eraseStartAcquisition()
                           throws DeviceException

Activates the MCA using the Erase invalid input: '&' Start button.

Specified by:

eraseStartAcquisition in interface IEpicsMCA

Throws:

DeviceException

startAcquisition

public void startAcquisition()
                      throws DeviceException

Description copied from interface: Analyser

Method to turn on acquisition of the analyser

Specified by:

startAcquisition in interface Analyser

Throws:

DeviceException

stopAcquisition

public void stopAcquisition()
                     throws DeviceException

Description copied from interface: Analyser

Method to turn off acquisition of the analyser

Specified by:

stopAcquisition in interface Analyser

Throws:

DeviceException

_fireReadingDone

public void _fireReadingDone()

method used for testing only

_setRegionsOfInterestCount

public void _setRegionsOfInterestCount(int index,
 Double val)
                                throws DeviceException

method used for testing only

Throws:

DeviceException

_setRegionsOfInterestNetCount

public void _setRegionsOfInterestNetCount(int index,
 Double val)
                                   throws DeviceException

method used for testing only

Throws:

DeviceException

getNthRegionOfInterest

public EpicsMCARegionOfInterest getNthRegionOfInterest(int regionIndex)
                                                throws DeviceException

Description copied from interface: IEpicsMCASimple

Get specified region of interest

Specified by:

getNthRegionOfInterest in interface IEpicsMCASimple

Parameters:

regionIndex - Index of the ROI required

Returns:

a representation of the ROI

Throws:

DeviceException

getNumberOfChannels

public long getNumberOfChannels()
                         throws DeviceException

Description copied from interface: Analyser

Method to read the number of channels for the analyser

Specified by:

getNumberOfChannels in interface Analyser

Returns:

the number of channels

Throws:

DeviceException

setNumberOfChannels

public void setNumberOfChannels(long channels)
                         throws DeviceException

Description copied from interface: Analyser

Set number of Channels

Specified by:

setNumberOfChannels in interface Analyser

Parameters:

channels - the number of channels to set

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

readout

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

Returns:

the data collected

Throws:

DeviceException

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

getEnergyForChannel

public double getEnergyForChannel(int channel)
                           throws DeviceException

Throws:

DeviceException

getChannelForEnergy

public int getChannelForEnergy(double energy)
                        throws DeviceException

Throws:

DeviceException

getCalibrationName

public String getCalibrationName()

Returns:

converter name

setCalibrationName

public void setCalibrationName(String calibrationName)

Parameters:

calibrationName -

getEpicsDeviceName

public String getEpicsDeviceName()

Returns:

String

setEpicsDeviceName

public void setEpicsDeviceName(String deviceName)

Parameters:

deviceName -

getMcaPV

public String getMcaPV()

Returns:

String

setMcaPV

public void setMcaPV(String mcaPV)

Description copied from interface: IEpicsMCASimple

Set PV for the MCA

Specified by:

setMcaPV in interface IEpicsMCASimple

Parameters:

mcaPV -

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

waitWhileBusy

public void waitWhileBusy()
                   throws DeviceException,
InterruptedException

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:

DeviceException

InterruptedException

isReadingDoneIfNotAquiring

public boolean isReadingDoneIfNotAquiring()

setReadingDoneIfNotAquiring

public void setReadingDoneIfNotAquiring(boolean readingDoneIfNotAquiring)