Package gda.px.flux

Class DoseCalculator

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScannableMotionBase

gda.device.scannable.DummyScannable

gda.px.flux.DoseCalculator

All Implemented Interfaces:

INeXusInfoWriteable, ControllerRecord, Device, Scannable, ScannableMotion, Configurable, Findable, gda.observable.IObservable, DoseEstimateProvider

@ServiceInterface(DoseEstimateProvider.class)
public class DoseCalculator
extends DummyScannable
implements DoseEstimateProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_ENERGY

Fields inherited from class gda.device.scannable.DummyScannable

currentPosition, increment

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

Constructor Summary

Constructors

Constructor	Description
DoseCalculator()

Method Summary

Modifier and Type	Method	Description
static double	calculateAngleLimit(double radLimit, double dosePerFrame, double degPerFrame)
static double	calculateDosePerFrame(double flux, double muAbs, double beamWidthInMicrons, double beamHeightInMicrons, double energyInEv, double exposureTime)
static double	calculateDosePerSecond(double flux, double muAbs, double beamWidthInMicrons, double beamHeightInMicrons, double energyInEv)	Returns the dose (MGy) per second.
static EstimateData	calculateEstimate(double dosePerFrame, double degreesPerFrame, double radLimit)
static double	calculateFrameLimit(double radLimit, double dosePerFrame)
static double[][]	calculateLimits(double dosePerFrame, double degreesPerFrame, double[] radLimit)
double	getAngleLimit(double radLimit, double exposure, double degPerFrame)
double	getDosePerFrame(double exposure)
double	getEnergy()
double	getFlux()
double	getFrameLimit(double radLimit, double exposure)
double	getMuAbs()
static double	muAbsForAverageSample(double energyInEv)
static double	predictFlux(double energy, double transmission, double scale_factor)
static double	predictFlux(double energy, double transmission, String aperture)
void	setDoseRate(double doseRate)
void	setEnergy(double energy)
void	setFlux(double flux)
void	setMuAbs(double muAbs)

Methods inherited from class gda.device.scannable.DummyScannable

getControllerRecordName, getPosition, isBusy, rawAsynchronousMoveTo, rawGetPosition, setControllerRecordName, setIncrement, setName

Methods inherited from class gda.device.scannable.ScannableMotionBase

a, addPositionValidator, ar, asynchronousMoveTo, checkPositionValid, checkPositionWithinGdaLimits, checkPositionWithinGdaLimits, completeInstantiation, externalToInternal, generateScannableLimitsReport, getAdditionalPositionValidators, getAttribute, getFirstInputLimits, getInputLimits, getInputLimits, getLimitsComponent, getLowerGdaLimits, getNumberTries, getOffset, getScalingFactor, getTolerances, getUpperGdaLimits, internalToExternal, isAt, moveTo, r, rawIsBusy, removePositionValidator, setAdditionalPositionValidators, setLimitsComponent, setLowerGdaLimits, setLowerGdaLimits, setNumberTries, setOffset, setOffsetAndScalingComponent, setScalingFactor, setTolerance, setTolerances, setUpperGdaLimits, setUpperGdaLimits, toFormattedString, 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, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

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

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Device

close, 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, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, waitWhileBusy

Field Details

DEFAULT_ENERGY

public static final double DEFAULT_ENERGY

See Also:

• Constant Field Values

Constructor Details

DoseCalculator

public DoseCalculator()

Method Details

calculateAngleLimit

public static double calculateAngleLimit(double radLimit,
 double dosePerFrame,
 double degPerFrame)

calculateDosePerFrame

public static double calculateDosePerFrame(double flux,
 double muAbs,
 double beamWidthInMicrons,
 double beamHeightInMicrons,
 double energyInEv,
 double exposureTime)

calculateDosePerSecond

public static double calculateDosePerSecond(double flux,
 double muAbs,
 double beamWidthInMicrons,
 double beamHeightInMicrons,
 double energyInEv)

Returns the dose (MGy) per second.

calculateEstimate

public static EstimateData calculateEstimate(double dosePerFrame,
 double degreesPerFrame,
 double radLimit)

calculateFrameLimit

public static double calculateFrameLimit(double radLimit,
 double dosePerFrame)

calculateLimits

public static double[][] calculateLimits(double dosePerFrame,
 double degreesPerFrame,
 double[] radLimit)

muAbsForAverageSample

public static double muAbsForAverageSample(double energyInEv)

predictFlux

public static double predictFlux(double energy,
 double transmission,
 String aperture)

predictFlux

public static double predictFlux(double energy,
 double transmission,
 double scale_factor)

getAngleLimit

public double getAngleLimit(double radLimit,
 double exposure,
 double degPerFrame)

Specified by:

getAngleLimit in interface DoseEstimateProvider

getDosePerFrame

public double getDosePerFrame(double exposure)

Specified by:

getDosePerFrame in interface DoseEstimateProvider

getEnergy

public double getEnergy()

getFlux

public double getFlux()

getFrameLimit

public double getFrameLimit(double radLimit,
 double exposure)

Specified by:

getFrameLimit in interface DoseEstimateProvider

getMuAbs

public double getMuAbs()

setDoseRate

public void setDoseRate(double doseRate)

setEnergy

public void setEnergy(double energy)

setFlux

public void setFlux(double flux)

setMuAbs

public void setMuAbs(double muAbs)