Package gda.data.scan.datawriter

Class NexusScanDataWriter

java.lang.Object

gda.data.scan.datawriter.DataWriterBase

gda.data.scan.datawriter.NexusScanDataWriter

All Implemented Interfaces:

DataWriter, IDataWriterExtender, INexusDataWriter

public class NexusScanDataWriter
extends DataWriterBase
implements INexusDataWriter

This nexus data writer makes use of the new nexus writing framework in the project org.eclipse.dawnsci.nexus. Note, a new instance of this class should be created for each scan.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ENTRY_NAME
static final String	FIELD_NAME_BEAMLINE
static final String	FIELD_NAME_END_STATION
static final String	METADATA_ENTRY_NAME_INSTRUMENT
static final String	PROPERTY_NAME_BEAMLINE_PREFIX	Boolean property specifying whether nxs/dat filenames should be prefixed with the beamline name; if true, files will be named (e.g.) "i23-999.nxs" instead of just "999.nxs"
static final String	PROPERTY_NAME_CREATE_FILE_AT_SCAN_START	Boolean property specifying whether to create the nexus file at the start of the scan rather than after the first point (i.e.
static final String	PROPERTY_NAME_ENTRY_NAME	The name of the NXentry.
static final String	PROPERTY_NAME_WRITE_SWMR	Boolean property specifying whether to enable SWMR mode (Single Write Multiple Read).
static final String	PROPERTY_VALUE_DATA_FORMAT_NEXUS_SCAN	Call LocalProperties.set(String, String) with property name LocalProperties.GDA_DATA_SCAN_DATAWRITER_DATAFORMAT and this value to use this nexus writer.

Fields inherited from class gda.data.scan.datawriter.DataWriterBase

delimiter, header, terminalPrinter

Constructor Summary

Constructors

Constructor	Description
NexusScanDataWriter()

Method Summary

Modifier and Type	Method	Description
void	addData(IScanDataPoint point)	for incremental addition of data
void	completeCollection()	Called when data collection has been completed
void	configureScanNumber(int scanNumber)	If filenumber not set then read from scandatapoint or from num tracker
String	getCurrentFileName()	Get the absFilePath for this scan
int	getCurrentScanIdentifier()	Get the current scan identifier (ie scan number)
String	getDataDir()	Returns the full path of the folder which data files are written to.
String	getNexusFileName()	The file name of the nexus file being written by this writer.
SwmrStatus	getSwmrStatus()	Returns a SwmrStatus object specifying the state of SWMR mode (single-write multiple-read) for the nexus file written by this writer.
void	scanStart(ScanInformation scanInfo, List<Scannable> scannables, List<Detector> detectors)	Called at the start of the scan with a ScanInformation object describing the scan (i.e.
void	setBeforeScanMetaData(INexusTree beforeScanMetadata)	Add an INexusTree to be written as before scan metadata.
void	setHeader(String header)	Sets the header of the datahandler
void	setNexusFileNameTemplate(String fileNameTemplate)	Sets the template to use for the filename.

Methods inherited from class gda.data.scan.datawriter.DataWriterBase

addData, addDataWriterExtender, completeCollection, getDetectorData, getDetectorData, getHeader, removeDataWriterExtender, setHeader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface gda.data.scan.datawriter.DataWriter

addDataWriterExtender, getHeader, removeDataWriterExtender, setHeader

Field Details

PROPERTY_VALUE_DATA_FORMAT_NEXUS_SCAN

public static final String PROPERTY_VALUE_DATA_FORMAT_NEXUS_SCAN

Call LocalProperties.set(String, String) with property name LocalProperties.GDA_DATA_SCAN_DATAWRITER_DATAFORMAT and this value to use this nexus writer.

PROPERTY_NAME_BEAMLINE_PREFIX

public static final String PROPERTY_NAME_BEAMLINE_PREFIX

Boolean property specifying whether nxs/dat filenames should be prefixed with the beamline name; if true, files will be named (e.g.) "i23-999.nxs" instead of just "999.nxs"

See Also:

• Constant Field Values

PROPERTY_NAME_WRITE_SWMR

public static final String PROPERTY_NAME_WRITE_SWMR

Boolean property specifying whether to enable SWMR mode (Single Write Multiple Read). If enabled, it is not possible to change the structure of the Nexus file after SWMR mode is enabled - this is done when the file is created by the first call to addData(IScanDataPoint).

See Also:

• Constant Field Values

PROPERTY_NAME_ENTRY_NAME

public static final String PROPERTY_NAME_ENTRY_NAME

The name of the NXentry. By default the name 'entry' is used. NexusDataWriter uses the name 'entry1'. Setting this property to 'entry1' will allow the use of scripts and tools with that value hard-coded. This should be a temporary measure, the name 'entry' should be considered to be the Diamond standard.

See Also:

• Constant Field Values

PROPERTY_NAME_CREATE_FILE_AT_SCAN_START

public static final String PROPERTY_NAME_CREATE_FILE_AT_SCAN_START

Boolean property specifying whether to create the nexus file at the start of the scan rather than after the first point (i.e. the first call to addData(IScanDataPoint)). Detectors in a scan must implement IWritableNexusDevice or override Detector.getFileStructure() to be compatible.

See Also:

• Constant Field Values

FIELD_NAME_BEAMLINE

public static final String FIELD_NAME_BEAMLINE

See Also:

• Constant Field Values

FIELD_NAME_END_STATION

public static final String FIELD_NAME_END_STATION

See Also:

• Constant Field Values

DEFAULT_ENTRY_NAME

public static final String DEFAULT_ENTRY_NAME

See Also:

• Constant Field Values

METADATA_ENTRY_NAME_INSTRUMENT

public static final String METADATA_ENTRY_NAME_INSTRUMENT

See Also:

• Constant Field Values

Constructor Details

NexusScanDataWriter

public NexusScanDataWriter()

Method Details

getCurrentFileName

public String getCurrentFileName()

Description copied from interface: DataWriter

Get the absFilePath for this scan

Specified by:

getCurrentFileName in interface DataWriter

Returns:

String

getCurrentScanIdentifier

public int getCurrentScanIdentifier()

Description copied from interface: DataWriter

Get the current scan identifier (ie scan number)

Specified by:

getCurrentScanIdentifier in interface DataWriter

Returns:

String

configureScanNumber

public void configureScanNumber(int scanNumber)

Description copied from class: DataWriterBase

If filenumber not set then read from scandatapoint or from num tracker

Specified by:

configureScanNumber in interface DataWriter

Overrides:

configureScanNumber in class DataWriterBase

Parameters:

scanNumber -

setNexusFileNameTemplate

public void setNexusFileNameTemplate(String fileNameTemplate)

Description copied from interface: INexusDataWriter

Sets the template to use for the filename. This should use the string String.format(String, Object...) pattern, with a single format specifier %s, e.g. ixx-%d.nxs.

Specified by:

setNexusFileNameTemplate in interface INexusDataWriter

Parameters:

fileNameTemplate -

getNexusFileName

public String getNexusFileName()

Description copied from interface: INexusDataWriter

The file name of the nexus file being written by this writer.

Specified by:

getNexusFileName in interface INexusDataWriter

Returns:

file name of nexus file

getDataDir

public String getDataDir()

Description copied from interface: INexusDataWriter

Returns the full path of the folder which data files are written to.

Specified by:

getDataDir in interface INexusDataWriter

Returns:

the full path of the folder which data files are written

getSwmrStatus

public SwmrStatus getSwmrStatus()

Description copied from interface: INexusDataWriter

Returns a SwmrStatus object specifying the state of SWMR mode (single-write multiple-read) for the nexus file written by this writer. See the javadoc for SwmrStatus for details.

Specified by:

getSwmrStatus in interface INexusDataWriter

Returns:

the SwmrStatus

setHeader

public void setHeader(String header)

Description copied from interface: DataWriter

Sets the header of the datahandler

Specified by:

setHeader in interface DataWriter

Parameters:

header - String

setBeforeScanMetaData

public void setBeforeScanMetaData(INexusTree beforeScanMetadata)

Description copied from interface: INexusDataWriter

Add an INexusTree to be written as before scan metadata. TODO: do we need this method. It doesn't seem to be used, but may potentially be useful?

Specified by:

setBeforeScanMetaData in interface INexusDataWriter

Parameters:

beforeScanMetadata -

scanStart

public void scanStart(ScanInformation scanInfo,
 List<Scannable> scannables,
 List<Detector> detectors)
               throws NexusException

Description copied from interface: DataWriter

Called at the start of the scan with a ScanInformation object describing the scan (i.e. detector names, scannable names, scan dimensions) as well as the actual scannable and detector objects themselves

Specified by:

scanStart in interface DataWriter

Parameters:

scanInfo - describes the scan

scannables - the scannables in the scan

detectors - the detectors in the scan

Throws:

NexusException

addData

public void addData(IScanDataPoint point)
             throws Exception

Description copied from interface: DataWriter

for incremental addition of data

Specified by:

addData in interface DataWriter

Overrides:

addData in class DataWriterBase

Parameters:

point - Object

Throws:

Exception

completeCollection

public void completeCollection()
                        throws Exception

Description copied from interface: DataWriter

Called when data collection has been completed

Specified by:

completeCollection in interface DataWriter

Overrides:

completeCollection in class DataWriterBase

Throws:

Exception