Skip to content

Commit 324b428

Browse files
committed
(fixup) Minor clean-up
1 parent efccb8b commit 324b428

1 file changed

Lines changed: 3 additions & 7 deletions

File tree

docs/data_format.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A continuous DAQ recording over a period of time is a *run* and includes all the
2121
structured HDF5 in a single directory. Here these files follow a naming pattern::
2222

2323
RAW-R0348-AGIPD04-S00002.h5
24-
24+
2525
which denotes the HDF5 file with ``raw`` data for sequence ``2`` of the aggregator
2626
``AGIPD04`` in run ``348``. Within a run the grouping of sources into aggregators
2727
does not change. Each *proposal* can collect any number of runs during their granted
@@ -54,7 +54,7 @@ device naming convention [2]_ for source names.
5454
naming convention, control sources should follow the pattern ``DOMAIN/TYPE/MEMBER``.
5555
Their data is saved in the ``CONTROL`` and ``RUN`` top-level groups described
5656
further below.
57-
57+
5858
* Instrument sources represent momentary data that is only valid for a single train
5959
or pulse. This covers most scientific detectors such as digitizers, cameras and
6060
more. These sources are never guaranteed to have data for every train, but may
@@ -67,8 +67,6 @@ device naming convention [2]_ for source names.
6767
In files however, a Karabo pipeline source may have different entries based on
6868
this ``ROOT``.
6969

70-
[insert reference for train structure somewhere?]
71-
7270

7371
HDF5 file structure
7472
-------------------
@@ -77,8 +75,6 @@ Every HDF5 file must contain the top-level groups ``METADATA`` and ``INDEX``.
7775
Depending on the included sources, there may additionally be the groups
7876
``CONTROL``, ``RUN`` and ``INSTRUMENT``.
7977
[note 1: is this clear enough it may be a combination of those?]
80-
[note 2: based on actual files, ``RUN`` seems to always be there even without
81-
``CONTROL`` albeit empty, move it to the first list?]
8278

8379

8480
METADATA
@@ -87,7 +83,7 @@ METADATA
8783
The ``METADATA`` group in an HDF5 file contains auxiliary information as
8884
individual datasets, most of which are constant across a run and or even
8985
proposal. Some of these datasets may not be present in any given file depending
90-
on how it was created.
86+
on how it was created.
9187

9288
This list contains all the datasets to be expected for data recorded with the
9389
EuXFEL DAQ software. Even when only containing a single entry, all these datasets

0 commit comments

Comments
 (0)