Package gda.device.detector.xmap.edxd

Class EDXDController

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.xmap.edxd.EDXDController

All Implemented Interfaces:

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

Direct Known Subclasses:

EDXDControllerQMap, EDXDMappingController

public class EDXDController
extends DetectorBase

This class describes an EDXD detector made up of multiple subdetectors, as specified by numberOfElements

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EDXDController.COLLECTION_MODES
static enum	EDXDController.NEXUS_FILE_MODE
static enum	EDXDController.PIXEL_ADVANCE_MODE
static enum	EDXDController.PRESET_TYPES

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ACQUIRE
protected static final String	ACQUIRING
protected DeviceException	collectDataException
protected static final String	GETDYNRANGE
protected static final String	GETDYNRANGE0
protected static final String	GETNBINS
protected static final String	GETPRESETTYPE
protected static final String	GETPRESETVALUE
protected int	numberOfElements
protected static final String	SCAACTIVATE
protected static final String	SCAELEMENTS
protected static final String	SETBINWIDTH
protected static final String	SETDYNRANGE
protected static final String	SETNBINS
protected static final String	SETPRESETTYPE
protected static final String	SETPRESETVALUE
protected static final String	SETRESUME
protected final List<IEDXDElement>	subDetectors
protected IFindableEpicsDevice	xmap

Fields inherited from class gda.device.detector.DetectorBase

collectionTime

Fields inherited from class gda.device.scannable.ScannableBase

__doc__, DEFAULT_INPUT_NAME, DEFAULT_OUTPUT_FORMAT, extraNames, inputNames, level, outputFormat

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

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

Constructor Summary

Constructors

Constructor	Description
EDXDController()

Method Summary

Modifier and Type	Method	Description
void	activateROI()	Activate the ROI mode in the controller
protected void	addElements()
void	collectData()	Tells the detector to begin to collect a set of data, then returns immediately.
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.
boolean	createsOwnFiles()	Returns a value which indicates whether the detector creates its own files.
void	deactivateROI()	Disable the ROI mode in the Controller
double	getAcquisitionTime()	Get the acquisition/collection/preset time in the hardware
int	getBins()
double[]	getData(int mcaNumber)	read the data from the specified mca element
String	getDescription()
String	getDetectorID()
String	getDetectorType()
int	getEvents(int mcaNumber)	Read the counts from the sub detector
double	getICR(int mcaNumber)
int	getMaxAllowedROIs()	get the maximum number of ROI allowed per mca element
int	getNumberOfElements()	Get the number of the mca elements attached to the controller
double	getOCR(int mcaNumber)
int	getPresetType()	Get the acquisition mode in the hardware
int	getStatus()	Returns the current collecting state of the device.
IEDXDElement	getSubDetector(int index)	Get one of the elements specifialy by name
IFindableEpicsDevice	getXmap()
String	listSettings()	This method shows all the savefiles for the EDXD detector
String	loadSettings(String name)	Loads a setting from the persistance
Object	readout()	Returns the latest data collected.
void	reconfigure()	Re-initialisation of values and states.
void	saveCurrentSettings(String name)	Save all the xmap settings, with no description
void	saveCurrentSettings(String name, String description)	Save all the xmap settings along with the given description
void	setAquisitionTime(double collectionTime)	set the acquisition/collection/preset time in the controller
void	setBaseLength(int baseLength)	Set the baseLength for all elements
void	setBaseThreshold(double baseThreshold)	Set the baseThreshold for all elements
int	setBins(int numberOfBins)	Sets the number of bins that are used by the xmap.
void	setBinWidth(double binWidth)	Sets the energy per bin
double	setDynamicRange(double dynamicRange)	Sets the dynamic range of the detector
void	setEnergyThreshold(double energyThreshold)	Set the energyThreshold for all elements
void	setGapTime(double gapTime)	Set the gapTime for all elements
void	setMaxWidth(double maxWidth)	Set the maxWidth for all elements
void	setNumberOfElements(int numberOfElements)	Set the number of mca elements attached to the controller
void	setPeakTime(double peakTime)	Set the peakTime for all elements
void	setPreampGain(double preampGain)	Set the preampGain for all elements
void	setPresetType(EDXDController.PRESET_TYPES mode)	set the acquisition mode defined in PRESET_MODES in the controller
void	setResetDelay(double resetDelay)	Set the resetDelay for all elements
void	setResume(boolean resume)	Controller has two modes of operation.
void	setTriggerGapTime(double triggerGapTime)	Set the triggerGapTime for all elements
void	setTriggerPeakTime(double triggerPeakTime)	Set the triggerPeakTime for all elements
void	setTriggerThreshold(double triggerThreshold)	Set the triggerThreshold for all elements
void	setup(double maxEnergy, int numberOfBins)	Simple method which sets up the EDXD with some basic assumptions
void	setXmap(IFindableEpicsDevice xmap)
void	start()	Start data acquisition in the controller.
void	stop()	Stop the current move/operation.
void	verifyData()	Check for any exception during data collection

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, getCollectionTime, getDataDimensions, getPosition, isBusy, prepareForCollection, setCollectionTime, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

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

isConfigureAtStartup, isConfigured

Methods inherited from interface gda.device.Detector

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

atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes

Field Details

numberOfElements

protected int numberOfElements

xmap

protected IFindableEpicsDevice xmap

subDetectors

protected final List<IEDXDElement> subDetectors

collectDataException

protected DeviceException collectDataException

ACQUIRE

protected static final String ACQUIRE

See Also:

• Constant Field Values

ACQUIRING

protected static final String ACQUIRING

See Also:

• Constant Field Values

GETDYNRANGE

protected static final String GETDYNRANGE

See Also:

• Constant Field Values

GETDYNRANGE0

protected static final String GETDYNRANGE0

See Also:

• Constant Field Values

GETNBINS

protected static final String GETNBINS

See Also:

• Constant Field Values

GETPRESETTYPE

protected static final String GETPRESETTYPE

See Also:

• Constant Field Values

GETPRESETVALUE

protected static final String GETPRESETVALUE

See Also:

• Constant Field Values

SETRESUME

protected static final String SETRESUME

See Also:

• Constant Field Values

SCAACTIVATE

protected static final String SCAACTIVATE

See Also:

• Constant Field Values

SCAELEMENTS

protected static final String SCAELEMENTS

See Also:

• Constant Field Values

SETBINWIDTH

protected static final String SETBINWIDTH

See Also:

• Constant Field Values

SETDYNRANGE

protected static final String SETDYNRANGE

See Also:

• Constant Field Values

SETNBINS

protected static final String SETNBINS

See Also:

• Constant Field Values

SETPRESETTYPE

protected static final String SETPRESETTYPE

See Also:

• Constant Field Values

SETPRESETVALUE

protected static final String SETPRESETVALUE

See Also:

• Constant Field Values

Constructor Details

EDXDController

public EDXDController()

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

addElements

protected void addElements()

reconfigure

public void reconfigure()
                 throws FactoryException

Description copied from interface: Configurable

Re-initialisation of values and states.

Moved from Reconfigurable which has been deleted

Specified by:

reconfigure in interface Configurable

Overrides:

reconfigure in class ConfigurableBase

Throws:

FactoryException

collectData

public void collectData()
                 throws DeviceException

Description copied from interface: Detector

Tells the detector to begin to collect a set of data, then returns immediately. Should cause the hardware to start collecting immediately: if there is any delay then detectors used in the same scan would collect over different times when beam conditions may differ.

Throws:

DeviceException

getDescription

public String getDescription()
                      throws DeviceException

Specified by:

getDescription in interface Detector

Overrides:

getDescription in class DetectorBase

Returns:

A description of the detector.

Throws:

DeviceException

getDetectorID

public String getDetectorID()
                     throws DeviceException

Specified by:

getDetectorID in interface Detector

Overrides:

getDetectorID in class DetectorBase

Returns:

A identifier for this detector.

Throws:

DeviceException

getDetectorType

public String getDetectorType()
                       throws DeviceException

Specified by:

getDetectorType in interface Detector

Overrides:

getDetectorType in class DetectorBase

Returns:

The type of detector.

Throws:

DeviceException

getStatus

public int getStatus()
              throws DeviceException

Description copied from interface: Detector

Returns the current collecting state of the device.

Returns:

BUSY if the detector has not finished the requested operation(s), IDLE if in an completely idle state and STANDBY if temporarily suspended.

Throws:

DeviceException

getAcquisitionTime

public double getAcquisitionTime()
                          throws DeviceException

Get the acquisition/collection/preset time in the hardware

Returns:

collection time

Throws:

DeviceException

getPresetType

public int getPresetType()
                  throws DeviceException

Get the acquisition mode in the hardware

Returns:

mode

Throws:

DeviceException

createsOwnFiles

public boolean createsOwnFiles()
                        throws DeviceException

Description copied from interface: Detector

Returns a value which indicates whether the detector creates its own files. If it does (return true) the readout() method returns the name of the latest file created as a string. If it does not (return false) the readout() method will return the data directly.

Returns:

true if readout() returns filenames

Throws:

DeviceException

verifyData

public void verifyData()
                throws DeviceException

Check for any exception during data collection

Throws:

DeviceException

getNumberOfElements

public int getNumberOfElements()

Get the number of the mca elements attached to the controller

Returns:

number of mca elements

setNumberOfElements

public void setNumberOfElements(int numberOfElements)

Set the number of mca elements attached to the controller

Parameters:

numberOfElements -

setBins

public int setBins(int numberOfBins)
            throws DeviceException

Sets the number of bins that are used by the xmap.

Parameters:

numberOfBins - a number up to 16k

Returns:

the number of bins which are actualy set.

Throws:

DeviceException

getBins

public int getBins()
            throws DeviceException

Returns:

The number of bins the xmap is curently set to

Throws:

DeviceException

setDynamicRange

public double setDynamicRange(double dynamicRange)
                       throws DeviceException

Sets the dynamic range of the detector

Parameters:

dynamicRange - the dynamic range in KeV

Returns:

the actual value which has been set

Throws:

DeviceException

setBinWidth

public void setBinWidth(double binWidth)
                 throws DeviceException

Sets the energy per bin

Parameters:

binWidth - in eV

Throws:

DeviceException

setup

public void setup(double maxEnergy,
 int numberOfBins)
           throws DeviceException

Simple method which sets up the EDXD with some basic assumptions

Parameters:

maxEnergy - The maxim energy expected in KeV

numberOfBins - the number of bins that are wanted, i.e the resolution

Throws:

DeviceException

saveCurrentSettings

public void saveCurrentSettings(String name)
                         throws ObjectShelfException,
LocalDatabase.LocalDatabaseException,
DeviceException

Save all the xmap settings, with no description

Parameters:

name -

Throws:

ObjectShelfException

LocalDatabase.LocalDatabaseException

DeviceException

saveCurrentSettings

public void saveCurrentSettings(String name,
 String description)
                         throws ObjectShelfException,
LocalDatabase.LocalDatabaseException,
DeviceException

Save all the xmap settings along with the given description

Parameters:

name -

description -

Throws:

ObjectShelfException

LocalDatabase.LocalDatabaseException

DeviceException

loadSettings

public String loadSettings(String name)
                    throws DeviceException,
ObjectShelfException,
LocalDatabase.LocalDatabaseException

Loads a setting from the persistance

Parameters:

name -

Returns:

The description of the configuration loaded

Throws:

DeviceException

ObjectShelfException

LocalDatabase.LocalDatabaseException

listSettings

public String listSettings()
                    throws ObjectShelfException,
LocalDatabase.LocalDatabaseException

This method shows all the savefiles for the EDXD detector

Returns:

a string containing all the files

Throws:

LocalDatabase.LocalDatabaseException

ObjectShelfException

LocalDatabase.LocalDatabaseException

ObjectShelfException

setPreampGain

public void setPreampGain(double preampGain)
                   throws DeviceException

Set the preampGain for all elements

Parameters:

preampGain -

Throws:

DeviceException

setPeakTime

public void setPeakTime(double peakTime)
                 throws DeviceException

Set the peakTime for all elements

Parameters:

peakTime -

Throws:

DeviceException

setTriggerThreshold

public void setTriggerThreshold(double triggerThreshold)
                         throws DeviceException

Set the triggerThreshold for all elements

Parameters:

triggerThreshold -

Throws:

DeviceException

setBaseThreshold

public void setBaseThreshold(double baseThreshold)
                      throws DeviceException

Set the baseThreshold for all elements

Parameters:

baseThreshold -

Throws:

DeviceException

setBaseLength

public void setBaseLength(int baseLength)
                   throws DeviceException

Set the baseLength for all elements

Parameters:

baseLength -

Throws:

DeviceException

setEnergyThreshold

public void setEnergyThreshold(double energyThreshold)
                        throws DeviceException

Set the energyThreshold for all elements

Parameters:

energyThreshold -

Throws:

DeviceException

setResetDelay

public void setResetDelay(double resetDelay)
                   throws DeviceException

Set the resetDelay for all elements

Parameters:

resetDelay -

Throws:

DeviceException

setGapTime

public void setGapTime(double gapTime)
                throws DeviceException

Set the gapTime for all elements

Parameters:

gapTime -

Throws:

DeviceException

setTriggerPeakTime

public void setTriggerPeakTime(double triggerPeakTime)
                        throws DeviceException

Set the triggerPeakTime for all elements

Parameters:

triggerPeakTime -

Throws:

DeviceException

setTriggerGapTime

public void setTriggerGapTime(double triggerGapTime)
                       throws DeviceException

Set the triggerGapTime for all elements

Parameters:

triggerGapTime -

Throws:

DeviceException

setMaxWidth

public void setMaxWidth(double maxWidth)
                 throws DeviceException

Set the maxWidth for all elements

Parameters:

maxWidth -

Throws:

DeviceException

getSubDetector

public IEDXDElement getSubDetector(int index)

Get one of the elements specifialy by name

Parameters:

index -

Returns:

An the EDXDElement requested

setResume

public void setResume(boolean resume)
               throws DeviceException

Controller has two modes of operation. clear on start or resume acquiring into the same spectrum

Parameters:

resume -

Throws:

DeviceException

getData

public double[] getData(int mcaNumber)
                 throws DeviceException

read the data from the specified mca element

Parameters:

mcaNumber -

Returns:

data array

Throws:

DeviceException

setAquisitionTime

public void setAquisitionTime(double collectionTime)
                       throws DeviceException

set the acquisition/collection/preset time in the controller

Parameters:

collectionTime -

Throws:

DeviceException

setPresetType

public void setPresetType(EDXDController.PRESET_TYPES mode)
                   throws DeviceException

set the acquisition mode defined in PRESET_MODES in the controller

Parameters:

mode -

Throws:

DeviceException

start

public void start()
           throws DeviceException

Start data acquisition in the controller. Uses the existing resume mode

Throws:

DeviceException

stop

public void stop()
          throws DeviceException

Description copied from class: ScannableBase

Stop the current move/operation. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

stop in interface Scannable

Overrides:

stop in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.stop()

activateROI

public void activateROI()
                 throws DeviceException

Activate the ROI mode in the controller

Throws:

DeviceException

deactivateROI

public void deactivateROI()
                   throws DeviceException

Disable the ROI mode in the Controller

Throws:

DeviceException

getMaxAllowedROIs

public int getMaxAllowedROIs()
                      throws DeviceException

get the maximum number of ROI allowed per mca element

Returns:

number of rois

Throws:

DeviceException

readout

public Object readout()
               throws DeviceException

Description copied from interface: Detector

Returns the latest data collected. The size of the Object returned must be consistent with the values returned by getDataDimensions and getExtraNames.

If LocalProperties.GDA_SCAN_CONCURRENTSCAN_READOUT_CONCURRENTLY is true then motors may be moved while the detector readouts. The value returned must not be effected by any concurrent motor or shutter movements. See Detector.waitWhileBusy() and ConcurrentScan. Readout must block until the detector is ready to respond quickly to Detector.collectData() again.

Returns:

the data collected

Throws:

DeviceException

getEvents

public int getEvents(int mcaNumber)
              throws DeviceException

Read the counts from the sub detector

Parameters:

mcaNumber -

Returns:

data array

Throws:

DeviceException

getICR

public double getICR(int mcaNumber)
              throws DeviceException

Throws:

DeviceException

getOCR

public double getOCR(int mcaNumber)
              throws DeviceException

Throws:

DeviceException

getXmap

public IFindableEpicsDevice getXmap()

setXmap

public void setXmap(IFindableEpicsDevice xmap)