Package gda.device.detector.analyser

Interface IEpicsMCASimple

All Superinterfaces:

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

All Known Implementing Classes:

DummyEpicsMcaForXmap, EpicsMCASimple

public interface IEpicsMCASimple
extends IEpicsMCA

An interface to devices that support the EPICS MCA record

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
EpicsMCARegionOfInterest	getNthRegionOfInterest(int regionIndex)	Get specified region of interest
double	getRoiCount(int index)	Counts for the specified channel
double	getRoiNetCount(int index)	Net counts for the specified ROI
void	setCalibration(EpicsMCACalibration calibrate)	sets calibration fields for MCA
void	setMcaPV(String mcaPV)	Set PV for the MCA
void	setRegionsOfInterest(EpicsMCARegionOfInterest[] epicsMcaRois)	Set the regions of interest for the MCA

Methods inherited from interface gda.device.Analyser

addRegionOfInterest, clear, deleteRegionOfInterest, getCalibrationParameters, getData, getElapsedParameters, getNumberOfChannels, getNumberOfRegions, getPresets, getRegionsOfInterest, getRegionsOfInterestCount, getSequence, setCalibration, setData, setNumberOfChannels, setNumberOfRegions, setPresets, setRegionsOfInterest, setSequence, startAcquisition, stopAcquisition

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.device.detector.analyser.IEpicsMCA

clearWaitForCompletion, eraseStartAcquisition, getDwellTime, setDwellTime

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

getNthRegionOfInterest

EpicsMCARegionOfInterest getNthRegionOfInterest(int regionIndex)
                                         throws DeviceException

Get specified region of interest

Parameters:

regionIndex - Index of the ROI required

Returns:

a representation of the ROI

Throws:

DeviceException

setRegionsOfInterest

void setRegionsOfInterest(EpicsMCARegionOfInterest[] epicsMcaRois)
                   throws DeviceException

Set the regions of interest for the MCA

Parameters:

epicsMcaRois - The ROIs to set

Throws:

DeviceException

setCalibration

void setCalibration(EpicsMCACalibration calibrate)
             throws DeviceException

sets calibration fields for MCA

Parameters:

calibrate - The calibration fields

Throws:

DeviceException

getRoiCount

double getRoiCount(int index)
            throws DeviceException

Counts for the specified channel

Parameters:

index - Index of the channel

Returns:

counts for this channel

Throws:

DeviceException

getRoiNetCount

double getRoiNetCount(int index)
               throws DeviceException

Net counts for the specified ROI

Parameters:

index - Index of the ROI required

Returns:

Counts for this ROI

Throws:

DeviceException

setMcaPV

void setMcaPV(String mcaPV)

Set PV for the MCA

Parameters:

mcaPV -