id4_common.callbacks.spec_data_file_writer

Module Contents

id4_common.callbacks.spec_data_file_writer.logger

id4_common.callbacks.spec_data_file_writer.iconfig

id4_common.callbacks.spec_data_file_writer.file_extension

id4_common.callbacks.spec_data_file_writer.spec_comment(comment, doc=None)

Make it easy for user to add comments to the data file.

id4_common.callbacks.spec_data_file_writer.newSpecFile(title, scan_id=None, RE=None)

User choice of the SPEC file name.

Cleans up title, prepends month and day and appends file extension. If RE is passed, then resets RE.md["scan_id"] = scan_id.

If the SPEC file already exists, then scan_id is ignored and RE.md["scan_id"] is set to the last scan number in the file.

id4_common.callbacks.spec_data_file_writer.init_specwriter_with_RE(RE)

Initialize specwriter with the run engine.

id4_common.callbacks.spec_data_file_writer.specwriter

The SPEC file writer object.