Package gda.device.detector.frelon

Class EdeFrelon

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.EdeDetectorBase

gda.device.detector.frelon.EdeFrelon

All Implemented Interfaces:

Detector, EdeDetector, FrelonDetector, NexusDetector, Device, Scannable, Configurable, Findable, gda.observable.IObservable, Serializable

@ServiceInterface(FrelonDetector.class)
public class EdeFrelon
extends EdeDetectorBase
implements FrelonDetector

See Also:

• Serialized Form

Field Summary

Fields inherited from class gda.device.detector.EdeDetectorBase

currentDetector, currentScanParameter, detectorData, dropFirstFrame

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

CALIBRATION_PROP_KEY, EXCLUDED_PIXELS_PROP_NAME, INITIAL_NO_OF_ROIS, ROIS_PROP_NAME

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
EdeFrelon()
EdeFrelon(Frelon frelon, LimaCCD limaCcd)

Method Summary

Modifier and Type	Method	Description
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.
void	configureDetectorForCollection()	Set kinetic ROI mode on the detector.
void	configureDetectorForROI(int verticalBinning, int ccdLineBegin)
void	configureDetectorForTimingGroup(TimingGroup group)
boolean	createsOwnFiles()	Returns a value which indicates whether the detector creates its own files.
void	fetchDetectorSettings()	to pull detector setting from detector server to synchronise the DetectorData object
DetectorStatus	fetchStatus()	fetch detector status from hardware.
double	getCollectionTime()	Returns the time, in seconds, the detector collects for during the next call to collectData()
String[]	getCurrentAttributesValues()
TimingGroup	getCurrentTimingGroup()
String	getDescription()
String	getDetectorID()
String	getDetectorType()
Frelon	getFrelon()
int	getLastImageAvailable()
LimaCCD	getLimaCcd()
int	getMaxPixel()	detector's maximum pixel size in energy direction.
int	getNumberOfSpectra()
int	getNumberScansInFrame()
int	getNumberScansInFrame(double expoTime, double accTime, int numberOfImages)	retrieve calculated accumulation number of frames per image from the detector.
String	getOrbitWaitMethod()
int	getRoiVerticalBinning()
int	getRoiVerticalStart()
int	getSynchroniseBeamOrbitDelay()
boolean	getSynchroniseToBeamOrbit()
HashMap<String,Double>	getTemperatures()
protected void	loadSettingsFromStore()
NexusTreeProvider	readout()	Reads the first frame only.
int[]	readoutFrames(int startFrame, int finalFrame)	implements the read out of frames from the actual detector used.
void	reconfigure()	Re-initialisation of values and states.
void	reset()	reset the camera to factory setting
void	resetLink()
protected void	saveSettingsToStore()
void	setAccumulationReadoutTime(double timeSec)	Set the accumulation readout time
void	setCollectionTime(double collectionTime)	Sets the collection time, in seconds, to be used during the next call of collectData.
void	setFrelon(Frelon frelon)
void	setKineticRoiMode()	Apply kinetic ROI mode and default vertical binning parameters to the Frelon.
void	setLimaCcd(LimaCCD limaCcd)
void	setNumberScansInFrame(int numScansInFrame)
void	setOrbitWaitMethod(String methodString)
void	setRoiMode(Frelon.ROIMode roiMode)	Set ROI mode on the DetectorData object along with other defaults : Spb2Config = Speed ImageMode = Full frame, Input channels = I3_4, Trigger mode = internal Horizontal binning = 1
void	setRoiVerticalBinning(int verticalBinning)
void	setRoiVerticalStart(int roiVerticalStart)
void	setSynchroniseBeamOrbitDelay(int synchroniseBeamOrbitDelay)
void	setSynchroniseToBeamOrbit(boolean synchroniseToBeamOrbit)
void	stop()	Stop the current move/operation.

Methods inherited from class gda.device.detector.EdeDetectorBase

atScanStart, createDatasetForPixel, getAccumulationReadoutTime, getCompressionLevel, getDetectorData, getDetectorSetupType, getEnergyCalibration, getEnergyForChannels, getExcludedPixels, getLowerChannel, getMaxNumFramesToRead, getNumberOfRois, getPixels, getRoiFor, getRois, getStatus, getUpperChannel, isCheckForExcludedStrips, isDropFirstFrame, isEnergyCalibrationSet, prepareDetectorwithScanParameters, readFrames, setCheckForExcludedStrips, setCompressionLevel, setDetectorData, setDetectorSetupType, setDropFirstFrame, setEnergyCalibration, setEnergyCalibrationSet, setExcludedPixels, setLowerChannel, setMaxNumFramesToRead, setNumberRois, setRois, setUpperChannel, unpackRawDataToFrames, writeLiveDataFile

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, getDataDimensions, getPosition, isBusy, prepareForCollection, 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, 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

endCollection, getDataDimensions, getFileStructure, getStatus, prepareForCollection, waitWhileBusy

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.device.detector.EdeDetector

createDatasetForPixel, getAccumulationReadoutTime, getDetectorData, getDetectorSetupType, getEnergyCalibration, getEnergyForChannels, getExcludedPixels, getLowerChannel, getMaxNumFramesToRead, getNumberOfRois, getPixels, getRoiFor, getRois, getUpperChannel, isDropFirstFrame, isEnergyCalibrationSet, prepareDetectorwithScanParameters, readFrames, setDetectorSetupType, setEnergyCalibration, setExcludedPixels, setLowerChannel, setNumberRois, setRois, setUpperChannel, writeLiveDataFile

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

Constructor Details

EdeFrelon

public EdeFrelon()

EdeFrelon

public EdeFrelon(Frelon frelon,
 LimaCCD limaCcd)

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 EdeDetectorBase

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

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

fetchDetectorSettings

public void fetchDetectorSettings()

Description copied from interface: EdeDetector

to pull detector setting from detector server to synchronise the DetectorData object

Specified by:

fetchDetectorSettings in interface EdeDetector

readout

public NexusTreeProvider readout()
                          throws DeviceException

Description copied from class: EdeDetectorBase

Reads the first frame only.

Specified by:

readout in interface Detector

Specified by:

readout in interface NexusDetector

Overrides:

readout in class EdeDetectorBase

Returns:

the data collected

Throws:

DeviceException

setKineticRoiMode

public void setKineticRoiMode()
                       throws DeviceException

Apply kinetic ROI mode and default vertical binning parameters to the Frelon.

Throws:

DeviceException

readoutFrames

public int[] readoutFrames(int startFrame,
 int finalFrame)
                    throws DeviceException

Description copied from class: EdeDetectorBase

implements the read out of frames from the actual detector used.

Specified by:

readoutFrames in interface EdeDetector

Specified by:

readoutFrames in class EdeDetectorBase

Parameters:

startFrame -

finalFrame -

Returns:

an 1D integer array containing all frames concatenated from start frame to the final frame inclusively.

Throws:

DeviceException

setCollectionTime

public void setCollectionTime(double collectionTime)
                       throws DeviceException

Description copied from interface: Detector

Sets the collection time, in seconds, to be used during the next call of collectData.

Specified by:

setCollectionTime in interface Detector

Overrides:

setCollectionTime in class DetectorBase

Parameters:

collectionTime - the collection time in seconds

Throws:

DeviceException

getCollectionTime

public double getCollectionTime()
                         throws DeviceException

Description copied from interface: Detector

Returns the time, in seconds, the detector collects for during the next call to collectData()

Specified by:

getCollectionTime in interface Detector

Overrides:

getCollectionTime in class DetectorBase

Returns:

double

Throws:

DeviceException

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.

Specified by:

collectData in interface Detector

Throws:

DeviceException

setRoiMode

public void setRoiMode(Frelon.ROIMode roiMode)

Set ROI mode on the DetectorData object along with other defaults :

Spb2Config = Speed

ImageMode = Full frame, Input channels = I3_4,

Trigger mode = internal

Horizontal binning = 1

Specified by:

setRoiMode in interface FrelonDetector

configureDetectorForROI

public void configureDetectorForROI(int verticalBinning,
 int ccdLineBegin)
                             throws DeviceException

Specified by:

configureDetectorForROI in interface EdeDetector

Throws:

DeviceException

configureDetectorForTimingGroup

public void configureDetectorForTimingGroup(TimingGroup group)
                                     throws DeviceException

Specified by:

configureDetectorForTimingGroup in interface EdeDetector

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()

getNumberScansInFrame

public int getNumberScansInFrame(double expoTime,
 double accTime,
 int numberOfImages)
                          throws DeviceException

retrieve calculated accumulation number of frames per image from the detector. the third parameter is not used here. It is just API signature used by XH detector.

Specified by:

getNumberScansInFrame in interface EdeDetector

Specified by:

getNumberScansInFrame in class EdeDetectorBase

Parameters:

expoTime -

accTime -

numberOfImages -

Returns:

number of accumulations.

Throws:

DeviceException

getNumberScansInFrame

public int getNumberScansInFrame()

Specified by:

getNumberScansInFrame in interface EdeDetector

setNumberScansInFrame

public void setNumberScansInFrame(int numScansInFrame)

Specified by:

setNumberScansInFrame in interface EdeDetector

configureDetectorForCollection

public void configureDetectorForCollection()
                                    throws DeviceException

Set kinetic ROI mode on the detector. Configuring detector for collection is split into 2 methods: configureDetectorForROI(int, int) which must be called once before collection from detector GUI; and configureDetectorForTimingGroup(TimingGroup) which handles timing group changes during collection.

Specified by:

configureDetectorForCollection in class EdeDetectorBase

Throws:

DeviceException

fetchStatus

public DetectorStatus fetchStatus()
                           throws DeviceException

Description copied from class: EdeDetectorBase

fetch detector status from hardware.

Specified by:

fetchStatus in interface EdeDetector

Specified by:

fetchStatus in class EdeDetectorBase

Returns:

DetectorStatus

Throws:

DeviceException

getMaxPixel

public int getMaxPixel()

Description copied from class: EdeDetectorBase

detector's maximum pixel size in energy direction.

Specified by:

getMaxPixel in interface EdeDetector

Specified by:

getMaxPixel in class EdeDetectorBase

Returns:

maximum pixels of camera in energy direction

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.

Specified by:

createsOwnFiles in interface Detector

Returns:

true if readout() returns filenames

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

reset

public void reset()
           throws DeviceException

reset the camera to factory setting

Throws:

DeviceException

getCurrentAttributesValues

public String[] getCurrentAttributesValues()
                                    throws DeviceException

Throws:

DeviceException

resetLink

public void resetLink()
               throws DeviceException

Throws:

DeviceException

getLimaCcd

public LimaCCD getLimaCcd()

setLimaCcd

public void setLimaCcd(LimaCCD limaCcd)

getFrelon

public Frelon getFrelon()

setFrelon

public void setFrelon(Frelon frelon)

getTemperatures

public HashMap<String,Double> getTemperatures()
                                       throws DeviceException

Specified by:

getTemperatures in interface EdeDetector

Throws:

DeviceException

getNumberOfSpectra

public int getNumberOfSpectra()
                       throws DeviceException

Specified by:

getNumberOfSpectra in interface EdeDetector

Throws:

DeviceException

getLastImageAvailable

public int getLastImageAvailable()
                          throws DeviceException

Specified by:

getLastImageAvailable in interface EdeDetector

Returns:

Index of last image on the detector available for reading out using. (i.e. -1 = no image is ready, 0 = 1 image is ready)

Throws:

DeviceException

getCurrentTimingGroup

public TimingGroup getCurrentTimingGroup()

setSynchroniseToBeamOrbit

public void setSynchroniseToBeamOrbit(boolean synchroniseToBeamOrbit)

Specified by:

setSynchroniseToBeamOrbit in interface EdeDetector

Specified by:

setSynchroniseToBeamOrbit in class EdeDetectorBase

getSynchroniseToBeamOrbit

public boolean getSynchroniseToBeamOrbit()

Specified by:

getSynchroniseToBeamOrbit in interface EdeDetector

Specified by:

getSynchroniseToBeamOrbit in class EdeDetectorBase

setSynchroniseBeamOrbitDelay

public void setSynchroniseBeamOrbitDelay(int synchroniseBeamOrbitDelay)
                                  throws DeviceException

Specified by:

setSynchroniseBeamOrbitDelay in interface EdeDetector

Specified by:

setSynchroniseBeamOrbitDelay in class EdeDetectorBase

Throws:

DeviceException

getSynchroniseBeamOrbitDelay

public int getSynchroniseBeamOrbitDelay()

Specified by:

getSynchroniseBeamOrbitDelay in interface EdeDetector

Specified by:

getSynchroniseBeamOrbitDelay in class EdeDetectorBase

setOrbitWaitMethod

public void setOrbitWaitMethod(String methodString)

Specified by:

setOrbitWaitMethod in interface EdeDetector

Specified by:

setOrbitWaitMethod in class EdeDetectorBase

getOrbitWaitMethod

public String getOrbitWaitMethod()

Specified by:

getOrbitWaitMethod in interface EdeDetector

Specified by:

getOrbitWaitMethod in class EdeDetectorBase

getRoiVerticalBinning

public int getRoiVerticalBinning()

setRoiVerticalBinning

public void setRoiVerticalBinning(int verticalBinning)

getRoiVerticalStart

public int getRoiVerticalStart()

setRoiVerticalStart

public void setRoiVerticalStart(int roiVerticalStart)

setAccumulationReadoutTime

public void setAccumulationReadoutTime(double timeSec)

Description copied from interface: EdeDetector

Set the accumulation readout time

Specified by:

setAccumulationReadoutTime in interface EdeDetector

Overrides:

setAccumulationReadoutTime in class EdeDetectorBase

loadSettingsFromStore

protected void loadSettingsFromStore()

saveSettingsToStore

protected void saveSettingsToStore()