Package gda.data.scan.nexus.device

Class DummyNexusDetector

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.DummyDetector

gda.data.scan.nexus.device.DummyNexusDetector

All Implemented Interfaces:

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

public class DummyNexusDetector
extends DummyDetector
implements NexusDetector

A simple implementation of NexusDetector that produces an INexusTree with three main (primary) datasets of different ranks:

• data: a two-dimensional dataset (i.e. image);
• spectrum: a one-dimensional dataset;
• value_: a scalar dataset (i.e. single value). The underscore prevents a name clash with a dataset from a dummy monitor in some tests;
• external: a two-dimensional dataset written to an external file.
  The class was developed in order to test writing the INexusTree structure produced by a NexusDetector by NexusScanDataWriter and NexusDataWriter.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARRAY_ATTR_NAME
static final double[]	ARRAY_ATTR_VALUE
static final String	COLLECTION_ATTR_NAME
static final String	COLLECTION_ATTR_VALUE
static final String	COLLECTION_FIELD_NAME
static final String	COLLECTION_FIELD_VALUE
static final String	COLLECTION_NAME
static final String	DETECTOR_NAME
static final long	DETECTOR_NUMBER
static final double	DIAMETER
static final String	DIAMETER_UNITS
static final String	EXTERNAL_NEXUS_FILE_NAME
static final String	FIELD_NAME_EXTERNAL
static final String	FIELD_NAME_IMAGE_X
static final String	FIELD_NAME_IMAGE_Y
static final String	FIELD_NAME_SPECTRUM
static final String	FIELD_NAME_VALUE
static final String[]	FIELD_NAMES_EXTRA_NAMES
static final String	FLOAT_ATTR_NAME
static final double	FLOAT_ATTR_VALUE
static final String	GAIN_SETTING
static final int[]	IMAGE_SIZE
static final String	INT_ATTR_NAME
static final int	INT_ATTR_VALUE
static final String	NOTE_TEXT
static final String	SERIAL_NUMBER
static final int	SPECTRUM_SIZE
static final String	STRING_ATTR_NAME
static final String	STRING_ATTR_VALUE

Fields inherited from class gda.device.detector.DummyDetector

random

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

Method Summary

Modifier and Type	Method	Description
protected Object	acquireData()
List<String>	getPrimaryFieldNames()
NexusTreeProvider	readout()	Returns the latest data collected.
static void	saveNexusFile(TreeFile nexusTree)
void	setOutputDir(String outputDir)
void	setPrioritisedDataFieldName(String prioritisedDataFieldName)
void	setScanDimensions(int[] scanDimensions)

Methods inherited from class gda.device.detector.DummyDetector

collectData, configure, createsOwnFiles, getDescription, getDetectorID, getDetectorType, getMaxDataValue, getStatus, reconfigure, setMaxDataValue, setRandomSeed, waitWhileBusy

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

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

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

collectData, createsOwnFiles, endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getFileStructure, getStatus, 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, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString

Field Details

DETECTOR_NAME

public static final String DETECTOR_NAME

See Also:

• Constant Field Values

EXTERNAL_NEXUS_FILE_NAME

public static final String EXTERNAL_NEXUS_FILE_NAME

See Also:

• Constant Field Values

FIELD_NAME_SPECTRUM

public static final String FIELD_NAME_SPECTRUM

See Also:

• Constant Field Values

FIELD_NAME_VALUE

public static final String FIELD_NAME_VALUE

See Also:

• Constant Field Values

FIELD_NAME_EXTERNAL

public static final String FIELD_NAME_EXTERNAL

See Also:

• Constant Field Values

SPECTRUM_SIZE

public static final int SPECTRUM_SIZE

See Also:

• Constant Field Values

IMAGE_SIZE

public static final int[] IMAGE_SIZE

NOTE_TEXT

public static final String NOTE_TEXT

See Also:

• Constant Field Values

DETECTOR_NUMBER

public static final long DETECTOR_NUMBER

See Also:

• Constant Field Values

SERIAL_NUMBER

public static final String SERIAL_NUMBER

See Also:

• Constant Field Values

GAIN_SETTING

public static final String GAIN_SETTING

See Also:

• Constant Field Values

DIAMETER

public static final double DIAMETER

See Also:

• Constant Field Values

DIAMETER_UNITS

public static final String DIAMETER_UNITS

See Also:

• Constant Field Values

STRING_ATTR_NAME

public static final String STRING_ATTR_NAME

See Also:

• Constant Field Values

INT_ATTR_NAME

public static final String INT_ATTR_NAME

See Also:

• Constant Field Values

FLOAT_ATTR_NAME

public static final String FLOAT_ATTR_NAME

See Also:

• Constant Field Values

ARRAY_ATTR_NAME

public static final String ARRAY_ATTR_NAME

See Also:

• Constant Field Values

STRING_ATTR_VALUE

public static final String STRING_ATTR_VALUE

See Also:

• Constant Field Values

INT_ATTR_VALUE

public static final int INT_ATTR_VALUE

See Also:

• Constant Field Values

FLOAT_ATTR_VALUE

public static final double FLOAT_ATTR_VALUE

See Also:

• Constant Field Values

ARRAY_ATTR_VALUE

public static final double[] ARRAY_ATTR_VALUE

COLLECTION_NAME

public static final String COLLECTION_NAME

See Also:

• Constant Field Values

COLLECTION_FIELD_NAME

public static final String COLLECTION_FIELD_NAME

See Also:

• Constant Field Values

COLLECTION_ATTR_NAME

public static final String COLLECTION_ATTR_NAME

See Also:

• Constant Field Values

COLLECTION_FIELD_VALUE

public static final String COLLECTION_FIELD_VALUE

See Also:

• Constant Field Values

COLLECTION_ATTR_VALUE

public static final String COLLECTION_ATTR_VALUE

See Also:

• Constant Field Values

FIELD_NAMES_EXTRA_NAMES

public static final String[] FIELD_NAMES_EXTRA_NAMES

FIELD_NAME_IMAGE_X

public static final String FIELD_NAME_IMAGE_X

See Also:

• Constant Field Values

FIELD_NAME_IMAGE_Y

public static final String FIELD_NAME_IMAGE_Y

See Also:

• Constant Field Values

Constructor Details

DummyNexusDetector

public DummyNexusDetector()

Method Details

setScanDimensions

public void setScanDimensions(int[] scanDimensions)

setOutputDir

public void setOutputDir(String outputDir)

setPrioritisedDataFieldName

public void setPrioritisedDataFieldName(String prioritisedDataFieldName)

getPrimaryFieldNames

public List<String> getPrimaryFieldNames()

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 DummyDetector

Returns:

the data collected

Throws:

DeviceException

acquireData

protected Object acquireData()

Overrides:

acquireData in class DummyDetector

saveNexusFile

public static void saveNexusFile(TreeFile nexusTree)
                          throws NexusException

Throws:

NexusException