pyrex.io.HDF5Writer.add_analysis_metadata

HDF5Writer.add_analysis_metadata(name, metadata, index=None)

Writes the given metadata to the analysis metadata group at name.

Splits information in the metadata into string and float values and stores them in the appropriate datasets of the metadata group. Creates new attribute columns for attributes which have not yet been written. The name given will be forced into an appropriate analysis location if it isn’t already a valid location.

Parameters

namestr

Name of the metadata group to be written to. May contain the full path to the metadata group location.

metadatadict or list of dict

Dictionaries containing attribute column names as keys and float or string data as values.

indexint, optional

Additional index for specifying the row where metadata should be written, used by some higher-dimension metadata groups.

Raises

ValueError

If name is not an existing metadata group.