Package gda.device.detector.xmap

Class EpicsXmapController

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.detector.xmap.EpicsXmapController

All Implemented Interfaces:

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

Direct Known Subclasses:

EpicsXmapControllerROI

public class EpicsXmapController
extends DeviceBase
implements XmapController

Field Summary

Fields

Modifier and Type	Field	Description
protected int	actualNumberOfROIs
protected EDXDMappingController	edxdController
protected int	numberOfBins
protected int	numberOfElements

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Constructor Summary

Constructors

Constructor	Description
EpicsXmapController()

Method Summary

Modifier and Type	Method	Description
void	clearAndStart()	Clears all MCAs and starts data collection
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.
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[][]	getData()	Returns the twoD data array of the all the MCAs
int[]	getData(int mcaNumber)	Returns the data array of the specified MCA
EDXDMappingController	getEdxdController()
double[][]	getEnergyBins()
double[]	getEnergyBins(int mcaNumber)
int	getEvents(int mcaNumber)	Returns the total events recorded
double	getICR(int mcaNumber)	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 roi count if they have been set, otherwise reads the total possible count from EPICS
double	getOCR(int mcaNumber)	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 a count for each mca for a given roi number For instance if roi=0 the first roi
double[][]	getROIParameters(int mcaIndex)
double[]	getROIs(int mcaNumber)
double[]	getROIs(int mcaNumber, int[][] data)
double[]	getROIsSum()	Returns a sum of all rois for each mca channel
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 collectionTime)	Tells the detector for how many seconds to acquire data
void	setEdxdController(EDXDMappingController edxdController)
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[][] actualRois, int mcaIndex)	Set rois the array can be of size [maximum number rois][2] if it is lower for instance [actual number of rois][2] then the other possible rois will be set to zero.
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
void	stop()	Stop data acquisition in all MCA's

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, toString, wait, wait, wait

Methods inherited from interface gda.factory.Configurable

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

Field Details

edxdController

protected EDXDMappingController edxdController

numberOfElements

protected int numberOfElements

numberOfBins

protected int numberOfBins

actualNumberOfROIs

protected int actualNumberOfROIs

Constructor Details

EpicsXmapController

public EpicsXmapController()

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

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

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

getAcquisitionTime

public double getAcquisitionTime()
                          throws DeviceException

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

Throws:

DeviceException

getData

public int[] getData(int mcaNumber)
              throws DeviceException

Description copied from interface: XmapController

Returns the data array of the specified MCA

Specified by:

getData in interface XmapController

Parameters:

mcaNumber -

Returns:

data array

Throws:

DeviceException

getData

public int[][] getData()
                throws DeviceException

Description copied from interface: XmapController

Returns the twoD data array of the all the MCAs

Specified by:

getData in interface XmapController

Returns:

data array

Throws:

DeviceException

getNumberOfBins

public int getNumberOfBins()
                    throws DeviceException

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

Throws:

DeviceException

setNumberOfBins

public void setNumberOfBins(int numberOfBins)
                     throws DeviceException

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 -

Throws:

DeviceException

getNumberOfElements

public int getNumberOfElements()
                        throws DeviceException

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

Throws:

DeviceException

getNumberOfROIs

public int getNumberOfROIs()

Returns the roi count if they have been set, otherwise reads the total possible count from EPICS

Specified by:

getNumberOfROIs in interface XmapController

Returns:

roi number

getROICounts

public double[] getROICounts(int roiIndex)
                      throws DeviceException

Returns a count for each mca for a given roi number For instance if roi=0 the first roi

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

Returns a sum of all rois for each mca channel

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

getReadRate

public double getReadRate()
                   throws DeviceException

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

Throws:

DeviceException

getRealTime

public double getRealTime()
                   throws DeviceException

Description copied from interface: XmapController

Returns the elapsed real time after a read status operation

Specified by:

getRealTime in interface XmapController

Returns:

real time

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

getStatusRate

public double getStatusRate()
                     throws DeviceException

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

Throws:

DeviceException

setAcquisitionTime

public void setAcquisitionTime(double collectionTime)
                        throws DeviceException

Description copied from interface: XmapController

Tells the detector for how many seconds to acquire data

Specified by:

setAcquisitionTime in interface XmapController

Parameters:

collectionTime -

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

setNumberOfElements

public void setNumberOfElements(int numberOfElements)
                         throws DeviceException

Description copied from interface: XmapController

Sets the number of MCAs currently connected to the XMap detector

Specified by:

setNumberOfElements in interface XmapController

Parameters:

numberOfElements -

Throws:

DeviceException

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 -

setROI

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

Set rois the array can be of size [maximum number rois][2] if it is lower for instance [actual number of rois][2] then the other possible rois will be set to zero. The actual number of rois is also taken from the length of the first dimension of this array so it should always be passed in with size of the actual number of rois.

Specified by:

setROI in interface XmapController

Parameters:

actualRois - 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

setReadRate

public void setReadRate(double 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

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

setStatusRate

public void setStatusRate(double 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

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

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

getEvents

public int getEvents(int mcaNumber)
              throws DeviceException

Returns the total events recorded

Specified by:

getEvents in interface XmapController

Parameters:

mcaNumber -

Returns:

the total count for the last element

Throws:

DeviceException

getICR

public double getICR(int mcaNumber)
              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:

mcaNumber -

Returns:

rate

Throws:

DeviceException

getOCR

public double getOCR(int mcaNumber)
              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:

mcaNumber -

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

getROIParameters

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

Specified by:

getROIParameters in interface XmapController

Throws:

DeviceException

getEdxdController

public EDXDMappingController getEdxdController()

setEdxdController

public void setEdxdController(EDXDMappingController edxdController)

getEnergyBins

public double[] getEnergyBins(int mcaNumber)
                       throws DeviceException

Throws:

DeviceException

getEnergyBins

public double[][] getEnergyBins()
                         throws DeviceException

Throws:

DeviceException