Package uk.ac.gda.devices.detector.xspress3mini.controllerimpl

Class EpicsXspress3MiniController

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

uk.ac.gda.devices.detector.xspress3.controllerimpl.EpicsXspress3Controller

uk.ac.gda.devices.detector.xspress3mini.controllerimpl.EpicsXspress3MiniController

All Implemented Interfaces:

Configurable, Findable, Xspress3Controller, Xspress3MiniController

public class EpicsXspress3MiniController
extends EpicsXspress3Controller
implements Xspress3MiniController

Field Summary

Fields inherited from class uk.ac.gda.devices.detector.xspress3.controllerimpl.EpicsXspress3Controller

defaultNumberOfDetectorChannels, epicsTemplate

Constructor Summary

Constructors

Constructor	Description
EpicsXspress3MiniController()

Method Summary

Modifier and Type	Method	Description
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.
protected EpicsXspress3ControllerPvProvider	createPvProvider(String epicsTemplate, int numberOfDetectorChannels)
void	doErase()
void	doStart()
double	getAcquireTime()
Boolean	getPerformROICalculations()
Boolean	getPerformROIUpdates()
Integer[]	getROILimits(int channel, int roiNumber)
int[]	getRoiStartAndSize(int roiNo)
int	getStatus()
TRIGGER_MODE	getTriggerMode()
protected boolean	isDetectorInDesireState(boolean shouldBeBusy)
protected Integer[][]	readIntegerArray(ReadOnlyPV<Integer[]>[] pvs, int startChannel, int finalChannel)
double[][]	readoutRoiArrayData(int[] recordRois)	Method for getting array data for a single channel multiple ROI device
Integer[][][]	readoutScalerValues(int startFrame, int finalFrame, int startChannel, int finalChannel)	Array of scaler stats.
void	setAcquireTime(double time)
void	setROILimits(int channel, int roiNumber, int[] lowHighMCAChannels)
void	setRoiStartAndSize(int roiNo, int startX, int sizeX)
void	setRoiSumStartAndSize(int startX, int sizeX)
void	setTriggerMode(TRIGGER_MODE mode)
protected void	updateArrays()
protected void	updateArrayState(ACQUIRE_STATE newState)
void	waitForDetector(boolean shouldBeBusy, long timeout)

Methods inherited from class uk.ac.gda.devices.detector.xspress3.controllerimpl.EpicsXspress3Controller

configureHDFDimensions, doReset, doStop, doStopSavingFiles, enableChannel, getEpicsTemplate, getFilePath, getFilePrefix, getFullFileName, getMaxNumberFrames, getMcaSize, getNextFileNumber, getNumberOfChannels, getNumberOfRois, getNumberROIToRead, getNumFramesPerReadout, getNumFramesToAcquire, getPvProvider, getSCAAttrName, getStatusMessage, getTotalFramesAvailable, getTotalHDFFramesAvailable, getWindows, invertIntegerArray, isBusy, isChannelEnabled, isConnected, isSavingFiles, isUseErasePv, monitorReadyForNextRow, readDoubleWaveform, readIntegerWaveform, readoutDTCorrectedLatestMCA, readoutDTCorrectedLatestSummedMCA, readoutDTCorrectedROI, readoutDTCorrectedSCA1, readoutDTCorrectedSCA2, readoutDTCParameters, reorderScalerValues, setArrayCounter, setDeadTimeCorrectionInputArrayPort, setDefaultNumberOfChannels, setEpicsTemplate, setFileArrayCounter, setFileCaptureMode, setFileEnableCallBacks, setFilePath, setFilePrefix, setFileTemplate, setHDFAttributes, setHDFExtraDimensions, setHDFFileAutoIncrement, setHDFLazyOpen, setHDFNDArrayPort, setHDFNDAttributeChunk, setHDFNumFramesChunks, setHDFNumFramesToAcquire, setHDFPerformance, setHDFPositionMode, setHDFXML, setIocVersion3, setNextFileNumber, setNumberROIToRead, setNumFramesToAcquire, setPerformROICalculations, setPerformROIUpdates, setPointsPerRow, setSavingFiles, setStoreAttributesUsingExraDims, setUseErasePv, setUseNewEpicsInterface, setWindows, waitUntilFrameAvailable

Methods inherited from class gda.factory.FindableConfigurableBase

getName, setName

Methods inherited from class gda.factory.ConfigurableBase

isConfigureAtStartup, isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface uk.ac.gda.devices.detector.xspress3.Xspress3Controller

configureHDFDimensions, doReset, doStop, doStopSavingFiles, enableChannel, getFilePath, getFilePrefix, getFullFileName, getMaxNumberFrames, getMcaSize, getNextFileNumber, getNumberOfChannels, getNumberOfRois, getNumberROIToRead, getNumFramesPerReadout, getNumFramesToAcquire, getStatusMessage, getTotalFramesAvailable, getTotalHDFFramesAvailable, getWindows, isBusy, isChannelEnabled, isConnected, isSavingFiles, monitorReadyForNextRow, readoutDTCorrectedLatestMCA, readoutDTCorrectedLatestSummedMCA, readoutDTCorrectedROI, readoutDTCorrectedSCA1, readoutDTCorrectedSCA2, readoutDTCParameters, setArrayCounter, setDeadTimeCorrectionInputArrayPort, setFileArrayCounter, setFileCaptureMode, setFileEnableCallBacks, setFilePath, setFilePrefix, setFileTemplate, setHDFAttributes, setHDFExtraDimensions, setHDFFileAutoIncrement, setHDFLazyOpen, setHDFNDArrayPort, setHDFNDAttributeChunk, setHDFNumFramesChunks, setHDFNumFramesToAcquire, setHDFPerformance, setHDFPositionMode, setHDFXML, setNextFileNumber, setNumberROIToRead, setNumFramesToAcquire, setPerformROICalculations, setPointsPerRow, setSavingFiles, setStoreAttributesUsingExraDims, setWindows, waitUntilFrameAvailable

Constructor Details

EpicsXspress3MiniController

public EpicsXspress3MiniController()

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

Specified by:

configure in interface Xspress3Controller

Overrides:

configure in class EpicsXspress3Controller

Throws:

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

getStatus

public int getStatus()
              throws DeviceException

Specified by:

getStatus in interface Xspress3Controller

Overrides:

getStatus in class EpicsXspress3Controller

Returns:

- matches values in the Detector interface getStatus().

invalid @link

{@link #Detector.getStatus()

}

Throws:

DeviceException

createPvProvider

protected EpicsXspress3ControllerPvProvider createPvProvider(String epicsTemplate,
 int numberOfDetectorChannels)

Overrides:

createPvProvider in class EpicsXspress3Controller

doStart

public void doStart()
             throws DeviceException

Specified by:

doStart in interface Xspress3Controller

Overrides:

doStart in class EpicsXspress3Controller

Throws:

DeviceException

doErase

public void doErase()
             throws DeviceException

Specified by:

doErase in interface Xspress3Controller

Overrides:

doErase in class EpicsXspress3Controller

Throws:

DeviceException

getPerformROICalculations

public Boolean getPerformROICalculations()
                                  throws DeviceException

Overrides:

getPerformROICalculations in class EpicsXspress3Controller

Throws:

DeviceException

getPerformROIUpdates

public Boolean getPerformROIUpdates()
                             throws DeviceException

Overrides:

getPerformROIUpdates in class EpicsXspress3Controller

Throws:

DeviceException

getROILimits

public Integer[] getROILimits(int channel,
 int roiNumber)
                       throws DeviceException

Specified by:

getROILimits in interface Xspress3Controller

Overrides:

getROILimits in class EpicsXspress3Controller

Parameters:

channel -

roiNumber -

Returns:

int[] [lowChannel,highChannel]

Throws:

DeviceException

setTriggerMode

public void setTriggerMode(TRIGGER_MODE mode)
                    throws DeviceException

Specified by:

setTriggerMode in interface Xspress3Controller

Overrides:

setTriggerMode in class EpicsXspress3Controller

Throws:

DeviceException

getTriggerMode

public TRIGGER_MODE getTriggerMode()
                            throws DeviceException

Specified by:

getTriggerMode in interface Xspress3Controller

Overrides:

getTriggerMode in class EpicsXspress3Controller

Throws:

DeviceException

updateArrays

protected void updateArrays()
                     throws DeviceException

Overrides:

updateArrays in class EpicsXspress3Controller

Throws:

DeviceException

setROILimits

public void setROILimits(int channel,
 int roiNumber,
 int[] lowHighMCAChannels)
                  throws DeviceException

Specified by:

setROILimits in interface Xspress3Controller

Overrides:

setROILimits in class EpicsXspress3Controller

Parameters:

channel -

roiNumber -

lowHighMCAChannels - [lowChannel,highChannel]

Throws:

DeviceException

setRoiSumStartAndSize

public void setRoiSumStartAndSize(int startX,
 int sizeX)
                           throws DeviceException

Specified by:

setRoiSumStartAndSize in interface Xspress3MiniController

Throws:

DeviceException

setRoiStartAndSize

public void setRoiStartAndSize(int roiNo,
 int startX,
 int sizeX)
                        throws DeviceException

Specified by:

setRoiStartAndSize in interface Xspress3MiniController

Throws:

DeviceException

getRoiStartAndSize

public int[] getRoiStartAndSize(int roiNo)
                         throws DeviceException

Specified by:

getRoiStartAndSize in interface Xspress3MiniController

Throws:

DeviceException

readoutRoiArrayData

public double[][] readoutRoiArrayData(int[] recordRois)
                               throws DeviceException

Method for getting array data for a single channel multiple ROI device

Specified by:

readoutRoiArrayData in interface Xspress3MiniController

Returns:

roiData

Throws:

DeviceException

waitForDetector

public void waitForDetector(boolean shouldBeBusy,
 long timeout)
                     throws DeviceException

Specified by:

waitForDetector in interface Xspress3MiniController

Throws:

DeviceException

isDetectorInDesireState

protected boolean isDetectorInDesireState(boolean shouldBeBusy)
                                   throws DeviceException

Throws:

DeviceException

updateArrayState

protected void updateArrayState(ACQUIRE_STATE newState)
                         throws DeviceException

Throws:

DeviceException

readoutScalerValues

public Integer[][][] readoutScalerValues(int startFrame,
 int finalFrame,
 int startChannel,
 int finalChannel)
                                  throws DeviceException

Description copied from interface: Xspress3Controller

Array of scaler stats.

Use the value from Xspress3Controller.getTotalFramesAvailable() to know what frames will have valid data in

Specified by:

readoutScalerValues in interface Xspress3Controller

Overrides:

readoutScalerValues in class EpicsXspress3Controller

Parameters:

startFrame -

finalFrame -

startChannel -

finalChannel -

Returns:

int[frame][channel][time,reset ticks, reset counts,all events, all goodEvents, pileup counts]

Throws:

DeviceException

readIntegerArray

protected Integer[][] readIntegerArray(ReadOnlyPV<Integer[]>[] pvs,
 int startChannel,
 int finalChannel)
                                throws DeviceException

Throws:

DeviceException

setAcquireTime

public void setAcquireTime(double time)
                    throws DeviceException

Specified by:

setAcquireTime in interface Xspress3MiniController

Throws:

DeviceException

getAcquireTime

public double getAcquireTime()
                      throws DeviceException

Specified by:

getAcquireTime in interface Xspress3MiniController

Throws:

DeviceException