Package gda.device.detector

Class DetectorBase

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

All Implemented Interfaces:

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

Direct Known Subclasses:

ADCameraDetector, ADCMonitor, ADDetector, AnalyserBase, AsciiReaderDetector, BufferedEdeDetector, BufferedNXDetector, BufferedPandaDetector, BufferedScannablePositions, CoboldTDC, CounterTimerBase, DatasetNexusDetector, DataSocketDetector, DummyBufferedDetector, DummyDetector, DummyEtlDetector, DummyImageCreator, DummyMandelbrotMappingDetector, DummyPilatus, DummyScalarChannelDetector, DummyXmapBufferedDetector, DummyXspress3Detector, EdeDetectorBase, EDXD, EDXDController, EDXDElement, EpicsBekhoffAdc, EpicsDetector, EpicsFemtoWithBekhoffAdc, EpicsMCA2, EpicsMCACounterTimer, EpicsMultiChannelScaler, EpicsPilatus, EpicsScaler, EpicsScalerSimple, EpicsScanData, ETLDetector, GeFanuc110BLADC, HardwareTriggerableDetectorBase, I21Detector, IPPserver, MerlinDetector, MirrorCommissioningDetector, MjpegDetector, MythenDetectorImpl, NcdDetectorSystem, NXDetector, ODCCDController, OdinDetector, PandaDetector, PCO4000, PCODetector, PulseTube, QexafsFFoverIO, QexafsGMSDOverI0, RoiExtractor, SesoXbpmDetector, StepScanEdeDetector, TfgFFoverI0, TfgXMapFFoverI0, TimeResolvedTFGDetector, VGScientaAnalyserTotalOnly, VortexDetector, VortexQexafsFFIO, XesIf, Xmap, XmapBufferedDetector, XmapDetectorFromEpicsMca, Xspress2BufferedDetector, Xspress3BufferedDetector, Xspress3Detector, Xspress3FFoverI0BufferedDetector, Xspress3FFoverI0Detector, Xspress3QexafsDetector, Xspress4BufferedDetector, Xspress4Detector, XspressSystem, ZebraExternallyTriggeredDetector

public abstract class DetectorBase
extends ScannableBase
implements Serializable, Detector

Base class for all Detectors.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	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
DetectorBase()

Method Summary

Modifier and Type	Method	Description
void	asynchronousMoveTo(Object collectionTime)	Default implementation is to set the collection time and to call the collectData method
String	checkPositionValid(Object position)	By default, the position will be the collection time.
void	endCollection()	Default which should be overridden by subclasses.
double	getCollectionTime()	Returns the time, in seconds, the detector collects for during the next call to collectData()
int[]	getDataDimensions()	Default which should be overridden by subclasses.
String	getDescription()
String	getDetectorID()
String	getDetectorType()
Object	getPosition()	Returns the current position of the Scannable.
boolean	isBusy()	Check if the Scannable is moving/operating.
void	prepareForCollection()	Default which should be overridden by subclasses.
void	setCollectionTime(double collectionTime)	Sets the collection time, in seconds, to be used during the next call of collectData.
String	toFormattedString()	Returns a string representation of the Scannable and its current position/value/status

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, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, 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

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

collectData, createsOwnFiles, getFileStructure, getStatus, readout, waitWhileBusy

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

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

Field Details

collectionTime

protected double collectionTime

Constructor Details

DetectorBase

public DetectorBase()

Method Details

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

Returns:

double

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

Parameters:

collectionTime - the collection time in seconds

Throws:

DeviceException

getDataDimensions

public int[] getDataDimensions()
                        throws DeviceException

Default which should be overridden by subclasses.

Specified by:

getDataDimensions in interface Detector

Returns:

the dimensions of the data object returned by the Detector.readout() method

Throws:

DeviceException

See Also:

• Detector.getDataDimensions()

checkPositionValid

public String checkPositionValid(Object position)

By default, the position will be the collection time. So test to see if the supplied object can be converted to a double.

Specified by:

checkPositionValid in interface Scannable

Overrides:

checkPositionValid in class ScannableBase

Parameters:

position -

Returns:

null if position is valid, or returns a description if not.

See Also:

• Scannable.checkPositionValid(Object)

endCollection

public void endCollection()
                   throws DeviceException

Default which should be overridden by subclasses.

Specified by:

endCollection in interface Detector

Throws:

DeviceException

See Also:

• Detector.endCollection()

prepareForCollection

public void prepareForCollection()
                          throws DeviceException

Default which should be overridden by subclasses.

Specified by:

prepareForCollection in interface Detector

Throws:

DeviceException

See Also:

• Detector.prepareForCollection()

asynchronousMoveTo

public void asynchronousMoveTo(Object collectionTime)
                        throws DeviceException

Default implementation is to set the collection time and to call the collectData method

Specified by:

asynchronousMoveTo in interface Scannable

Overrides:

asynchronousMoveTo in class ScannableBase

Parameters:

collectionTime - Position to move to should have an element for each input field.

Throws:

DeviceException

See Also:

• Scannable.asynchronousMoveTo(java.lang.Object)

getPosition

public Object getPosition()
                   throws DeviceException

Returns the current position of the Scannable. Called by ConcurentScan at the end of the point. Reads an internal (hardware) position from rawGetPosition, converts this to an external (user) position and returns it. Also, if createsOwnFiles attempts to register the file with all FileRegistrars (primarily for data archiving). Note that this method will be called if the detector is triggered from a 'pos' command but not if the detector is triggered by the scan command (which ignores the detector's scannable interface).

Specified by:

getPosition in interface Scannable

Overrides:

getPosition in class ScannableBase

Returns:

Current position with an element for each input and extra field. null if their are no fields.

Throws:

DeviceException

See Also:

• Scannable.getPosition()

isBusy

public boolean isBusy()
               throws DeviceException

Check if the Scannable is moving/operating. default implementation is to call the getStatus method

Specified by:

isBusy in interface Scannable

Returns:

true - if operation carried out by moveTo has not completed yet

Throws:

DeviceException

See Also:

• Scannable.isBusy()

toFormattedString

public String toFormattedString()

Description copied from interface: Scannable

Returns a string representation of the Scannable and its current position/value/status

Typically should return:

name : position

or for detectors, name : status

If the position/status cannot be determined, the function should return Scannable.VALUE_UNAVAILABLE in its place.

Specified by:

toFormattedString in interface Scannable

Overrides:

toFormattedString in class ScannableBase

Returns:

string as defined above

getDescription

public String getDescription()
                      throws DeviceException

Specified by:

getDescription in interface Detector

Returns:

A description of the detector.

Throws:

DeviceException

getDetectorID

public String getDetectorID()
                     throws DeviceException

Specified by:

getDetectorID in interface Detector

Returns:

A identifier for this detector.

Throws:

DeviceException

getDetectorType

public String getDetectorType()
                       throws DeviceException

Specified by:

getDetectorType in interface Detector

Returns:

The type of detector.

Throws:

DeviceException