Package gda.device.detector.countertimer

Class TfgScalerWithDarkCurrent

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.countertimer.CounterTimerBase

gda.device.detector.countertimer.TFGCounterTimer

gda.device.detector.countertimer.TfgScaler

gda.device.detector.countertimer.TfgScalerWithDarkCurrent

All Implemented Interfaces:

CounterTimer, Detector, DarkCurrentDetector, Device, Scannable, Configurable, Findable, gda.observable.IObservable, Serializable

Direct Known Subclasses:

TfgScalerWithLogValues, TFGScalerWithRatio

public abstract class TfgScalerWithDarkCurrent
extends TfgScaler
implements DarkCurrentDetector

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TfgScalerWithDarkCurrent.DarkCurrentBean	Parameters for dark current collection

Field Summary

Fields inherited from class gda.device.detector.countertimer.TfgScaler

numChannelsToRead, scaler, timeChannelRequired

Fields inherited from class gda.device.detector.countertimer.TFGCounterTimer

isTFGv2

Fields inherited from class gda.device.detector.countertimer.CounterTimerBase

slave, timer

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

Method Summary

Modifier and Type	Method	Description
void	acquireDarkCurrent()	Reads and sets the darkCurrent
protected Double	adjustChannelForDarkCurrent(Double rawCounts, Double dkCounts, Double collectionTime)
protected double[]	adjustForDarkCurrent(double[] values, Double collectionTime)
void	atScanEnd()	Called for every Scannable at the end of a group of nested scans (or a single scan if that is the case).
void	atScanStart()	Reads the dark current.
Double[]	getDarkCurrent()
Double	getDarkCurrentCollectionTime()
DarkCurrentResults	getDarkCurrentResults()
boolean	isDarkCurrentRequired()
boolean	isUseReset()
void	setDarkCurrent(DarkCurrentResults darkCurrent)
void	setDarkCurrentCollectionTime(Double darkCurrentCollectionTime)
void	setDarkCurrentRequired(boolean darkCurrentRequired)
void	setUseReset(boolean useReset)	True by default, set to false if the shutter used to collect the dark current should not have reset called before opening.

Methods inherited from class gda.device.detector.countertimer.TfgScaler

addFrameSet, addFrameSet, atCommandFailure, atScanLineStart, clearFrameSets, collectData, configure, countAsync, createsOwnFiles, getAttribute, getDescription, getDetectorID, getDetectorType, getFirstDataChannel, getInputNames, getMinimumReadoutDelay, getNumChannelsToRead, getScaler, getScalerName, getTotalChans, isTimeChannelRequired, readChannel, readChans, readFrame, readFrame, readout, readoutCurrentFrame, readoutFrames, setAttribute, setFirstDataChannel, setMinimumReadoutDelay, setNumChannelsToRead, setScaler, setScalerName, setTimeChannelRequired, start, stop

Methods inherited from class gda.device.detector.countertimer.TFGCounterTimer

isTFGv2, setTFGv2

Methods inherited from class gda.device.detector.countertimer.CounterTimerBase

getCurrentCycle, getCurrentFrame, getMaximumFrames, getStatus, getTimer, getTimerName, isSlave, loadFrameSets, restart, setCycles, setSlave, setTimer, setTimerName

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__, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, externalToInternal, getExtraNames, 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, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, 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

endCollection, getCollectionTime, getDataDimensions, getFileStructure, prepareForCollection, setCollectionTime, waitWhileBusy

Methods inherited from interface gda.device.Device

close, getProtectionLevel, 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, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, checkPositionValid, getExtraNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, toFormattedString

Constructor Details

TfgScalerWithDarkCurrent

public TfgScalerWithDarkCurrent()

Method Details

acquireDarkCurrent

public void acquireDarkCurrent()
                        throws Exception

Reads and sets the darkCurrent

Throws:

DeviceException

Exception

atScanStart

public void atScanStart()
                 throws DeviceException

Reads the dark current.

Specified by:

atScanStart in interface Scannable

Overrides:

atScanStart in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanStart()

atScanEnd

public void atScanEnd()
               throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the end of a group of nested scans (or a single scan if that is the case).

Note that this is only called if the Scan finishes normally, or has been requested to finish early. This will not be called if the scan finishes due to an exception of any kind. See Scannable.atCommandFailure() Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanEnd in interface Scannable

Overrides:

atScanEnd in class TfgScaler

Throws:

DeviceException

See Also:

• Scannable.atScanEnd()

setDarkCurrent

public void setDarkCurrent(DarkCurrentResults darkCurrent)

getDarkCurrentResults

public DarkCurrentResults getDarkCurrentResults()

Specified by:

getDarkCurrentResults in interface DarkCurrentDetector

Returns:

results from Dark Current reading, typically ordered I0, It, Iref

getDarkCurrent

public Double[] getDarkCurrent()

isDarkCurrentRequired

public boolean isDarkCurrentRequired()

setDarkCurrentRequired

public void setDarkCurrentRequired(boolean darkCurrentRequired)

setDarkCurrentCollectionTime

public void setDarkCurrentCollectionTime(Double darkCurrentCollectionTime)

getDarkCurrentCollectionTime

public Double getDarkCurrentCollectionTime()

isUseReset

public boolean isUseReset()

setUseReset

public void setUseReset(boolean useReset)

True by default, set to false if the shutter used to collect the dark current should not have reset called before opening.

Parameters:

useReset -

adjustForDarkCurrent

protected double[] adjustForDarkCurrent(double[] values,
 Double collectionTime)

adjustChannelForDarkCurrent

protected Double adjustChannelForDarkCurrent(Double rawCounts,
 Double dkCounts,
 Double collectionTime)