Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Revision 16 17 (changes since 15 are marked blue)

Note before reading any further: This file format is still in development. Not all features and intended usages are supported yet by this standard. New features will be added gradually and lead to new versions of this standard.

Expand
titleRevision history ...
revisionon behalf ofdescription
17Dolphin / xSimulationadded attribute "branceNumber" to signal set. This speeds up reconstruction of simulation branch data.
16signal values in video replayadded attributes "maximum", "minimum", "mean" and "standardDeviation" to signal. This speeds up loading of signals corresponding to video.


Contents
1 Introduction
1.1 Intended usage
1.2 Supported features
2 Glossary
2.1 HDF5 Dependencies
3 H5M Structure
3.1 Root : Group "/"
3.2 Signal Set : Group
3.3 Signal : Dataset
4 H5M Data Descriptions
4.1 Naming conventions
4.2 Attributes
4.3 Data types
4.3.1 Default value
4.3.2 Strings: favour unicode (UTF-8) over ascii
4.3.3 iso_fmt
4.3.4 unit_str
4.3.5 prop_str
4.3.6 obj_ref
4.3.7 ds_type

...

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

brancheNumberaint32ONumber of the acquisition branch. E.g, time traces from simulations where jumps to earlier points in time are possible.1

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


...