Package gda.device.scannable

Class JohannSpectrometer

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

gda.device.scannable.ScannableMotionUnitsBase

gda.device.scannable.XesSpectrometerScannableBase

gda.device.scannable.JohannSpectrometer

All Implemented Interfaces:

INeXusInfoWriteable, Device, Scannable, ScannableMotion, ScannableMotionUnits, IXesSpectrometerScannable, Configurable, Findable, gda.observable.IObservable, gda.observable.IObserver

@ServiceInterface(IXesSpectrometerScannable.class)
public class JohannSpectrometer
extends XesSpectrometerScannableBase

Field Summary

Fields inherited from class gda.device.scannable.XesSpectrometerScannableBase

crystalList, crystalsAllowedToMove, crystalsGroup, detectorGroup, maxTheta, minTheta, radius, radiusScannable

Fields inherited from class gda.device.scannable.ScannableMotionUnitsBase

unitsComponent

Fields inherited from class gda.device.scannable.ScannableMotionBase

numberTries, tolerance

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.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Fields inherited from interface gda.device.ScannableMotion

FIRSTINPUTLIMITS

Fields inherited from interface gda.device.ScannableMotionUnits

HARDWAREUNITS, USERUNITS

Constructor Summary

Constructors

Constructor	Description
JohannSpectrometer()

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.
double	getAnalyserSeparationAngle()
double	getDetectorAxisLength()
double[]	getDetectorAxisPosition(double axisLength, double braggAngle)	Position of detector rotation axis relative to the detector position.
double	getSourceDisplacement()
Map<Scannable,Double>	getSpectrometerPositions(double targetBragg)
boolean	isIncludeYawCorrection()
void	rawAsynchronousMoveTo(Object position)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
Object	rawGetPosition()	Determine Bragg angle from height of central analyser.
void	setAnalyserSeparationAngle(double analyserSeparationAngle)
void	setDetectorAxisLength(double detectorAxisLength)
void	setIncludeYawCorrection(boolean includeYawCorrection)
void	setSourceDisplacement(double sourceDisplacement)

Methods inherited from class gda.device.scannable.XesSpectrometerScannableBase

checkPositionValid, checkPositionValid, extractDouble, getCrystalsAllowedToMove, getCrystalsGroup, getCrystalsList, getDetectorGroup, getDetRotScannable, getDetXScannable, getDetYScannable, getGroupedScannables, getMaxTheta, getMinTheta, getRadius, getRadiusScannable, getScannables, getScannablesOfTypeFromGroup, isBusy, setCrystalsAllowedToMove, setCrystalsGroup, setDetectorGroup, setMaxTheta, setMinTheta, setRadius, setRadiusScannable, stop, tryToUpdateRadiusFromScannable, update, updateActiveGroups, updateRadiusFromScannable, validateAndSetup, validatePosition

Methods inherited from class gda.device.scannable.ScannableMotionUnitsBase

addAcceptableUnit, externalToInternal, getAcceptableUnits, getAttribute, getHardwareUnitString, getInitialUserUnits, getOffset, getUserUnits, internalToExternal, isAt, setHardwareUnitString, setInitialUserUnits, setOffset, setOffset, setUserUnits, toFormattedString

Methods inherited from class gda.device.scannable.ScannableMotionBase

a, addPositionValidator, ar, asynchronousMoveTo, checkPositionValid, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, completeInstantiation, generateScannableLimitsReport, getAdditionalPositionValidators, getFirstInputLimits, getInputLimits, getInputLimits, getLimitsComponent, getLowerGdaLimits, getNumberTries, getScalingFactor, getTolerances, getUpperGdaLimits, moveTo, r, rawIsBusy, removePositionValidator, setAdditionalPositionValidators, setLimitsComponent, setLowerGdaLimits, setLowerGdaLimits, setNumberTries, setOffsetAndScalingComponent, setScalingFactor, setTolerance, setTolerances, setUpperGdaLimits, setUpperGdaLimits, writeNeXusInformation, writeNeXusInformationLimits

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, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, 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.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

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

Methods inherited from interface gda.device.ScannableMotion

a, ar, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, getLowerGdaLimits, getNumberTries, getOffset, getScalingFactor, getTolerances, getUpperGdaLimits, r, setLowerGdaLimits, setLowerGdaLimits, setNumberTries, setOffset, setScalingFactor, setTolerance, setTolerances, setUpperGdaLimits, setUpperGdaLimits

Methods inherited from interface gda.device.ScannableMotionUnits

addAcceptableUnit, getAcceptableUnits, getHardwareUnitString, getUserUnits, setHardwareUnitString, setOffset, setUserUnits

Constructor Details

JohannSpectrometer

public JohannSpectrometer()

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

rawAsynchronousMoveTo

public void rawAsynchronousMoveTo(Object position)
                           throws DeviceException

Description copied from class: ScannableBase

[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.

Overrides:

rawAsynchronousMoveTo in class ScannableBase

Parameters:

position - Position in its internal/hardware representation. e.g. with units and offsets removed

Throws:

DeviceException

See Also:

• asynchronousMoveTo

getSpectrometerPositions

public Map<Scannable,Double> getSpectrometerPositions(double targetBragg)

Parameters:

targetBragg -

Returns:

Map containing position of each scannable in the spectrometer for the given energy.

rawGetPosition

public Object rawGetPosition()
                      throws DeviceException

Determine Bragg angle from height of central analyser.

Overrides:

rawGetPosition in class ScannableBase

Returns:

the value represented by this Scannable

Throws:

DeviceException

See Also:

• Scannable.getPosition()

getDetectorAxisPosition

public double[] getDetectorAxisPosition(double axisLength,
 double braggAngle)

Position of detector rotation axis relative to the detector position. +ve direction of position is away from analyser (i.e. 'behind' the sample position)

Parameters:

axisLength -

braggAngle -

Returns:

rotation axis position relative to detector position - x, y

getDetectorAxisLength

public double getDetectorAxisLength()

setDetectorAxisLength

public void setDetectorAxisLength(double detectorAxisLength)

getAnalyserSeparationAngle

public double getAnalyserSeparationAngle()

setAnalyserSeparationAngle

public void setAnalyserSeparationAngle(double analyserSeparationAngle)

getSourceDisplacement

public double getSourceDisplacement()

setSourceDisplacement

public void setSourceDisplacement(double sourceDisplacement)

isIncludeYawCorrection

public boolean isIncludeYawCorrection()

setIncludeYawCorrection

public void setIncludeYawCorrection(boolean includeYawCorrection)