Package gda.device.detector.xmap.edxd

Interface IEDXDElement

All Superinterfaces:

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

All Known Implementing Classes:

EDXDElement, EDXDMappingElement

public interface IEDXDElement
extends Detector, INeXusInfoWriteable

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	fitPolynomialToEnergyData(double[] actual, double[] reported)	The point of this function is to fit a curve to the data collected from a calibration Sample
int	getBaseLength()
double	getBaseThreshold()
double	getBinWidth()
double	getDynamicRange()
double[]	getEnergyBins()
double	getEnergyLiveTime()
double[]	getEnergyMapping()
double	getEnergyThreshold()
int	getEvents()
double	getGapTime()
double[]	getHighROIs()	get the roi High limit
double	getInputCountRate()
double[]	getLowROIs()	get the roi low limit
double	getMaxWidth()
double	getOutputCountRate()
double	getPeakTime()
double	getPreampGain()
double[]	getQMapping()
double	getRealTime()
double	getResetDelay()
double[]	getROICounts()	get the counts for all rois set
double	getTriggerGapTime()
double	getTriggerLiveTime()	the trigger live time
double	getTriggerPeakTime()
double	getTriggerThreshold()
boolean	isQMapped()	Shows whether the element is q-mapped
void	loadConfiguration(EDXDElementBean bean)	Sets all the xmap values from the values in the provided bean
double[]	readoutDoubles()
int[]	readoutInts()
EDXDElementBean	saveConfiguration()
int	setBaseLength(int baseLength)	sets the Base Length
double	setBaseThreshold(double baseThreshold)	sets the base threshold
double	setBinWidth(double binWidth)	sets the bin width
double	setDynamicRange(double dynamicRange)	sets the dynamic range
double	setEnergyThreshold(double energyThreshold)	sets the energy threshold
double	setGapTime(double gapTime)	Sets the gap time
void	setHighROIs(double[] roiHigh)	Set the roi high limit
void	setLowROIs(double[] roiLow)	Sets the ROI low limit
double	setMaxWidth(double maxWidth)	sets the max width
double	setPeakTime(double peakTime)	Sets the peak time
double	setPreampGain(double preampGain)	sets the preamp gain
void	setQMapping(double[] q)	Set the q mapping directly
double	setResetDelay(double resetDelay)	Sets the reset delay
void	setROIs(double[][] rois)	Set rois the array must be of size [maximum number rois][2]
double	setTriggerGapTime(double triggerGapTime)	sets the trigger gap time
double	setTriggerPeakTime(double triggerPeakTime)	sets teh trigger peak time
double	setTriggerThreshold(double triggerThreshold)	sets the trigger threshold

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.data.nexus.INeXusInfoWriteable

writeNeXusInformation

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

getEnergyLiveTime

double getEnergyLiveTime()
                  throws DeviceException

Returns:

the energy live time

Throws:

DeviceException

getTriggerLiveTime

double getTriggerLiveTime()
                   throws DeviceException

the trigger live time

Returns:

the reported trigger live time

Throws:

DeviceException

getRealTime

double getRealTime()
            throws DeviceException

Returns:

the real time

Throws:

DeviceException

getEvents

int getEvents()
       throws DeviceException

Returns:

the number of events

Throws:

DeviceException

getInputCountRate

double getInputCountRate()
                  throws DeviceException

Returns:

the input count rate

Throws:

DeviceException

getOutputCountRate

double getOutputCountRate()
                   throws DeviceException

Returns:

The output count rate

Throws:

DeviceException

getEnergyBins

double[] getEnergyBins()
                throws DeviceException

Returns:

a double array containing the energy value per bin on the outputed data

Throws:

DeviceException

getPeakTime

double getPeakTime()
            throws DeviceException

Returns:

the peak time

Throws:

DeviceException

setPeakTime

double setPeakTime(double peakTime)
            throws DeviceException

Sets the peak time

Parameters:

peakTime -

Returns:

the peaktime as it is reported

Throws:

DeviceException

getDynamicRange

double getDynamicRange()
                throws DeviceException

Returns:

the dynamic range

Throws:

DeviceException

setDynamicRange

double setDynamicRange(double dynamicRange)
                throws DeviceException

sets the dynamic range

Parameters:

dynamicRange -

Returns:

the dynamic range as it is reported

Throws:

DeviceException

getTriggerThreshold

double getTriggerThreshold()
                    throws DeviceException

Returns:

The trigger threshold

Throws:

DeviceException

setTriggerThreshold

double setTriggerThreshold(double triggerThreshold)
                    throws DeviceException

sets the trigger threshold

Parameters:

triggerThreshold -

Returns:

the trigger threshold as it is reported

Throws:

DeviceException

getBaseThreshold

double getBaseThreshold()
                 throws DeviceException

Returns:

the base threshold

Throws:

DeviceException

setBaseThreshold

double setBaseThreshold(double baseThreshold)
                 throws DeviceException

sets the base threshold

Parameters:

baseThreshold -

Returns:

the base threshold as reported

Throws:

DeviceException

getBaseLength

int getBaseLength()
           throws DeviceException

Returns:

The base length

Throws:

DeviceException

setBaseLength

int setBaseLength(int baseLength)
           throws DeviceException

sets the Base Length

Parameters:

baseLength -

Returns:

the base length as it is reported

Throws:

DeviceException

getEnergyThreshold

double getEnergyThreshold()
                   throws DeviceException

Returns:

the energy threshold

Throws:

DeviceException

setEnergyThreshold

double setEnergyThreshold(double energyThreshold)
                   throws DeviceException

sets the energy threshold

Parameters:

energyThreshold -

Returns:

the energy threshold

Throws:

DeviceException

getBinWidth

double getBinWidth()
            throws DeviceException

Returns:

the bin width

Throws:

DeviceException

setBinWidth

double setBinWidth(double binWidth)
            throws DeviceException

sets the bin width

Parameters:

binWidth -

Returns:

the bin width as reported

Throws:

DeviceException

getPreampGain

double getPreampGain()
              throws DeviceException

Returns:

the preamp gain

Throws:

DeviceException

setPreampGain

double setPreampGain(double preampGain)
              throws DeviceException

sets the preamp gain

Parameters:

preampGain -

Returns:

the preamp gain as reported

Throws:

DeviceException

getResetDelay

double getResetDelay()
              throws DeviceException

Returns:

the reset delay

Throws:

DeviceException

setResetDelay

double setResetDelay(double resetDelay)
              throws DeviceException

Sets the reset delay

Parameters:

resetDelay -

Returns:

the reset delay as reported

Throws:

DeviceException

getGapTime

double getGapTime()
           throws DeviceException

Returns:

The gap time

Throws:

DeviceException

setGapTime

double setGapTime(double gapTime)
           throws DeviceException

Sets the gap time

Parameters:

gapTime -

Returns:

the gap time as reported

Throws:

DeviceException

getTriggerPeakTime

double getTriggerPeakTime()
                   throws DeviceException

Returns:

the trigger peak time

Throws:

DeviceException

setTriggerPeakTime

double setTriggerPeakTime(double triggerPeakTime)
                   throws DeviceException

sets teh trigger peak time

Parameters:

triggerPeakTime -

Returns:

the trigger peak time as reported

Throws:

DeviceException

getTriggerGapTime

double getTriggerGapTime()
                  throws DeviceException

Returns:

the trigger gap time

Throws:

DeviceException

setTriggerGapTime

double setTriggerGapTime(double triggerGapTime)
                  throws DeviceException

sets the trigger gap time

Parameters:

triggerGapTime -

Returns:

the reported trigger gap time

Throws:

DeviceException

getMaxWidth

double getMaxWidth()
            throws DeviceException

Returns:

the max width

Throws:

DeviceException

setMaxWidth

double setMaxWidth(double maxWidth)
            throws DeviceException

sets the max width

Parameters:

maxWidth -

Returns:

the reported max width

Throws:

DeviceException

readoutDoubles

double[] readoutDoubles()
                 throws DeviceException

Returns:

the double array of data from the xmap

Throws:

DeviceException

readoutInts

int[] readoutInts()
           throws DeviceException

Returns:

the double array of data from the xmap

Throws:

DeviceException

getEnergyMapping

double[] getEnergyMapping()
                   throws DeviceException

Returns:

the energy mapping

Throws:

DeviceException

getQMapping

double[] getQMapping()
              throws DeviceException

Returns:

the q mapping for the detector

Throws:

DeviceException

setQMapping

void setQMapping(double[] q)

Set the q mapping directly

Parameters:

q - the q mapping to set

isQMapped

boolean isQMapped()

Shows whether the element is q-mapped

Returns:

true if q mapped, false if not

fitPolynomialToEnergyData

void fitPolynomialToEnergyData(double[] actual,
 double[] reported)
                        throws Exception

The point of this function is to fit a curve to the data collected from a calibration Sample

Parameters:

actual -

reported -

Throws:

Exception

saveConfiguration

EDXDElementBean saveConfiguration()
                           throws DeviceException

Returns:

the configuration of this element in a bean

Throws:

DeviceException

loadConfiguration

void loadConfiguration(EDXDElementBean bean)
                throws DeviceException

Sets all the xmap values from the values in the provided bean

Parameters:

bean -

Throws:

DeviceException

setROIs

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

Set rois the array must be of size [maximum number rois][2]

Parameters:

rois -

Throws:

DeviceException

setLowROIs

void setLowROIs(double[] roiLow)
         throws DeviceException

Sets the ROI low limit

Parameters:

roiLow -

Throws:

DeviceException

getLowROIs

double[] getLowROIs()
             throws DeviceException

get the roi low limit

Returns:

roi low limit array

Throws:

DeviceException

setHighROIs

void setHighROIs(double[] roiHigh)
          throws DeviceException

Set the roi high limit

Parameters:

roiHigh -

Throws:

DeviceException

getHighROIs

double[] getHighROIs()
              throws DeviceException

get the roi High limit

Returns:

high limit array

Throws:

DeviceException

getROICounts

double[] getROICounts()
               throws DeviceException

get the counts for all rois set

Returns:

counts

Throws:

DeviceException