Page History
...
| Experiment | In the context of this convention, any action that results in one or more signals that need to be stored. E.g. MMS2 Measurement, ReFresco Calculation, XMF Simulation, SHARK data analysis. |
|---|---|
| H5M | MARIN convention of structuring the content of a HDF5 container for Experiment Datasets. |
Base Signal Dimension Signal Master Signal | Independent value range. E.g. the timestamp values for a time series signal that correspond with each sample value. |
| Signal | Measured, calculated or simulated variable; range of values. |
| Signal Set | Set of signals grouped by one or more common properties. E.g. origin, experiment run, sample rate, sample count, timestamp. |
| Dependant Signal | Dependent value range. E.g. the sample values at each corresponding timestamp for a time series signal or the RAO value at certain values on several frequency axis. |
| A / O / NS | A: always (must be present) and always with a valid value – critical attribute NS: must be present, but may be “not specified” – not critical, but users should be aware if missing O: may be omitted, only specify if value is meaningful – optional |
| Anchor | ||||
|---|---|---|---|---|
|
...
The H5M content is structured as depicted in the diagram below.
Each tree node item will be explained in the next paragraphs in this chapter. The location of the item is defined by it's address in the HDF5 file, called path. Also all available attributes are specified per item.
| Anchor | ||||
|---|---|---|---|---|
|
...
- attributes that identify the used H5M format.
- zero or more HDF Groups for each set of signals.
- attributes that identify the provenance of the file.
Name: root
Path: "/"
Attributes:
Name | Role | Data type | Exists? | Description | Convention / example |
name | i | utf8 | A | Name of the convention; constant | “H5M” |
description | i | utf8 | A | Description of the format; constant.: | “HDF5 MARIN Datasets File” |
version | a | utf8 | A | H5M Format version number | “0.1” |
documentation | i | utf8 | A | Where to find this convention | |
hdf5Version | i | utf8 | A | Version of HDF5 | “1.8.19” |
libraryName | i | utf8 | A | Name of the library that performed the actual writing. In case of appending signal sets only the last editor is tracked. | “pymarin”, “Marin.Experiments.IO.H5M” |
libraryVersion | i | utf8 | A | Version of this library | e.g. “7.0.1” |
applicationName | i | utf8 | NS | Name of the application that wrote this file | “SHARK”, “SHARK: some vistrail.vt” |
applicationVersion | i | utf8 | NS | Version of this application used. | “0.0.20” |
systemName | i | utf8 | O | Name of the system running the application. This not necessarely the system that performed the experiment (e.g. measurement). | “LP3138”, “MMS2” |
systemVersion | i | utf8 | O | Version or configuration of this systtem | (tbd) |
dateTimeOfCreation | i | iso_fmt | A | Date and time of the moment the file was created. | ISO 8601 “2017-09-27 T21:13:00.012345” |
userName | i | utf8 | NS | Name of user / author | “user123” |
notes | i | utf8 | NS | Any additional notes at file level. | (free text) |
writeErrors | i | utf8[] | O | Specifies any errors that occurred while writing the file.. |
| Anchor | ||||
|---|---|---|---|---|
|
...
Overview
Content Tools