Package org.opengda.detector.electronanalyser.nxdetector

Class AbstractWriteRegionsImmediatelyNXDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.NXDetector

org.opengda.detector.electronanalyser.nxdetector.AbstractWriteRegionsImmediatelyNXDetector

All Implemented Interfaces:

Detector, NexusDetector, NXPluginDetector, Device, Scannable, PositionCallableProvider<NexusTreeProvider>, Configurable, Findable, gda.observable.IObservable, Serializable, INexusDevice<NXdetector>, IWritableNexusDevice<NXdetector>, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

SpecsPhoibosSolsticeAnalyser, VGScientaAnalyserNXDetector

public abstract class AbstractWriteRegionsImmediatelyNXDetector
extends NXDetector
implements IWritableNexusDevice<NXdetector>

See Also:

• Serialized Form

Field Summary

Fields inherited from class gda.device.detector.NXDetector

lastReadoutValue, UNSUPPORTED_PART_OF_SCANNABLE_INTERFACE, UNSUPPORTED_SET_FUNCTION

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 org.eclipse.dawnsci.nexus.IWritableNexusDevice

SCALAR_DATASET_SHAPE

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
AbstractWriteRegionsImmediatelyNXDetector()

Method Summary

Modifier and Type	Method	Description
void	atScanStart()	Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case)
protected abstract void	beforeCollectData()
void	collectData()	Tells the detector to begin to collect a set of data, then returns immediately.
abstract double	getCollectionTime()	Returns the time, in seconds, the detector collects for during the next call to collectData()
protected NXdetectorAndSliceIteratorStorage	getDataStorage()
String	getDescription()
String	getDetectorID()
String	getDetectorType()
List<NexusObjectProvider<NXdetector>>	getNexusProviders(NexusScanInfo info)	Returns the object providers required for writing correct NeXus files.
protected abstract NexusObjectWrapper<NXdetector>	initialiseAdditionalNXdetectorData(NXdetector detector, NexusScanInfo info)
void	scanEnd()	Called at the end of a scan.
void	setClientFileAnnouncer(ClientFileAnnouncer clientFileAnnouncer)
void	setCollectionStrategy(NXCollectionStrategyPlugin nxCollectionStrategyPlugin)
void	setCollectionTime(double value)	Sets the collection time, in seconds, to be used during the next call of collectData.
protected void	setDataStorage(NXdetectorAndSliceIteratorStorage dataStorage)
void	setDescription(String description)
void	setDetectorID(String detectorID)
abstract void	setSequenceFile(String sequenceFilename)
protected abstract void	setupAdditionalDataAxisFields(NexusObjectWrapper<?> nexusWrapper, int scanRank)	Setup the axis fields for the datasets that will be added to NXData groups.

Methods inherited from class gda.device.detector.NXDetector

__getattr__, __str__, afterPropertiesSet, asynchronousMoveTo, atCommandFailure, atScanEnd, atScanLineEnd, atScanLineStart, createsOwnFiles, endCollection, getAdditionalPluginList, getCollectionStrategy, getExtraNames, getFileStructure, getInputNames, getOutputFormat, getPlugin, getPluginList, getPluginMap, getPosition, getPositionCallable, getStatus, isAddCollectTimeMs, isBusy, prepareCollectionStrategyAtScanStart, prepareForCollection, readout, setAddCollectTimeMs, setAdditionalPluginList, setExtraNames, setInputNames, setOutputFormat, stop, waitWhileBusy

Methods inherited from class gda.device.detector.DetectorBase

checkPositionValid, getDataDimensions, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, externalToInternal, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setLevel, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, 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

getDataDimensions

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 org.eclipse.dawnsci.nexus.INexusDevice

getCustomNexusModification, getName, getNexusProvider, register

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface org.eclipse.dawnsci.nexus.IWritableNexusDevice

writePosition

Methods inherited from interface gda.device.Scannable

atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, checkPositionValid, getLevel, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setLevel, setScanMetadataAttribute, setScanMetadataAttributes, toFormattedString

Constructor Details

AbstractWriteRegionsImmediatelyNXDetector

public AbstractWriteRegionsImmediatelyNXDetector()

Method Details

setCollectionStrategy

public void setCollectionStrategy(NXCollectionStrategyPlugin nxCollectionStrategyPlugin)

Specified by:

setCollectionStrategy in interface NXPluginDetector

Overrides:

setCollectionStrategy in class NXDetector

setSequenceFile

public abstract void setSequenceFile(String sequenceFilename)
                              throws DeviceException,
FileNotFoundException

Throws:

DeviceException

FileNotFoundException

initialiseAdditionalNXdetectorData

protected abstract NexusObjectWrapper<NXdetector> initialiseAdditionalNXdetectorData(NXdetector detector,
 NexusScanInfo info)

getNexusProviders

public List<NexusObjectProvider<NXdetector>> getNexusProviders(NexusScanInfo info)
                                                        throws NexusException

Description copied from interface: INexusDevice

Returns the object providers required for writing correct NeXus files. Implement this method if your device needs to create multiple nexus objects. These can implement NexusObjectProvider

The default implementation of this method calls INexusDevice.getNexusProvider(NexusScanInfo) and returns a List whose sole element is the NexusObjectProvider returned from that method. One of either this method or INexusDevice.getNexusProviders(NexusScanInfo) must be overridden to create and return the nexus object(s) for this INexusDevice.

Specified by:

getNexusProviders in interface INexusDevice<NXdetector>

Parameters:

info - information about the scan which can be useful when creating datasets e.g. info.getRank()

Returns:

The NXobject created using the nodeFactory to represent this device

Throws:

NexusException - if the nexus object could not be created for any reason

setupAdditionalDataAxisFields

protected abstract void setupAdditionalDataAxisFields(NexusObjectWrapper<?> nexusWrapper,
 int scanRank)

Setup the axis fields for the datasets that will be added to NXData groups. Come under _indicies. Important so that datasets correctly plot and won't crop an axis.

Parameters:

nexusWrapper - to add the axis fields too

scanRank - information about the scan dimensions

atScanStart

public void atScanStart()
                 throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanStart in interface Scannable

Overrides:

atScanStart in class NXDetector

Throws:

DeviceException

See Also:

• Scannable.atScanStart()

beforeCollectData

protected abstract void beforeCollectData()
                                   throws DeviceException

Throws:

DeviceException

collectData

public void collectData()
                 throws DeviceException

Description copied from interface: Detector

Tells the detector to begin to collect a set of data, then returns immediately. Should cause the hardware to start collecting immediately: if there is any delay then detectors used in the same scan would collect over different times when beam conditions may differ.

Specified by:

collectData in interface Detector

Overrides:

collectData in class NXDetector

Throws:

DeviceException

scanEnd

public void scanEnd()

Description copied from interface: IWritableNexusDevice

Called at the end of a scan. The implementation should use this to clear up any state, such as closing any files and releasing any cached datasets so that this device can be used in subsequent scans.

Specified by:

scanEnd in interface IWritableNexusDevice<NXdetector>

setClientFileAnnouncer

public void setClientFileAnnouncer(ClientFileAnnouncer clientFileAnnouncer)

getDataStorage

protected NXdetectorAndSliceIteratorStorage getDataStorage()

setDataStorage

protected void setDataStorage(NXdetectorAndSliceIteratorStorage dataStorage)

getCollectionTime

public abstract 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

Overrides:

getCollectionTime in class DetectorBase

Returns:

double

Throws:

DeviceException

setCollectionTime

public void setCollectionTime(double value)
                       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

Overrides:

setCollectionTime in class DetectorBase

Parameters:

value - the collection time in seconds

Throws:

DeviceException

getDetectorType

public String getDetectorType()
                       throws DeviceException

Specified by:

getDetectorType in interface Detector

Overrides:

getDetectorType in class DetectorBase

Returns:

The type of detector.

Throws:

DeviceException

getDescription

public String getDescription()
                      throws DeviceException

Specified by:

getDescription in interface Detector

Overrides:

getDescription in class DetectorBase

Returns:

A description of the detector.

Throws:

DeviceException

setDescription

public void setDescription(String description)

getDetectorID

public String getDetectorID()
                     throws DeviceException

Specified by:

getDetectorID in interface Detector

Overrides:

getDetectorID in class DetectorBase

Returns:

A identifier for this detector.

Throws:

DeviceException

setDetectorID

public void setDetectorID(String detectorID)