HDF5 writer plugin

The EDD.hdf5_writer collection records supported EDD streams in HDF5. The supplied version 1.0.1 supports GatedSpectrometer:2 inputs and uses one HDF5 group per scan. It is a measuring pipeline.

Role

EDD.hdf5_writer.hdf5_writer

Default product

hdf5_writer

File behaviour

Each measurement prepare selects a file. Scans are stored below consecutively numbered scan/NNN groups. Measurement stop flushes and closes the file and registers it as an output. History metadata records the writer version and date.

Configuration

Key

Default

Meaning

input_data_streams

format examples

Streams to serialize. Each may set hdf5_group_prefix.

chunksize

auto

HDF5 chunking policy; tune only with representative data and storage.

default_hdf5_group_prefix

S

Prefix used when the stream does not specify one.

enable_plotting

true

Generate live bandpass diagnostics.

use_date_based_subfolders

true

Store files below YYYY/MM/DD directories.

measurement_prepare_default.new_file

false

Create a new file instead of appending another scan group.

measurement_prepare_default.filename

null

Explicit filename or automatic generation.

measurement_prepare_default.file_id

null

Identifier included in an automatically generated filename.

Monitor complete and incomplete heaps, written package count, writer-process health, disk rate, free space, and the bandpass diagnostic. Any incomplete heap count must be explained before accepting the data. The writer only supports formats with a registered handler; a matching SPEAD transport alone is not sufficient.