pyrex.io.HDF5Writer.create_analysis_metadataset

HDF5Writer.create_analysis_metadataset(name, *args, **kwargs)

Create the given analysis metadata group in the file.

Creates metadata groups with ‘float’ and ‘str’ datasets. The name given will be forced into an appropriate analysis location if it isn’t already a valid location. If the given metadata group already exists, will simply return the existing group rather than recreating it.

Parameters

namestr

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

shapetuple of int, optional

Shape of the metadata datasets to be created for analysis metadata (not including the attribute dimension). Attribute dimension only by default.

maxshapetuple of int, optional

Maxshape of the metadata datasets to be created for analysis metadata (not including the attribute dimension). No limits by default.

Returns

group

The group object corresponding to the created (or existing) metadata group requested (containing ‘float’ and ‘str’ datasets).