Package gda.device.detector.xmap

Class DummyXmapControllerBase

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.detector.xmap.DummyXmapControllerBase

All Implemented Interfaces:

XmapController, Device, Configurable, Findable, gda.observable.IObservable

Direct Known Subclasses:

DummyXmapController, DummyXmapControllerAreaDetector

public abstract class DummyXmapControllerBase
extends DeviceBase
implements XmapController

Field Summary

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Constructor Summary

Constructors

Constructor	Description
DummyXmapControllerBase()

Method Summary

Modifier and Type	Method	Description
void	clearAndStart()	Clears all MCAs and starts data collection
void	deleteROIs(int mcaIndex)	Deletes all the current regions of interest on a give mca detector element.
double	getAcquisitionTime()	Returns the time for which the detector is set to acquire data
int	getEvents(int element)
double	getICR(int element)	Reads the input count rate for an element also known as the fast filter rate outside EPICS
int	getNumberOfBins()	Returns current number of Bins/channels for spectrum acquisition in each MCA
int	getNumberOfElements()	Returns the number of MCAs currently connected to the XMap detector
int	getNumberOfROIs()	Returns the Number of Regions of Interest
double	getOCR(int element)	Reads the output count rate for an element also known as the slow filter rate outside EPICS
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 roiIndex)	Returns the roi count for the specified roiIndex in all MCAs
double[][]	getROIParameters(int mcaNumber)
double[]	getROIs(int mcaNumber)
double[]	getROIs(int mcaNumber, int[][] data)
double[]	getROIsSum()	returns the sum of the regions of interest for each region of all MCAs
int	getStatus()	Returns the status of the detector
double	getStatusRate()	Returns the current set rate at which status is read in the Epics interface
void	setAcquisitionTime(double acquisitionTime)	Tells the detector for how many seconds to acquire data
void	setNthROI(double[][] rois, int roiIndex)	Sets the specified roi for all the mcas
void	setNumberOfBins(int numberOfBins)	Sets maximum numbers of bins/channels to use for spectrum acquisition in each MCA
void	setNumberOfElements(int numberOfElements)	Sets the number of MCAs currently connected to the XMap detector
void	setNumberOfROIs(int numberOfROIs)	Sets the Number of Regions of Interest for all MCAs
void	setReadRate(double readRate)	Sets the rate at which data is read in the Epics interface
void	setReadRate(String readRate)	Sets the rate at which data is read in the Epics interface
void	setROI(double[][] rois, int mcaIndex)	Sets the all ROIs of the specified MCA.
void	setROIs(double[][] rois)	Sets the all ROIs of all the MCA.
void	setStatusRate(double statusRate)	Sets the rate at which status is read in the Epics interface
void	setStatusRate(String statusRate)	Sets the rate at which status is read in the Epics interface
void	start()	Start data acquisition in all MCA's
protected void	startDummyAcquisition()
void	stop()	Stop data acquisition in all MCA's
protected void	stopDummyAcquisition()
String	toString()

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

configure, 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

configure, isConfigureAtStartup, isConfigured, reconfigure

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.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.device.detector.xmap.XmapController

getData, getData

Constructor Details

DummyXmapControllerBase

public DummyXmapControllerBase()

Method Details

clearAndStart

public void clearAndStart()
                   throws DeviceException

Description copied from interface: XmapController

Clears all MCAs and starts data collection

Specified by:

clearAndStart in interface XmapController

Throws:

DeviceException

getStatus

public int getStatus()
              throws DeviceException

Description copied from interface: XmapController

Returns the status of the detector

Specified by:

getStatus in interface XmapController

Returns:

Detector.IDLE/BUSY

Throws:

DeviceException

start

public void start()
           throws DeviceException

Description copied from interface: XmapController

Start data acquisition in all MCA's

Specified by:

start in interface XmapController

Throws:

DeviceException

stop

public void stop()
          throws DeviceException

Description copied from interface: XmapController

Stop data acquisition in all MCA's

Specified by:

stop in interface XmapController

Throws:

DeviceException

setNthROI

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

Description copied from interface: XmapController

Sets the specified roi for all the mcas

Specified by:

setNthROI in interface XmapController

Parameters:

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

roiIndex -

Throws:

DeviceException

setROI

public void setROI(double[][] rois,
 int mcaIndex)
            throws DeviceException

Description copied from interface: XmapController

Sets the all ROIs of the specified MCA.

Specified by:

setROI in interface XmapController

Parameters:

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

mcaIndex -

Throws:

DeviceException

setROIs

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

Description copied from interface: XmapController

Sets the all ROIs of all the MCA. All mcas will be set the same roi

Specified by:

setROIs in interface XmapController

Parameters:

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

Throws:

DeviceException

getROIParameters

public double[][] getROIParameters(int mcaNumber)
                            throws DeviceException

Specified by:

getROIParameters in interface XmapController

Throws:

DeviceException

deleteROIs

public void deleteROIs(int mcaIndex)
                throws DeviceException

Description copied from interface: XmapController

Deletes all the current regions of interest on a give mca detector element.

Specified by:

deleteROIs in interface XmapController

Parameters:

mcaIndex -

Throws:

DeviceException

startDummyAcquisition

protected void startDummyAcquisition()

stopDummyAcquisition

protected void stopDummyAcquisition()

getROICounts

public double[] getROICounts(int roiIndex)
                      throws DeviceException

Description copied from interface: XmapController

Returns the roi count for the specified roiIndex in all MCAs

Specified by:

getROICounts in interface XmapController

Parameters:

roiIndex -

Returns:

a double array, e.g if there are 4 mcas and the specified index is 1, it returns [mca1_region1_count, mca2_region1_count, mca3_region1_count, mca4_region1_count]

Throws:

DeviceException

getROIs

public double[] getROIs(int mcaNumber)
                 throws DeviceException

Specified by:

getROIs in interface XmapController

Parameters:

mcaNumber -

Returns:

double array of regions of interest

Throws:

DeviceException

getROIsSum

public double[] getROIsSum()
                    throws DeviceException

Description copied from interface: XmapController

returns the sum of the regions of interest for each region of all MCAs

Specified by:

getROIsSum in interface XmapController

Returns:

a double array e.g if there are 4 mcas and 3 ois each , it returns [region1_sum, region2_sum, region3_sum]

Throws:

DeviceException

getEvents

public int getEvents(int element)
              throws DeviceException

Specified by:

getEvents in interface XmapController

Parameters:

element -

Returns:

the total count for the last element

Throws:

DeviceException

getICR

public double getICR(int element)
              throws DeviceException

Description copied from interface: XmapController

Reads the input count rate for an element also known as the fast filter rate outside EPICS

Specified by:

getICR in interface XmapController

Parameters:

element -

Returns:

rate

Throws:

DeviceException

getOCR

public double getOCR(int element)
              throws DeviceException

Description copied from interface: XmapController

Reads the output count rate for an element also known as the slow filter rate outside EPICS

Specified by:

getOCR in interface XmapController

Parameters:

element -

Returns:

rate

Throws:

DeviceException

getROIs

public double[] getROIs(int mcaNumber,
 int[][] data)
                 throws DeviceException

Specified by:

getROIs in interface XmapController

Parameters:

mcaNumber -

Returns:

double array of regions of interest

Throws:

DeviceException

getNumberOfElements

public int getNumberOfElements()

Description copied from interface: XmapController

Returns the number of MCAs currently connected to the XMap detector

Specified by:

getNumberOfElements in interface XmapController

Returns:

number of MCA

setNumberOfElements

public void setNumberOfElements(int numberOfElements)

Description copied from interface: XmapController

Sets the number of MCAs currently connected to the XMap detector

Specified by:

setNumberOfElements in interface XmapController

Parameters:

numberOfElements -

getNumberOfBins

public int getNumberOfBins()

Description copied from interface: XmapController

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

Specified by:

getNumberOfBins in interface XmapController

Returns:

numberOfBins

setNumberOfBins

public void setNumberOfBins(int numberOfBins)

Description copied from interface: XmapController

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

Specified by:

setNumberOfBins in interface XmapController

Parameters:

numberOfBins -

getAcquisitionTime

public double getAcquisitionTime()

Description copied from interface: XmapController

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

Specified by:

getAcquisitionTime in interface XmapController

Returns:

time

setAcquisitionTime

public void setAcquisitionTime(double acquisitionTime)

Description copied from interface: XmapController

Tells the detector for how many seconds to acquire data

Specified by:

setAcquisitionTime in interface XmapController

Parameters:

acquisitionTime -

getReadRate

public double getReadRate()

Description copied from interface: XmapController

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

Specified by:

getReadRate in interface XmapController

Returns:

readRate

setReadRate

public void setReadRate(double readRate)

Description copied from interface: XmapController

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

Specified by:

setReadRate in interface XmapController

Parameters:

readRate -

setReadRate

public void setReadRate(String readRate)
                 throws DeviceException

Description copied from interface: XmapController

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

Specified by:

setReadRate in interface XmapController

Parameters:

readRate -

Throws:

DeviceException

getStatusRate

public double getStatusRate()

Description copied from interface: XmapController

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

Specified by:

getStatusRate in interface XmapController

Returns:

status rate

setStatusRate

public void setStatusRate(double statusRate)

Description copied from interface: XmapController

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

Specified by:

setStatusRate in interface XmapController

Parameters:

statusRate -

setStatusRate

public void setStatusRate(String statusRate)
                   throws DeviceException

Description copied from interface: XmapController

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

Specified by:

setStatusRate in interface XmapController

Parameters:

statusRate -

Throws:

DeviceException

getNumberOfROIs

public int getNumberOfROIs()

Description copied from interface: XmapController

Returns the Number of Regions of Interest

Specified by:

getNumberOfROIs in interface XmapController

Returns:

roi number

setNumberOfROIs

public void setNumberOfROIs(int numberOfROIs)

Description copied from interface: XmapController

Sets the Number of Regions of Interest for all MCAs

Specified by:

setNumberOfROIs in interface XmapController

Parameters:

numberOfROIs -

getRealTime

public double getRealTime()

Description copied from interface: XmapController

Returns the elapsed real time after a read status operation

Specified by:

getRealTime in interface XmapController

Returns:

real time

toString

public String toString()

Overrides:

toString in class Object