Package gda.device.detector.xmap.edxd

Class EDXDMappingController

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

gda.device.detector.xmap.edxd.EDXDMappingController

All Implemented Interfaces:

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

Direct Known Subclasses:

DummyXmapEDXDMappingController

public class EDXDMappingController
extends EDXDController
implements IEDXDMappingController

This class describes the EDXD detector on I12, it is made up of 24 subdetectors: EDXDMappingElement instances, each wrapping an EpicsMCASimple instance.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class gda.device.detector.xmap.edxd.EDXDController

EDXDController.COLLECTION_MODES, EDXDController.NEXUS_FILE_MODE, EDXDController.PIXEL_ADVANCE_MODE, EDXDController.PRESET_TYPES

Field Summary

Fields

Modifier and Type	Field	Description
protected NDFileHDF5	hdf5

Fields inherited from class gda.device.detector.xmap.edxd.EDXDController

ACQUIRE, ACQUIRING, collectDataException, GETDYNRANGE, GETDYNRANGE0, GETNBINS, GETPRESETTYPE, GETPRESETVALUE, numberOfElements, SCAACTIVATE, SCAELEMENTS, SETBINWIDTH, SETDYNRANGE, SETNBINS, SETPRESETTYPE, SETPRESETVALUE, SETRESUME, subDetectors, 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
EDXDMappingController()

Method Summary

Modifier and Type	Method	Description
void	activateROI()	Activate the ROI mode in the controller
protected void	addElements()
void	clear()
void	clearAndStart()
void	deactivateROI()	Disable the ROI mode in the Controller
void	endRecording()
boolean	getAquisitionTimeOn()
boolean	getCaptureStatus()
int	getCaputSleepTime()
int	getElementOffset()
int	getFileNumber()
NDFileHDF5	getHdf5()
String	getHDFFileName()
int	getMaxAllowedROIs()	get the maximum number of ROI allowed per mca element
String	getNexusFileName()
String	getNexusFilePath()
int	getPixelsPerRun()
boolean	isBufferedArrayPort()
boolean	isStopUpdatesMcaPvRecord()
boolean	isWaitAfterCaput()
void	resetCounters()
void	setAquisitionTime(double collectionTime)	set the acquisition/collection/preset time in the controller
void	setAquisitionTimeOn(boolean aquisitionTimeOn)
void	setAutoPixelsPerBuffer(boolean auto)
void	setCallback(boolean yes)
void	setCaputSleepTime(int sleepTimeMillis)	Sleep time to use after doing CAput operation in setXmapValue function (milliseconds)
void	setCollectionMode(EDXDController.COLLECTION_MODES mode)
void	setDirectory(String dataDir)
double	setDynamicRange(double dynamicRange)	Sets the dynamic range of the detector
void	setElementOffset(int elementOffset)
void	setFilenamePostfix(String name)
void	setFilenamePrefix(String beamline)
void	setFileNumber(Number scanNumber)
void	setFileWriteMode(EDXDController.NEXUS_FILE_MODE mode)
void	setHdf5(NDFileHDF5 hdf5)
void	setHdfNumCapture(int number)
void	setIgnoreGate(boolean yes)
void	setNexusCapture(int number)
void	setNexusFileFormat(String format)
void	setNexusFileName(String filename)
void	setNexusFilePath(String filepath)
void	setPixelAdvanceMode(EDXDController.PIXEL_ADVANCE_MODE mode)
void	setPixelsPerBuffer(int number)
void	setPixelsPerRun(int number)
void	setResume(boolean resume)	Controller has two modes of operation.
void	setStopUpdatesMcaPvRecord(boolean stopUpdatesMcaPvRecord)	If set to true, MCA PV record will be updated when stop() function is called.
void	setTemplateFileName(String templateFileName)
void	setTemplateFilePath(String tempFilePath)
void	setWaitAfterCaput(boolean usePutWait)	If set to true, then start(), stop(), setResume(boolean), clear() and clearAndStart() will wait for a short time after doing their CAput operations.
void	start()	Start data acquisition in the controller.
void	startRecording()
void	stop()	Stop the current move/operation.
void	updateMcaPvRecord(int mcaNumber)	Update the MCA PV record for detector element, by doing caput READ = 1 and waiting for the RDNG status to be 'Done'.
void	updateMcaPvRecords()

Methods inherited from class gda.device.detector.xmap.edxd.EDXDController

collectData, configure, createsOwnFiles, getAcquisitionTime, getBins, getData, getDescription, getDetectorID, getDetectorType, getEvents, getICR, getNumberOfElements, getOCR, getPresetType, getStatus, getSubDetector, getXmap, listSettings, loadSettings, readout, reconfigure, saveCurrentSettings, saveCurrentSettings, setBaseLength, setBaseThreshold, setBins, setBinWidth, setEnergyThreshold, setGapTime, setMaxWidth, setNumberOfElements, setPeakTime, setPreampGain, setPresetType, setResetDelay, setTriggerGapTime, setTriggerPeakTime, setTriggerThreshold, setup, setXmap, verifyData

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.device.detector.xmap.edxd.IEDXDMappingController

setPresetType

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

hdf5

protected NDFileHDF5 hdf5

Constructor Details

EDXDMappingController

public EDXDMappingController()

Method Details

addElements

protected void addElements()

Overrides:

addElements in class EDXDController

setDynamicRange

public double setDynamicRange(double dynamicRange)
                       throws DeviceException

Sets the dynamic range of the detector

Overrides:

setDynamicRange in class EDXDController

Parameters:

dynamicRange - the dynamic range in KeV

Returns:

the actual value which has been set

Throws:

DeviceException

getMaxAllowedROIs

public int getMaxAllowedROIs()
                      throws DeviceException

get the maximum number of ROI allowed per mca element

Overrides:

getMaxAllowedROIs in class EDXDController

Returns:

number of rois

Throws:

DeviceException

activateROI

public void activateROI()
                 throws DeviceException

Activate the ROI mode in the controller

Overrides:

activateROI in class EDXDController

Throws:

DeviceException

deactivateROI

public void deactivateROI()
                   throws DeviceException

Disable the ROI mode in the Controller

Overrides:

deactivateROI in class EDXDController

Throws:

DeviceException

start

public void start()
           throws DeviceException

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

Overrides:

start in class EDXDController

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 EDXDController

Throws:

DeviceException

See Also:

• Scannable.stop()

setResume

public void setResume(boolean resume)
               throws DeviceException

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

Overrides:

setResume in class EDXDController

Parameters:

resume -

Throws:

DeviceException

clear

public void clear()
           throws DeviceException

Throws:

DeviceException

clearAndStart

public void clearAndStart()
                   throws DeviceException

Throws:

DeviceException

setCollectionMode

public void setCollectionMode(EDXDController.COLLECTION_MODES mode)
                       throws DeviceException

Specified by:

setCollectionMode in interface IEDXDMappingController

Throws:

DeviceException

setAquisitionTime

public void setAquisitionTime(double collectionTime)
                       throws DeviceException

Description copied from class: EDXDController

set the acquisition/collection/preset time in the controller

Overrides:

setAquisitionTime in class EDXDController

Parameters:

collectionTime -

Throws:

DeviceException

setPixelAdvanceMode

public void setPixelAdvanceMode(EDXDController.PIXEL_ADVANCE_MODE mode)
                         throws DeviceException

Throws:

DeviceException

setIgnoreGate

public void setIgnoreGate(boolean yes)
                   throws DeviceException

Specified by:

setIgnoreGate in interface IEDXDMappingController

Throws:

DeviceException

setAutoPixelsPerBuffer

public void setAutoPixelsPerBuffer(boolean auto)
                            throws DeviceException

Throws:

DeviceException

setPixelsPerBuffer

public void setPixelsPerBuffer(int number)
                        throws DeviceException

Throws:

DeviceException

setPixelsPerRun

public void setPixelsPerRun(int number)
                     throws DeviceException

Throws:

DeviceException

getPixelsPerRun

public int getPixelsPerRun()
                    throws DeviceException

Throws:

DeviceException

resetCounters

public void resetCounters()
                   throws Exception

Throws:

Exception

startRecording

public void startRecording()
                    throws Exception

Throws:

Exception

endRecording

public void endRecording()
                  throws Exception

Throws:

Exception

getHDFFileName

public String getHDFFileName()
                      throws Exception

Throws:

Exception

setDirectory

public void setDirectory(String dataDir)
                  throws Exception

Throws:

Exception

setFileNumber

public void setFileNumber(Number scanNumber)
                   throws Exception

Throws:

Exception

setFilenamePrefix

public void setFilenamePrefix(String beamline)
                       throws Exception

Throws:

Exception

setFilenamePostfix

public void setFilenamePostfix(String name)
                        throws Exception

Throws:

Exception

setNexusCapture

public void setNexusCapture(int number)
                     throws DeviceException

Throws:

DeviceException

setHdfNumCapture

public void setHdfNumCapture(int number)
                      throws DeviceException

Throws:

DeviceException

setNexusFileFormat

public void setNexusFileFormat(String format)
                        throws DeviceException

Throws:

DeviceException

setFileWriteMode

public void setFileWriteMode(EDXDController.NEXUS_FILE_MODE mode)
                      throws DeviceException

Throws:

DeviceException

setCallback

public void setCallback(boolean yes)
                 throws DeviceException

Throws:

DeviceException

setNexusFileName

public void setNexusFileName(String filename)
                      throws DeviceException

Throws:

DeviceException

getNexusFileName

public String getNexusFileName()
                        throws DeviceException

Throws:

DeviceException

getNexusFilePath

public String getNexusFilePath()
                        throws DeviceException

Throws:

DeviceException

setNexusFilePath

public void setNexusFilePath(String filepath)
                      throws DeviceException

Throws:

DeviceException

getFileNumber

public int getFileNumber()
                  throws DeviceException

Throws:

DeviceException

setTemplateFileName

public void setTemplateFileName(String templateFileName)
                         throws DeviceException

Throws:

DeviceException

setTemplateFilePath

public void setTemplateFilePath(String tempFilePath)
                         throws DeviceException

Throws:

DeviceException

getCaptureStatus

public boolean getCaptureStatus()

isBufferedArrayPort

public boolean isBufferedArrayPort()
                            throws Exception

Throws:

Exception

getHdf5

public NDFileHDF5 getHdf5()

setHdf5

public void setHdf5(NDFileHDF5 hdf5)

getElementOffset

public int getElementOffset()

setElementOffset

public void setElementOffset(int elementOffset)

getAquisitionTimeOn

public boolean getAquisitionTimeOn()

setAquisitionTimeOn

public void setAquisitionTimeOn(boolean aquisitionTimeOn)

setCaputSleepTime

public void setCaputSleepTime(int sleepTimeMillis)

Sleep time to use after doing CAput operation in setXmapValue function (milliseconds)

Parameters:

sleepTimeMillis -

See Also:

• setWaitAfterCaput(boolean)

getCaputSleepTime

public int getCaputSleepTime()

isWaitAfterCaput

public boolean isWaitAfterCaput()

setWaitAfterCaput

public void setWaitAfterCaput(boolean usePutWait)

If set to true, then start(), stop(), setResume(boolean), clear() and clearAndStart() will wait for a short time after doing their CAput operations. Wait time is set by setCaputSleepTime(int).

Parameters:

usePutWait -

updateMcaPvRecords

public void updateMcaPvRecords()

updateMcaPvRecord

public void updateMcaPvRecord(int mcaNumber)
                       throws DeviceException,
InterruptedException,
IOException

Update the MCA PV record for detector element, by doing caput READ = 1 and waiting for the RDNG status to be 'Done'. Waiting is done in a loop with 100ms pause at end of each one; if RDNG != 0 after 30 attempts loops, error is put into log.

Parameters:

mcaNumber -

Throws:

InterruptedException

IOException

DeviceException

isStopUpdatesMcaPvRecord

public boolean isStopUpdatesMcaPvRecord()

setStopUpdatesMcaPvRecord

public void setStopUpdatesMcaPvRecord(boolean stopUpdatesMcaPvRecord)

If set to true, MCA PV record will be updated when stop() function is called.

Parameters:

stopUpdatesMcaPvRecord -