Package uk.ac.gda.devices.detector.xspress4

Class EpicsXspress4Controller

java.lang.Object

gda.factory.FindableBase

uk.ac.gda.devices.detector.xspress4.EpicsXspress4Controller

All Implemented Interfaces:

Findable, org.springframework.beans.factory.InitializingBean, Xspress4Controller

public class EpicsXspress4Controller
extends FindableBase
implements Xspress4Controller, org.springframework.beans.factory.InitializingBean

Constructor Summary

Constructors

Constructor	Description
EpicsXspress4Controller()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
boolean	checkScalerWindowIsSet(int channel, int windowNumber, int lowLimit, int highLimit)
void	connect()
void	disonnect()
String	getArrPluginPrefix()
String	getBasePv()
double	getCaClientTimeout()
long	getCounterWaitTimeMs()
double	getDeadtimeCorrectionEnergy()
double[]	getDeadtimeCorrectionFactors()	Return deadtime correction factor for each detector element.
XSPRESS3_EPICS_STATUS	getDetectorState()
String	getHdfFilePath()
String	getHdfFullFileName()
int	getHdfNumCapturedFrames()
int	getHdfNumFramesRbv()
String	getHdfWriterPrefix()
long	getHdfWriterWaitTimeMs()
String	getMainControlPrefix()
double[][]	getMcaData()	Return array with current values of MCA data for all detector elements
double[]	getMcaData(int element)	Return array with current values of MCA data for single detector element.
String	getMetaOutputFileName()
String	getMetaWriterPrefix()
int	getNumElements()
int	getNumImages()
int	getNumImagesRbv()
int	getNumMcaChannels()
int	getNumScalers()
double[]	getResGradeArrays(int element, int window)	Return array of resolution grade values for a detector element.
double[]	getScalerArray(int element)	Return array of scaler values for a detector element.
double[][]	getScalerTimeseries(int element, int startFrame, int endFrame)	Return time series array of the scaler values for detector element
double	getScalerValue(int element, int scalerNumber)	Return individual scaler value for detector element
int	getTimeSeriesNumPoints()
int	getTotalFramesAvailable()	Return total number of frames available to readout (ArrayCounter_RBV)
int	getTriggerMode()
boolean	isConnected()
void	prepareForMcaCollection(double timeMs)	Prepare for MCA data collection : set the trigger mode to 'Software' number of images to 1 set acquire time enable the array plugin (Odin only)
void	resetFramesReadOut()	Reset the counter used to indicate the number of frames read out back to zero.
void	sendSoftwareTrigger()
void	setAcquireTime(double time)	Set collection time ('Acquire time') - used when doing software triggered step scans.
void	setArrPluginPrefix(String arrPluginPrefix)
void	setBasePv(String pvBase)
void	setCaClientTimeout(double caClientTimeoutSecs)	Timeout to use for channel access put/get operations (seconds)
void	setCounterWaitTimeMs(long counterWaitTimeMs)	Extra time to wait in waitForCounterToIncrement(int, long) after the counter has incremented.
void	setDeadtimeCorrectionEnergy(double energyKev)	Set the deadtime correction energy value (energy in keV).
void	setHdfFileName(String name)
void	setHdfFilePath(String path)
void	setHdfNumFrames(int numFrames)	Set the number of frames to capture in Hdf writer
void	setHdfWriterPrefix(String hdfWriterPrefix)
void	setHdfWriterWaitTimeMs(long hdfWriterWaitTimeMs)
void	setMainControlPrefix(String mainControlPrefix)
String	setMetaFileName()
void	setMetaWriterPrefix(String metaWriterPrefix)
void	setNumElements(int numElements)	Set the number of detector elements.
void	setNumImages(int numImages)
void	setNumMcaChannels(int numMcaChannels)	Set number of MCA channels
void	setNumScalers(int numScalers)	Set the number of scaler values available.
void	setPvNameMap(Map<String,String> nameMap)	Update the PV name map using new values passed in.
boolean	setSaveResolutionGradeData(boolean saveResGradeData)	Set whether the detector to record resolution grade data in the hdf file.
void	setScalerWindow(int channel, int windowNumber, int lowLimit, int highLimit)
void	setTriggerMode(int triggerMode)	Set the trigger mode.
void	startAcquire()
void	startHdfWriter()
void	startTimeSeries()
void	stopAcquire()
void	stopHdfWriter()
void	stopMetaWriter()
void	stopTimeSeries()
void	updateArrays()
void	waitForAcquireState(ACQUIRE_STATE state)
void	waitForCaptureState(boolean state)	Wait for Hdf file image capture capture to start/stop
void	waitForCounterToIncrement(int initialNumFrames, long timeoutMillis)	Wait for the value returned by a PV to change.

Methods inherited from class gda.factory.FindableBase

equals, getName, hashCode, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EpicsXspress4Controller

public EpicsXspress4Controller()

Method Details

setPvNameMap

public void setPvNameMap(Map<String,String> nameMap)

Update the PV name map using new values passed in.

Parameters:

nameMap - key = logical name (i.e. matching a value in XspressPvName), value = PV name/pattern

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Throws:

Exception

isConnected

public boolean isConnected()
                    throws DeviceException

Throws:

DeviceException

connect

public void connect()
             throws DeviceException

Throws:

DeviceException

disonnect

public void disonnect()
               throws DeviceException

Throws:

DeviceException

getCaClientTimeout

public double getCaClientTimeout()

setCaClientTimeout

public void setCaClientTimeout(double caClientTimeoutSecs)

Timeout to use for channel access put/get operations (seconds)

Parameters:

caClientTimeoutSecs -

getScalerValue

public double getScalerValue(int element,
 int scalerNumber)
                      throws DeviceException

Description copied from interface: Xspress4Controller

Return individual scaler value for detector element

Specified by:

getScalerValue in interface Xspress4Controller

Parameters:

element -

scalerNumber - index of scaler

Returns:

Throws:

DeviceException

getScalerArray

public double[] getScalerArray(int element)
                        throws DeviceException

Description copied from interface: Xspress4Controller

Return array of scaler values for a detector element. These are the SCA0, SCA1 ... SCA8 values.

Specified by:

getScalerArray in interface Xspress4Controller

Parameters:

element -

Returns:

array [num scalers]

Throws:

DeviceException

getScalerTimeseries

public double[][] getScalerTimeseries(int element,
 int startFrame,
 int endFrame)
                               throws DeviceException

Description copied from interface: Xspress4Controller

Return time series array of the scaler values for detector element

Specified by:

getScalerTimeseries in interface Xspress4Controller

Parameters:

element -

Returns:

array of values [num scalers][numValues]

Throws:

DeviceException

getTimeSeriesNumPoints

public int getTimeSeriesNumPoints()
                           throws DeviceException

Specified by:

getTimeSeriesNumPoints in interface Xspress4Controller

Throws:

DeviceException

startTimeSeries

public void startTimeSeries()
                     throws DeviceException

Specified by:

startTimeSeries in interface Xspress4Controller

Throws:

DeviceException

stopTimeSeries

public void stopTimeSeries()
                    throws DeviceException

Specified by:

stopTimeSeries in interface Xspress4Controller

Throws:

DeviceException

getResGradeArrays

public double[] getResGradeArrays(int element,
 int window)
                           throws DeviceException

Description copied from interface: Xspress4Controller

Return array of resolution grade values for a detector element. These are in-'window counts' for each resolution grade (normally 16)

Specified by:

getResGradeArrays in interface Xspress4Controller

Parameters:

element -

window -

Returns:

array of data [num resolution grades]

Throws:

DeviceException

getMcaData

public double[] getMcaData(int element)
                    throws DeviceException

Description copied from interface: Xspress4Controller

Return array with current values of MCA data for single detector element.

Specified by:

getMcaData in interface Xspress4Controller

Returns:

array of data [number of MCA channels]

Throws:

DeviceException

updateArrays

public void updateArrays()
                  throws DeviceException

Throws:

DeviceException

getMcaData

public double[][] getMcaData()
                      throws DeviceException

Description copied from interface: Xspress4Controller

Return array with current values of MCA data for all detector elements

Specified by:

getMcaData in interface Xspress4Controller

Returns:

array of data [num detector elements, number of MCA channels]

Throws:

DeviceException

setTriggerMode

public void setTriggerMode(int triggerMode)
                    throws DeviceException

Description copied from interface: Xspress4Controller

Set the trigger mode. The integer is the index in the trigger mode enum PV to select.

Specified by:

setTriggerMode in interface Xspress4Controller

Parameters:

triggerMode - index of the trigger mode.

Throws:

DeviceException

getTriggerMode

public int getTriggerMode()
                   throws DeviceException

Specified by:

getTriggerMode in interface Xspress4Controller

Throws:

DeviceException

setSaveResolutionGradeData

public boolean setSaveResolutionGradeData(boolean saveResGradeData)
                                   throws DeviceException

Description copied from interface: Xspress4Controller

Set whether the detector to record resolution grade data in the hdf file. This is done by setting the binning to use for the 'resolution grade' dimension of the MCA dataset in the hdf writer to either :

1 == save each grade (used for 'Region of interest' readout mode).

16 == don't save the grades, i.e. integrate over grades (used for 'MCA', 'MCA + scalers' readout mode).

Specified by:

setSaveResolutionGradeData in interface Xspress4Controller

Parameters:

saveResGradeData -

Returns:

true if binning was changed, false otherwise.

Throws:

DeviceException

setDeadtimeCorrectionEnergy

public void setDeadtimeCorrectionEnergy(double energyKev)
                                 throws DeviceException

Description copied from interface: Xspress4Controller

Set the deadtime correction energy value (energy in keV).

Specified by:

setDeadtimeCorrectionEnergy in interface Xspress4Controller

Parameters:

energyKev - energy in keV.

Throws:

DeviceException

getDeadtimeCorrectionEnergy

public double getDeadtimeCorrectionEnergy()
                                   throws DeviceException

Specified by:

getDeadtimeCorrectionEnergy in interface Xspress4Controller

Throws:

DeviceException

resetFramesReadOut

public void resetFramesReadOut()
                        throws DeviceException

Description copied from interface: Xspress4Controller

Reset the counter used to indicate the number of frames read out back to zero. (this counter is not used during data collection).

Specified by:

resetFramesReadOut in interface Xspress4Controller

Throws:

DeviceException

getTotalFramesAvailable

public int getTotalFramesAvailable()
                            throws DeviceException

Description copied from interface: Xspress4Controller

Return total number of frames available to readout (ArrayCounter_RBV)

Specified by:

getTotalFramesAvailable in interface Xspress4Controller

Returns:

Throws:

DeviceException

setAcquireTime

public void setAcquireTime(double time)
                    throws DeviceException

Description copied from interface: Xspress4Controller

Set collection time ('Acquire time') - used when doing software triggered step scans.

Specified by:

setAcquireTime in interface Xspress4Controller

Parameters:

time - frame time in seconds.

Throws:

DeviceException

getDeadtimeCorrectionFactors

public double[] getDeadtimeCorrectionFactors()
                                      throws DeviceException

Description copied from interface: Xspress4Controller

Return deadtime correction factor for each detector element. This is a multiplicative factor that can be applied to in-window scaler counts to correct for missed photon counts.

Specified by:

getDeadtimeCorrectionFactors in interface Xspress4Controller

Returns:

array of data [num detector elements]

Throws:

DeviceException

getBasePv

public String getBasePv()

setBasePv

public void setBasePv(String pvBase)

getNumElements

public int getNumElements()

Specified by:

getNumElements in interface Xspress4Controller

Returns:

The number of detector elements (called 'Num Channels' in 'System Configuration' EDM settings)

setNumElements

public void setNumElements(int numElements)

Description copied from interface: Xspress4Controller

Set the number of detector elements.

Specified by:

setNumElements in interface Xspress4Controller

Parameters:

numElements -

getNumScalers

public int getNumScalers()

Specified by:

getNumScalers in interface Xspress4Controller

setNumScalers

public void setNumScalers(int numScalers)

Description copied from interface: Xspress4Controller

Set the number of scaler values available. (Does not set value on PV)

Specified by:

setNumScalers in interface Xspress4Controller

Parameters:

numScalers -

waitForCounterToIncrement

public void waitForCounterToIncrement(int initialNumFrames,
 long timeoutMillis)
                               throws DeviceException,
InterruptedException

Wait for the value returned by a PV to change. This function blocks until PV value != startValue, timeout is reached or an exception is thrown. Ad additional sleep after the value has changed can be included by setting counterWaitTimeMs

Specified by:

waitForCounterToIncrement in interface Xspress4Controller

Parameters:

timeoutMillis -

pv -

startValue -

Throws:

InterruptedException

DeviceException

getNumMcaChannels

public int getNumMcaChannels()

Specified by:

getNumMcaChannels in interface Xspress4Controller

Returns:

Number of MCA channels of data associated with each detector element (called 'Max MCA Elements' in 'System Configuration' EDM settings)

setNumMcaChannels

public void setNumMcaChannels(int numMcaChannels)

Description copied from interface: Xspress4Controller

Set number of MCA channels

Specified by:

setNumMcaChannels in interface Xspress4Controller

Parameters:

numMcaChannels -

checkScalerWindowIsSet

public boolean checkScalerWindowIsSet(int channel,
 int windowNumber,
 int lowLimit,
 int highLimit)
                               throws DeviceException

Specified by:

checkScalerWindowIsSet in interface Xspress4Controller

Throws:

DeviceException

setScalerWindow

public void setScalerWindow(int channel,
 int windowNumber,
 int lowLimit,
 int highLimit)
                     throws DeviceException

Specified by:

setScalerWindow in interface Xspress4Controller

Throws:

DeviceException

getDetectorState

public XSPRESS3_EPICS_STATUS getDetectorState()
                                       throws DeviceException

Specified by:

getDetectorState in interface Xspress4Controller

Throws:

DeviceException

waitForAcquireState

public void waitForAcquireState(ACQUIRE_STATE state)
                         throws DeviceException

Specified by:

waitForAcquireState in interface Xspress4Controller

Throws:

DeviceException

sendSoftwareTrigger

public void sendSoftwareTrigger()
                         throws DeviceException

Specified by:

sendSoftwareTrigger in interface Xspress4Controller

Throws:

DeviceException

startAcquire

public void startAcquire()
                  throws DeviceException

Specified by:

startAcquire in interface Xspress4Controller

Throws:

DeviceException

stopAcquire

public void stopAcquire()
                 throws DeviceException

Specified by:

stopAcquire in interface Xspress4Controller

Throws:

DeviceException

waitForCaptureState

public void waitForCaptureState(boolean state)
                         throws DeviceException

Wait for Hdf file image capture capture to start/stop

Specified by:

waitForCaptureState in interface Xspress4Controller

Parameters:

state - : true == wait for start, false = wait for stop.

Throws:

DeviceException

setNumImages

public void setNumImages(int numImages)
                  throws DeviceException

Specified by:

setNumImages in interface Xspress4Controller

Throws:

DeviceException

getNumImages

public int getNumImages()
                 throws DeviceException

Throws:

DeviceException

getNumImagesRbv

public int getNumImagesRbv()
                    throws DeviceException

Throws:

DeviceException

startHdfWriter

public void startHdfWriter()
                    throws DeviceException

Specified by:

startHdfWriter in interface Xspress4Controller

Throws:

DeviceException

getHdfWriterWaitTimeMs

public long getHdfWriterWaitTimeMs()

setHdfWriterWaitTimeMs

public void setHdfWriterWaitTimeMs(long hdfWriterWaitTimeMs)

stopHdfWriter

public void stopHdfWriter()
                   throws DeviceException

Specified by:

stopHdfWriter in interface Xspress4Controller

Throws:

DeviceException

setHdfFilePath

public void setHdfFilePath(String path)
                    throws DeviceException

Specified by:

setHdfFilePath in interface Xspress4Controller

Throws:

DeviceException

getHdfFilePath

public String getHdfFilePath()
                      throws DeviceException

Specified by:

getHdfFilePath in interface Xspress4Controller

Throws:

DeviceException

setHdfFileName

public void setHdfFileName(String name)
                    throws DeviceException

Specified by:

setHdfFileName in interface Xspress4Controller

Throws:

DeviceException

getHdfFullFileName

public String getHdfFullFileName()
                          throws DeviceException

Specified by:

getHdfFullFileName in interface Xspress4Controller

Throws:

DeviceException

setHdfNumFrames

public void setHdfNumFrames(int numFrames)
                     throws DeviceException

Description copied from interface: Xspress4Controller

Set the number of frames to capture in Hdf writer

Specified by:

setHdfNumFrames in interface Xspress4Controller

Throws:

DeviceException

getHdfNumFramesRbv

public int getHdfNumFramesRbv()
                       throws DeviceException

Specified by:

getHdfNumFramesRbv in interface Xspress4Controller

Returns:

Readback value of number of frames to capture in Hdf writer

Throws:

DeviceException

getHdfNumCapturedFrames

public int getHdfNumCapturedFrames()
                            throws DeviceException

Specified by:

getHdfNumCapturedFrames in interface Xspress4Controller

Returns:

Total number of captured frames in Hdf writer

Throws:

DeviceException

setMetaFileName

public String setMetaFileName()
                       throws DeviceException

Throws:

DeviceException

getMetaOutputFileName

public String getMetaOutputFileName()
                             throws DeviceException

Throws:

DeviceException

stopMetaWriter

public void stopMetaWriter()
                    throws DeviceException

Throws:

DeviceException

setHdfWriterPrefix

public void setHdfWriterPrefix(String hdfWriterPrefix)

getHdfWriterPrefix

public String getHdfWriterPrefix()

setMainControlPrefix

public void setMainControlPrefix(String mainControlPrefix)

getMainControlPrefix

public String getMainControlPrefix()

setMetaWriterPrefix

public void setMetaWriterPrefix(String metaWriterPrefix)

getMetaWriterPrefix

public String getMetaWriterPrefix()

getArrPluginPrefix

public String getArrPluginPrefix()

setArrPluginPrefix

public void setArrPluginPrefix(String arrPluginPrefix)

getCounterWaitTimeMs

public long getCounterWaitTimeMs()

setCounterWaitTimeMs

public void setCounterWaitTimeMs(long counterWaitTimeMs)

Extra time to wait in waitForCounterToIncrement(int, long) after the counter has incremented.

Parameters:

counterWaitTimeMs -

prepareForMcaCollection

public void prepareForMcaCollection(double timeMs)
                             throws DeviceException

Prepare for MCA data collection :

set the trigger mode to 'Software'

number of images to 1

set acquire time

enable the array plugin (Odin only)

Specified by:

prepareForMcaCollection in interface Xspress4Controller

Parameters:

timeMs - acquire time (milliseconds)

Throws:

DeviceException