Package uk.ac.diamond.daq.devices.specs.phoibos

Class SpecsPhoibosAnalyserSeparateIterations

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.NXDetector

uk.ac.diamond.daq.devices.specs.phoibos.SpecsPhoibosAnalyserSeparateIterations

All Implemented Interfaces:

Detector, NexusDetector, NXPluginDetector, Device, Scannable, PositionCallableProvider<NexusTreeProvider>, Configurable, Findable, gda.observable.IObservable, Serializable, IAnalyserSequence, org.springframework.beans.factory.InitializingBean, ISpecsPhoibosAnalyser

@ServiceInterface(ISpecsPhoibosAnalyser.class)
public class SpecsPhoibosAnalyserSeparateIterations
extends NXDetector
implements ISpecsPhoibosAnalyser

This class is the actual detector used in GDA. It is composed of a SpecsPhoibosController handling the EPICS communication, and a SpecsPhoibosCollectionStrategy handling the collection logic.

It is exported via RMI using the ISpecsPhoibosAnalyser interface, to the client GUI to request information available here, like the available getLensModes(). It also provides the logic for BE invalid input: '<'-> KE conversion using the photon energy.

The GUI can be an IObserver of this class to receive live updates of the scan as it is received from EPICS, see SpecsPhoibosLiveDataUpdate

See Also:

• Serialized Form

Field Summary

Fields inherited from class gda.device.detector.NXDetector

lastReadoutValue, UNSUPPORTED_PART_OF_SCANNABLE_INTERFACE, UNSUPPORTED_SET_FUNCTION

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

Method Summary

Modifier and Type	Method	Description
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	disableExperimentalShutterCheck()
void	disablePrelensValveCheck()
void	enableExperimentalShutterCheck()
void	enablePrelensValveCheck()
String	getAcquisitionMode()
Set<String>	getAcquisitionModes()
double	getCenterEnergy()
double	getCollectionTime()	Returns the time, in seconds, the detector collects for during the next call to collectData()
SpecsPhoibosController	getController()
int	getCurrentIteration()
SpecsPhoibosCompletedRegionWithSeperateIterations	getCurrentOrLastRegion()
double	getCurrentPhotonEnergy()	Gets the photon energy that will currently be used when converting KE invalid input: '<'-> BE
int	getCurrentPoint()
String	getCurrentPositionString()
String	getCurrentRegionName()
SpecsPhoibosRegion	getDefaultRegionUi()
double	getDetectorEnergyWidth()
SpecsPhoibosStatus	getDetectorStatus()
double	getDwellTime()
double[]	getEnergyAxis()	Gets the energy axis from the analyser this is always in kinetic energy
double	getEnergyStep()
EnumPositioner	getExperimentalShutter()
double	getExposureTime()
double	getHighEnergy()
double[][]	getImage()
org.eclipse.january.dataset.IDataset	getImageAsDataset()
int	getIterations()
String	getLensMode()
Set<String>	getLensModes()
double	getLowEnergy()
double	getPassEnergy()
Scannable	getPhotonEnergyProvider()
int	getPointInIteration()
EnumPositioner	getPrelensValve()
String	getPsuMode()
Set<String>	getPsuModes()
SpecsPhoibosRegion	getRegion()	Get the current analyser settings and builds a region from them.
String	getSequenceFile()
boolean	getShouldCheckExperimentalShutter()
boolean	getShouldCheckPrelensValve()
int	getSlices()
int	getSnapshotImageSizeX()
double[]	getSpectrum()
double[]	getSpectrum(int index)
org.eclipse.january.dataset.IDataset	getSpectrumAsDataset()
String	getStatusMessage()
double[]	getSummedSpectrum()
int	getTotalPoints()
int	getValues()
double	getWorkFunction()
double[]	getYAxis()
String	getYUnits()
boolean	isNotBusy()	Returns true if no scan running or analyser is in aborted state
void	setAcquisitionMode(String value)
void	setAlignmentTimeout(double alignmentTimeout)
void	setCentreEnergy(double value)
void	setCollectionStrategy(NXCollectionStrategyPlugin collectionStrategy)
void	setCollectionTime(double collectionTime)	Sets the collection time, in seconds, to be used during the next call of collectData.
void	setController(SpecsPhoibosController controller)
void	setDefaultRegionUi(SpecsPhoibosRegion region)
void	setDetectorEnergyWidth(double detectorEnergyWidth)
void	setDwellTime(double dwellTime)
void	setEnergyStep(double value)
void	setExperimentalShutter(EnumPositioner experimentalShutter)
void	setHighEnergy(double value)
void	setIterations(int value)
void	setLensMode(String value)
void	setLowEnergy(double value)
void	setPassEnergy(double value)
void	setPhotonEnergyProvider(Scannable photonEnergyProvider)
void	setPrelensValve(EnumPositioner prelensValve)
void	setPsuMode(String psuMode)
void	setRegion(SpecsPhoibosRegion region)	Configures the analyser to acquire the region specified.
void	setSafeState(boolean safe)
void	setSequence(SpecsPhoibosSequence sequence, String filepath)	Sets up the analyser to run the provided sequence.
void	setSequenceFile(String filePath)	Set the analyser sequence from a sequence file.
void	setShouldCheckExperimentalShutter(boolean shouldCheckExperimentalShutter)
void	setShouldCheckPrelensValve(boolean shouldCheckPrelensValve)
void	setSlices(int slices)
void	setSnapshotImageSizeX(int snapshotImageSizeX)
void	setWorkFunction(double workFunction)
void	startAcquiring()
void	startAcquiringWait()
void	startAlignment(double passEnergy, double centreEnergy, double exposureTime, String lensMode)	Starts the analyser acquiring in single image mode, this is intended for use in alignment.
void	stopAcquiring()
void	stopAfterCurrentIteration()
void	stopAfterCurrentRegion()
double	toBindingEnergy(double kineticEnergy)	Converts kinetic energy to binding energy according to: BE = hν - KE - Φ where hν = photon energy and Φ = analyser work function
double[]	toBindingEnergy(double[] kineticEnergy)	Converts kinetic energy to binding energy according to: BE = hν - KE - Φ where hν = photon energy and Φ = analyser work function
double	toKineticEnergy(double bindingEnergy)	Converts binding energy to kinetic energy according to: KE = hν - BE - Φ where hν = photon energy and Φ = analyser work function
double[]	toKineticEnergy(double[] bindingEnergy)	Converts binding energy to kinetic energy according to: KE = hν - BE - Φ where hν = photon energy and Φ = analyser work function
SpecsPhoibosSequenceValidation	validateSequence(SpecsPhoibosSequence sequence)	Performs EPICS validation and scannable position validation for all regions in a sequence

Methods inherited from class gda.device.detector.NXDetector

__getattr__, __str__, afterPropertiesSet, asynchronousMoveTo, atCommandFailure, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, collectData, createsOwnFiles, endCollection, getAdditionalPluginList, getCollectionStrategy, getExtraNames, getFileStructure, getInputNames, getOutputFormat, getPlugin, getPluginList, getPluginMap, getPosition, getPositionCallable, getStatus, isAddCollectTimeMs, isBusy, prepareCollectionStrategyAtScanStart, prepareForCollection, readout, setAddCollectTimeMs, setAdditionalPluginList, setExtraNames, setInputNames, setOutputFormat, stop, waitWhileBusy

Methods inherited from class gda.device.detector.DetectorBase

checkPositionValid, getDataDimensions, getDescription, getDetectorID, getDetectorType, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, externalToInternal, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setLevel, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, 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, reconfigure, 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, reconfigure

Methods inherited from interface gda.device.Detector

getDataDimensions, getDescription, getDetectorID, getDetectorType

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 uk.ac.diamond.daq.devices.specs.phoibos.api.ISpecsPhoibosAnalyser

stopAlignment

Methods inherited from interface gda.device.Scannable

atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, checkPositionValid, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setLevel, setScanMetadataAttribute, setScanMetadataAttributes, toFormattedString

Constructor Details

SpecsPhoibosAnalyserSeparateIterations

public SpecsPhoibosAnalyserSeparateIterations()

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

setSnapshotImageSizeX

public void setSnapshotImageSizeX(int snapshotImageSizeX)

getSnapshotImageSizeX

public int getSnapshotImageSizeX()

Specified by:

getSnapshotImageSizeX in interface ISpecsPhoibosAnalyser

getCollectionTime

public double getCollectionTime()

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

getExposureTime

public double getExposureTime()

setCollectionTime

public void setCollectionTime(double collectionTime)

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

setDwellTime

public void setDwellTime(double dwellTime)

Specified by:

setDwellTime in interface ISpecsPhoibosAnalyser

setIterations

public void setIterations(int value)

getIterations

public int getIterations()

Specified by:

getIterations in interface ISpecsPhoibosAnalyser

getCurrentIteration

public int getCurrentIteration()

Specified by:

getCurrentIteration in interface ISpecsPhoibosAnalyser

setLensMode

public void setLensMode(String value)

Specified by:

setLensMode in interface ISpecsPhoibosAnalyser

getLensMode

public String getLensMode()

Specified by:

getLensMode in interface ISpecsPhoibosAnalyser

setAcquisitionMode

public void setAcquisitionMode(String value)

Specified by:

setAcquisitionMode in interface ISpecsPhoibosAnalyser

getAcquisitionMode

public String getAcquisitionMode()

getAcquisitionModes

public Set<String> getAcquisitionModes()

Specified by:

getAcquisitionModes in interface ISpecsPhoibosAnalyser

setPassEnergy

public void setPassEnergy(double value)

Specified by:

setPassEnergy in interface ISpecsPhoibosAnalyser

getPassEnergy

public double getPassEnergy()

Specified by:

getPassEnergy in interface ISpecsPhoibosAnalyser

setLowEnergy

public void setLowEnergy(double value)

getLowEnergy

public double getLowEnergy()

setHighEnergy

public void setHighEnergy(double value)

getHighEnergy

public double getHighEnergy()

setEnergyStep

public void setEnergyStep(double value)

getEnergyStep

public double getEnergyStep()

getSpectrum

public double[] getSpectrum()

Specified by:

getSpectrum in interface ISpecsPhoibosAnalyser

getSummedSpectrum

public double[] getSummedSpectrum()

getSpectrum

public double[] getSpectrum(int index)

Specified by:

getSpectrum in interface ISpecsPhoibosAnalyser

setCentreEnergy

public void setCentreEnergy(double value)

getSpectrumAsDataset

public org.eclipse.january.dataset.IDataset getSpectrumAsDataset()

getImage

public double[][] getImage()

Specified by:

getImage in interface ISpecsPhoibosAnalyser

getImageAsDataset

public org.eclipse.january.dataset.IDataset getImageAsDataset()
                                                       throws Exception

Throws:

Exception

getLensModes

public Set<String> getLensModes()

Specified by:

getLensModes in interface ISpecsPhoibosAnalyser

getController

public SpecsPhoibosController getController()

setController

public void setController(SpecsPhoibosController controller)

getEnergyAxis

public double[] getEnergyAxis()

Gets the energy axis from the analyser this is always in kinetic energy

Specified by:

getEnergyAxis in interface ISpecsPhoibosAnalyser

getYAxis

public double[] getYAxis()

Specified by:

getYAxis in interface ISpecsPhoibosAnalyser

getYUnits

public String getYUnits()

Specified by:

getYUnits in interface ISpecsPhoibosAnalyser

getPsuModes

public Set<String> getPsuModes()

Specified by:

getPsuModes in interface ISpecsPhoibosAnalyser

setPsuMode

public void setPsuMode(String psuMode)

Specified by:

setPsuMode in interface ISpecsPhoibosAnalyser

getDetectorEnergyWidth

public double getDetectorEnergyWidth()

Specified by:

getDetectorEnergyWidth in interface ISpecsPhoibosAnalyser

setDetectorEnergyWidth

public void setDetectorEnergyWidth(double detectorEnergyWidth)

setRegion

public void setRegion(SpecsPhoibosRegion region)

Description copied from interface: ISpecsPhoibosAnalyser

Configures the analyser to acquire the region specified.

Specified by:

setRegion in interface ISpecsPhoibosAnalyser

Parameters:

region - The region to set /** This is the interface used to expose the SPECS Phoibos analyser over RMI.

It is intended to only contain the methods needed to make a rich GUI to interact with the analyser

getRegion

public SpecsPhoibosRegion getRegion()

Description copied from interface: ISpecsPhoibosAnalyser

Get the current analyser settings and builds a region from them.

Specified by:

getRegion in interface ISpecsPhoibosAnalyser

Returns:

The region the analyser is currently configured for

getValues

public int getValues()

getPsuMode

public String getPsuMode()

Specified by:

getPsuMode in interface ISpecsPhoibosAnalyser

getDwellTime

public double getDwellTime()

Specified by:

getDwellTime in interface ISpecsPhoibosAnalyser

setSlices

public void setSlices(int slices)

getSlices

public int getSlices()

Specified by:

getSlices in interface ISpecsPhoibosAnalyser

startAlignment

public void startAlignment(double passEnergy,
 double centreEnergy,
 double exposureTime,
 String lensMode)

Description copied from interface: ISpecsPhoibosAnalyser

Starts the analyser acquiring in single image mode, this is intended for use in alignment. This is non blocking

Specified by:

startAlignment in interface ISpecsPhoibosAnalyser

startAcquiring

public void startAcquiring()

startAcquiringWait

public void startAcquiringWait()
                        throws DeviceException

Throws:

DeviceException

stopAcquiring

public void stopAcquiring()

Specified by:

stopAcquiring in interface ISpecsPhoibosAnalyser

getCenterEnergy

public double getCenterEnergy()

Specified by:

getCenterEnergy in interface ISpecsPhoibosAnalyser

setCollectionStrategy

public void setCollectionStrategy(NXCollectionStrategyPlugin collectionStrategy)

Specified by:

setCollectionStrategy in interface NXPluginDetector

Overrides:

setCollectionStrategy in class NXDetector

setSequenceFile

public void setSequenceFile(String filePath)

Set the analyser sequence from a sequence file. If the path is absolute it will be used as is else the absolute path will be constructed from the visit xml directory and the provided file name.

Specified by:

setSequenceFile in interface IAnalyserSequence

Parameters:

filePath - Path to a sequence file either absolute or a file inside the visit xml directory

setSequence

public void setSequence(SpecsPhoibosSequence sequence,
 String filepath)

Description copied from interface: ISpecsPhoibosAnalyser

Sets up the analyser to run the provided sequence.

Specified by:

setSequence in interface ISpecsPhoibosAnalyser

Parameters:

sequence - The sequence to set

filepath - The path of the sequence file

getDetectorStatus

public SpecsPhoibosStatus getDetectorStatus()

getStatusMessage

public String getStatusMessage()

toBindingEnergy

public double toBindingEnergy(double kineticEnergy)

Description copied from interface: ISpecsPhoibosAnalyser

Converts kinetic energy to binding energy according to:
BE = hν - KE - Φ
where hν = photon energy and Φ = analyser work function

Specified by:

toBindingEnergy in interface ISpecsPhoibosAnalyser

Parameters:

kineticEnergy - to convert

Returns:

The equivalent binding energy

toKineticEnergy

public double toKineticEnergy(double bindingEnergy)

Description copied from interface: ISpecsPhoibosAnalyser

Converts binding energy to kinetic energy according to:
KE = hν - BE - Φ
where hν = photon energy and Φ = analyser work function

Specified by:

toKineticEnergy in interface ISpecsPhoibosAnalyser

Parameters:

bindingEnergy - to convert

Returns:

The equivalent binding energy

toBindingEnergy

public double[] toBindingEnergy(double[] kineticEnergy)

Description copied from interface: ISpecsPhoibosAnalyser

Converts kinetic energy to binding energy according to:
BE = hν - KE - Φ
where hν = photon energy and Φ = analyser work function

Specified by:

toBindingEnergy in interface ISpecsPhoibosAnalyser

Parameters:

kineticEnergy - to convert

Returns:

The equivalent binding energy

toKineticEnergy

public double[] toKineticEnergy(double[] bindingEnergy)

Description copied from interface: ISpecsPhoibosAnalyser

Converts binding energy to kinetic energy according to:
KE = hν - BE - Φ
where hν = photon energy and Φ = analyser work function

Specified by:

toKineticEnergy in interface ISpecsPhoibosAnalyser

Parameters:

bindingEnergy - to convert

Returns:

The equivalent binding energy

getPhotonEnergyProvider

public Scannable getPhotonEnergyProvider()

setPhotonEnergyProvider

public void setPhotonEnergyProvider(Scannable photonEnergyProvider)

getPrelensValve

public EnumPositioner getPrelensValve()

setPrelensValve

public void setPrelensValve(EnumPositioner prelensValve)

getWorkFunction

public double getWorkFunction()

setWorkFunction

public void setWorkFunction(double workFunction)

getTotalPoints

public int getTotalPoints()

getCurrentPoint

public int getCurrentPoint()

getPointInIteration

public int getPointInIteration()

validateSequence

public SpecsPhoibosSequenceValidation validateSequence(SpecsPhoibosSequence sequence)
                                                throws DeviceException

Description copied from interface: ISpecsPhoibosAnalyser

Performs EPICS validation and scannable position validation for all regions in a sequence

Specified by:

validateSequence in interface ISpecsPhoibosAnalyser

Parameters:

sequence -

Returns:

SpecsPhoibosSequenceValidation

Throws:

DeviceException

isNotBusy

public boolean isNotBusy()

Returns true if no scan running or analyser is in aborted state

Specified by:

isNotBusy in interface ISpecsPhoibosAnalyser

getCurrentPositionString

public String getCurrentPositionString()

Specified by:

getCurrentPositionString in interface ISpecsPhoibosAnalyser

getCurrentRegionName

public String getCurrentRegionName()

Specified by:

getCurrentRegionName in interface ISpecsPhoibosAnalyser

getCurrentPhotonEnergy

public double getCurrentPhotonEnergy()

Gets the photon energy that will currently be used when converting KE invalid input: '<'-> BE

Returns:

The cached photon energy

setSafeState

public void setSafeState(boolean safe)

getExperimentalShutter

public EnumPositioner getExperimentalShutter()

setExperimentalShutter

public void setExperimentalShutter(EnumPositioner experimentalShutter)

getCurrentOrLastRegion

public SpecsPhoibosCompletedRegionWithSeperateIterations getCurrentOrLastRegion()

stopAfterCurrentIteration

public void stopAfterCurrentIteration()

Specified by:

stopAfterCurrentIteration in interface ISpecsPhoibosAnalyser

getShouldCheckExperimentalShutter

public boolean getShouldCheckExperimentalShutter()

Specified by:

getShouldCheckExperimentalShutter in interface ISpecsPhoibosAnalyser

setShouldCheckExperimentalShutter

public void setShouldCheckExperimentalShutter(boolean shouldCheckExperimentalShutter)

Specified by:

setShouldCheckExperimentalShutter in interface ISpecsPhoibosAnalyser

getShouldCheckPrelensValve

public boolean getShouldCheckPrelensValve()

Specified by:

getShouldCheckPrelensValve in interface ISpecsPhoibosAnalyser

setShouldCheckPrelensValve

public void setShouldCheckPrelensValve(boolean shouldCheckPrelensValve)

Specified by:

setShouldCheckPrelensValve in interface ISpecsPhoibosAnalyser

enableExperimentalShutterCheck

public void enableExperimentalShutterCheck()

Specified by:

enableExperimentalShutterCheck in interface ISpecsPhoibosAnalyser

disableExperimentalShutterCheck

public void disableExperimentalShutterCheck()

Specified by:

disableExperimentalShutterCheck in interface ISpecsPhoibosAnalyser

enablePrelensValveCheck

public void enablePrelensValveCheck()

Specified by:

enablePrelensValveCheck in interface ISpecsPhoibosAnalyser

disablePrelensValveCheck

public void disablePrelensValveCheck()

Specified by:

disablePrelensValveCheck in interface ISpecsPhoibosAnalyser

setAlignmentTimeout

public void setAlignmentTimeout(double alignmentTimeout)

setDefaultRegionUi

public void setDefaultRegionUi(SpecsPhoibosRegion region)

Specified by:

setDefaultRegionUi in interface ISpecsPhoibosAnalyser

getDefaultRegionUi

public SpecsPhoibosRegion getDefaultRegionUi()

Specified by:

getDefaultRegionUi in interface ISpecsPhoibosAnalyser

getSequenceFile

public String getSequenceFile()

Specified by:

getSequenceFile in interface IAnalyserSequence

stopAfterCurrentRegion

public void stopAfterCurrentRegion()

Specified by:

stopAfterCurrentRegion in interface ISpecsPhoibosAnalyser