Package gda.device.detector.xmap

Class CallableXmap

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.xmap.Xmap

gda.device.detector.xmap.XmapwithSlaveMode

gda.device.detector.xmap.NexusXmap

gda.device.detector.xmap.CallableXmap

All Implemented Interfaces:

Detector, NexusDetector, Device, Scannable, PositionCallableProvider<NexusTreeProvider>, XmapDetector, Configurable, Findable, gda.observable.IObservable, gda.observable.IObserver, Serializable, DetectorWithConfigurationFile

public class CallableXmap
extends NexusXmap
implements PositionCallableProvider<NexusTreeProvider>

See Also:

• Serialized Form

Field Summary

Fields inherited from class gda.device.detector.xmap.Xmap

channelLabels, controller, elapsedRealTimeValue, eventProcessingTimes, saveRawSpectrum, tfg, vortexParameters

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

Method Summary

Modifier and Type	Method	Description
Callable<NexusTreeProvider>	getPositionCallable()
NexusTreeProvider	readout()	Returns the latest data collected.

Methods inherited from class gda.device.detector.xmap.NexusXmap

atCommandFailure, atScanStart, collectData, getCollectionMode, getDataDimensions, getExtraNames, getNumberOfIncludedDetectors, getOutputFormat, getPosition, getSleepTimeBeforeReadoutMs, getVortexParameters, isAlwaysRecordRawMCAs, isCaclulateUnifiedRois, isHardwareTriggeredMode, isSumAllElementData, loadConfigurationFromFile, setAlwaysRecordRawMCAs, setCalculateUnifiedRois, setCollectionMode, setHardwareTriggeredMode, setSleepTimeBeforeReadoutMs, setSumAllElementData, setupForHardwareTriggeredCollection, setupForSoftwareTriggeredCollection

Methods inherited from class gda.device.detector.xmap.XmapwithSlaveMode

isSlave, setSlave

Methods inherited from class gda.device.detector.xmap.Xmap

atScanEnd, clear, clearAndStart, configure, configureChannelLabels, configureRegionsOfInterest, createsOwnFiles, getAcquisitionTime, getAttribute, getChannelLabels, getCollectionTime, getConfigFileName, getController, getCountRates, getData, getData, getDeadTimeCorrectedROICounts, getDeadtimeCorrectionFactors, getDescription, getDetectorID, getDetectorType, getEventProcessingTimes, getK, getName, getNumberOfBins, getNumberOfMca, getNumberOfROIs, getReadRate, getRealTime, getROICounts, getROIsSum, getStatus, getStatusRate, getTfg, getXmapControllerName, isSaveRawSpectrum, readoutScalerData, readoutScalers, reconfigure, setAcquisitionTime, setCollectionTime, setConfigFileName, setController, setEventProcessingTimes, setName, setNthROI, setNumberOfBins, setNumberOfMca, setNumberOfROIs, setParameters, setParameters, setReadRate, setReadRate, setROI, setROIs, setSaveRawSpectrum, setStatusRate, setStatusRate, setTfg, setXmapControllerName, start, stop, update, waitWhileControllerBusy

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, isBusy, prepareForCollection, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, atScanLineStart, externalToInternal, getInputNames, getLevel, 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, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

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

createsOwnFiles, endCollection, getCollectionTime, getDescription, getDetectorID, getDetectorType, getFileStructure, prepareForCollection, setCollectionTime, 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

asynchronousMoveTo, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, checkPositionValid, getInputNames, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, toFormattedString

Constructor Details

CallableXmap

public CallableXmap()

Method Details

getPositionCallable

public Callable<NexusTreeProvider> getPositionCallable()
                                                throws DeviceException

Specified by:

getPositionCallable in interface PositionCallableProvider<NexusTreeProvider>

Throws:

DeviceException

readout

public NexusTreeProvider readout()
                          throws DeviceException

Description copied from interface: Detector

Returns the latest data collected. The size of the Object returned must be consistent with the values returned by getDataDimensions and getExtraNames.

If LocalProperties.GDA_SCAN_CONCURRENTSCAN_READOUT_CONCURRENTLY is true then motors may be moved while the detector readouts. The value returned must not be effected by any concurrent motor or shutter movements. See Detector.waitWhileBusy() and ConcurrentScan. Readout must block until the detector is ready to respond quickly to Detector.collectData() again.

Specified by:

readout in interface Detector

Specified by:

readout in interface NexusDetector

Overrides:

readout in class NexusXmap

Returns:

the data collected

Throws:

DeviceException