Package gda.device

Interface Analyser

All Superinterfaces:

Configurable, Detector, Device, Findable, gda.observable.IObservable, Scannable

All Known Subinterfaces:

IEpicsMCA, IEpicsMCASimple

All Known Implementing Classes:

AnalyserBase, DummyEpicsMcaForXmap, EpicsMCA, EpicsMCASimple

public interface Analyser
extends Detector

An interface for a distributed Analyser class

Field Summary

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

Method Summary

Modifier and Type	Method	Description
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	deleteRegionOfInterest(int regionIndex)	Method to remove a region of interest from the analyser
Object	getCalibrationParameters()	Returns calibration parameters for the analyser.
Object	getData()	Method to get data from the analyser
Object	getElapsedParameters()	Method to get the elapsed parameters for the analyser Not sure if it is specific to MCA
long	getNumberOfChannels()	Method to read the number of channels for the analyser
int	getNumberOfRegions()	Method to read the number of regions for the analyser
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
long	getSequence()	Method to return the current sequence number of the analyser.
void	setCalibration(Object calibrate)	Sets the calibration parameters for the analyser.
void	setData(Object data)	Writes data to the Analyser
void	setNumberOfChannels(long channels)	Set number of Channels
void	setNumberOfRegions(int regions)	Set number of regions
void	setPresets(Object data)	Sets the preset parameters for the Analyser
void	setRegionsOfInterest(Object lowHigh)	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

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Detector

collectData, createsOwnFiles, endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getFileStructure, getStatus, prepareForCollection, readout, setCollectionTime, waitWhileBusy

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

Method Details

startAcquisition

void startAcquisition()
               throws DeviceException

Method to turn on acquisition of the analyser

Throws:

DeviceException

stopAcquisition

void stopAcquisition()
              throws DeviceException

Method to turn off acquisition of the analyser

Throws:

DeviceException

addRegionOfInterest

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

Method to add a new region of interest to the 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

deleteRegionOfInterest

void deleteRegionOfInterest(int regionIndex)
                     throws DeviceException

Method to remove a region of interest from the analyser

Parameters:

regionIndex - the region number

Throws:

DeviceException

clear

void clear()
    throws DeviceException

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

Throws:

DeviceException

getCalibrationParameters

Object getCalibrationParameters()
                         throws DeviceException

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

Returns:

calibration parameters

Throws:

DeviceException

getData

Object getData()
        throws DeviceException

Method to get data from the analyser

Returns:

the analyser data

Throws:

DeviceException

getElapsedParameters

Object getElapsedParameters()
                     throws DeviceException

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

Returns:

the elapsed paramters

Throws:

DeviceException

getPresets

Object getPresets()
           throws DeviceException

Method to read the preset parameters for the analyser

Returns:

the preset parameters

Throws:

DeviceException

getNumberOfRegions

int getNumberOfRegions()
                throws DeviceException

Method to read the number of regions for the analyser

Returns:

the number of regions

Throws:

DeviceException

getNumberOfChannels

long getNumberOfChannels()
                  throws DeviceException

Method to read the number of channels for the analyser

Returns:

the number of channels

Throws:

DeviceException

getRegionsOfInterest

Object getRegionsOfInterest()
                     throws DeviceException

Method to get regions of interest for the analyser

Returns:

the regions of interest

Throws:

DeviceException

getRegionsOfInterestCount

double[][] getRegionsOfInterestCount()
                              throws DeviceException

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

Returns:

two dimensional array of net and total counts

Throws:

DeviceException

getSequence

long getSequence()
          throws DeviceException

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

Returns:

the current sequence number

Throws:

DeviceException

setCalibration

void setCalibration(Object calibrate)
             throws DeviceException

Sets the calibration parameters for the analyser.

Parameters:

calibrate - the calibration parameters to set

Throws:

DeviceException

setData

void setData(Object data)
      throws DeviceException

Writes data to the Analyser

Parameters:

data - the data to write back to the analyser

Throws:

DeviceException

setPresets

void setPresets(Object data)
         throws DeviceException

Sets the preset parameters for the Analyser

Parameters:

data - the preset parameters

Throws:

DeviceException

setRegionsOfInterest

void setRegionsOfInterest(Object lowHigh)
                   throws DeviceException

Sets the regions of interest for the Analyser

Parameters:

lowHigh - the upper and lower bounds of the region

Throws:

DeviceException

setSequence

void setSequence(long sequence)
          throws DeviceException

Sets sequence for the Analyser

Parameters:

sequence - the sequence

Throws:

DeviceException

setNumberOfRegions

void setNumberOfRegions(int regions)
                 throws DeviceException

Set number of regions

Parameters:

regions - the number of regions to set

Throws:

DeviceException

setNumberOfChannels

void setNumberOfChannels(long channels)
                  throws DeviceException

Set number of Channels

Parameters:

channels - the number of channels to set

Throws:

DeviceException