id4_common.callbacks.nexus_data_file_writer

Write each run to a NeXus/HDF5 file.

Based on implementation from Sector 8 aps-8id-dys/bluesky

IMPORTANT See the note about waiting for the nxwriter to finish AFTER EACH ACQUISITION! https://bcda-aps.github.io/apstools/dev/api/_filewriters.html#apstools.callbacks.nexus_writer.NXWriter

Module Contents

id4_common.callbacks.nexus_data_file_writer.iconfig

id4_common.callbacks.nexus_data_file_writer.logger

id4_common.callbacks.nexus_data_file_writer.LAYOUT_VERSION = 'APS-POLAR-2024-10'

id4_common.callbacks.nexus_data_file_writer.NEXUS_RELEASE = 'v2022.07'

class id4_common.callbacks.nexus_data_file_writer.MyNXWriter

Bases: apstools.callbacks.NXWriterAPS

Modify the default behavior of NXWriter for XPCS.

external_files

write_root(filename)

Write the root group and set POLAR-specific NeXus version attributes.

write_entry()

Called after stop document has been received.

write_streams(parent)

group: /entry/instrument/bluesky/streams:NXnote

data from all the bluesky streams

id4_common.callbacks.nexus_data_file_writer.nxwriter

The NeXus file writer object.

id4_common.callbacks.nexus_data_file_writer.warn_missing