Versions Compared

Key

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

...

ExperimentIn 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.
H5MMARIN 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.
SignalMeasured, calculated or simulated variable; range of values.
Signal SetSet of signals grouped by one or more common properties. E.g. origin, experiment run, sample rate, sample count, timestamp.
Dependant SignalDependent 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

<data_type>[]Represents an array of the type <data_type> . A scalar is represented only by <data_type>

Anchor
hdf5dependencies
hdf5dependencies
2.1 HDF5 Dependencies

...

The signal set group contains a set of signals that are logically a single group. Such signals share common properties like number of samples andsample and sample rate. Which properties are common has to be determined by the consumer of the data; either a human or an application.


Name: HDF Group name of the set of signals.
Path: "/<signal set name>"

Attributes:

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 ( at full scale)

23.456 (model scale, smaller than full scale)

0.023456 (model scale, larger than full scale)

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

branchNoaint32ONumber of the acquisition branch. E.g, time traces from simulations where jumps to earlier points in time are possible.1
sequenceNoaint32OConsecutive number of the signal set wrt to other signal sets. E.g, time traces from simulations in a given branch result in consecutive sets each time the set of logged properties changes.13

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




Anchor
structure-signal
structure-signal
3.3 Signal : Dataset

...

Anchor
_Toc508720654
_Toc508720654
Anchor
_Toc508720655
_Toc508720655
Anchor
_Toc516237327
_Toc516237327
4.3 Data types

Each section entry in this section defines a specific type notation that is used in the chapter 'H5M Structure'.

...