Name

Role

Data type

Exists?
A / O / NS

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

“mods.marin.nl/dispay/H5M/convention_0_1”

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..

Name

Role

Data type

Exists?
A / O / NS

Description

Convention / example

type

a

utf8

NS

type of signals in the set.

Value NS maps to “General”.

“General”, “Frequency”, “Time”

rawName

i

utf8

O

original signal set name if this had to be renamed to be used as valid hdf5 name.

description

i

utf8

NS

additional description of the set

(tbd)

parent

s

obj_ref

O

Link to parent signal set.

(tbd)

parentName

s

utf8

O

For information only: the name of the parent signal set.

dataScale

a

float64

A

Scale of the signal values in the set with respect to full scale

1.0 ( full scale)

23.456 (model scale)

0.023456 (larger than life)

waterDensityFactor

a

float64

NS

water density factor to be used for scaling data values to full scale.
Preferred ‘not specified’over a default value.

1.432

stepSize

i

float64

A

if one and only one master signal for all signals and it is equidistant a value; otherwise, NaN

In case of a time master this is the inverse of the sample rate.

dateTimeRecordingStart

a

iso_fmt

A

date and time of first sample of the time signal of measurement or simulation.
Required for time series only..

(tbd)

dateTimeRecordingEnd

a

iso_fmt

O

date and time of last sample of the time signal of the measurement or simulation.
(May disappear in future versions.)

(tbd)

projectNo

a

int32

A

projectnumber

“80220”

projectSubNo

i

int32

NS

subnumber

“368”

programNo

a

int32

A

test programme number

1

source

a

utf8

A

name of the source application or facility
Within one project each ‘programmeNo’  is a fixed combination with the ‘source’.

“SMB”, “ReFresco”

categoryNo

a

int32

A

Number of the test category used.

2

testNo

a

int32

A

Number of the test setup used.

3

experimentNo

a

int32

A

Number of the experiment settings used.

4

measurementNo

a

int32

A

Number of the actual measurement c.q. experiment execution

2

modelScale

a

float64

A

Scale of the model in this project. (Unrelated to the signal values in the set.)

23.456

notes

i

utf8

NS

Any additional information about this signal set.

(free text)

writeErrors

i

utf8[]

O

Specifies any errors that occurred while writing the signal set (group).

Name

Role

Data type

Exists?
A / O / NS

Description

Convention / example

rawName

i

utf8

O

original signal name if this had to be reformatted to be used as hdf5 name.

unit

a

unit_str

A

name of the unit of the signal. This defines the quantity of the experiment variable.

“m/s”, “-“, “rad”

signalType

a

prop_str

NS

defines the experiment variable or simulation property or the kind of quantity.

“velocity”, etc

“angular velocity”

description

i

utf8

A

description of the signal. More detail than name. E.g. the kind of quantity or experiment variable; whether it is an absolute value or a delta.

(tbd)

timeOffset

a

float64

NS

the time offset in seconds between real start time and the moment the timestamp is created.

order

a

int32

O

In case of frequency data specifies whether it is a first or second order effect or otherwise.

1: first order.

2: second order.

-1: Not applicable.

position

a

float64[3]

NS

location of the variable in the specified Coordinate System.

[0.0, 0.0, 0.0]

direction

a

float64[3]

NS

direction of the signal c.q. experiment variable in the specified CS. In case of a rotation it is the direction of the axis of rotation.

Roll in ACK:

[1.0,0.0,0.0]

Sway in ACK:

[0.0, 1.0, 0.0]

referenceSystem

a

utf8

NS

specifies in which Coordinate Sytem position and direction are given.

“ACK”, (todo: complete list)

signalSource

I

utf8

O

holds information about the sensor.

Depends on system used.
Value might be interpretable by a tool corresponding to the data source.

Also contains the original signal name from the measurement system.

(tbd)

channelNo

i

int32

O

if no sensor information is provided holds the channel number in case of measured data.

123

bases

s

obj_ref[]

O

List of object references to all datasets that are a master signal to this signal.

[objRef(“time”)]

baseNames

s

utf8[]

O

Names of the base signals (informational only. Not intended for rebuilding the datamodel)

notes

i

utf8

A

Any additional information about this signal.

(free text)

writeErrors

i

utf8[]

O

Specifies any errors that occurred while writing the signal (dataset). Mostly value errors.