Skip to content

Commit 471a9f2

Browse files
committed
header example clarification
1 parent 7fdd573 commit 471a9f2

1 file changed

Lines changed: 20 additions & 15 deletions

File tree

spec/header-files.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -43,27 +43,29 @@ The first non-comment line is the **record line**, which provides metadata about
4343

4444
### Examples
4545

46-
#### Basic header (uniform sampling frequency)(record 100 from the [MIT-BIH database](https://www.physionet.org/content/mitdb)):
47-
46+
**Basic header (uniform sampling frequency):**
47+
record 100 from the [MIT-BIH database](https://www.physionet.org/content/mitdb)
4848
```text
4949
100 2 360 650000
5050
```
51+
5152
- `100`: Record name (must match the filename prefix).
5253
- `2`: Number of signals in the record.
5354
- `360`: Sampling frequency in Hz.
54-
- `650000`: Total samples for each signal.
55+
- `650000`: Number of samples for each signal.
5556

56-
#### Multi-frequency header (unique sampling rates per channel):
57+
**Multi-frequency header (unique sampling rates per channel):**
5758

5859
```text
5960
12345 3 62.5 625 12:00:00 30/01/1989
6061
```
62+
6163
- `12345`: Record name (must match the filename prefix).
6264
- `3`: Number of signals in the record.
6365
- `62.5`: Sampling frequency in Hz.
64-
- `625`: Total frames for each signal. When `samps_per_frame` = 1 (default), this will be the total samples.
65-
- `12:00:00`: The time (`base_time`).
66-
- `30/01/1989`: The date (`base_date`).
66+
- `625`: Number of samples. For multi-frequency records this is the total frames for each signal.
67+
- `12:00:00`: Base time.
68+
- `30/01/1989`: Base date.
6769

6870
---
6971

@@ -90,37 +92,40 @@ Each signal has its own line immediately following the record line (for single-s
9092

9193
### Examples
9294

93-
#### Basic header (uniform sampling frequency)(record 100 from the [MIT-BIH database](https://www.physionet.org/content/mitdb)):
95+
**Basic header (uniform sampling frequency):**
96+
record 100 from the [MIT-BIH database](https://www.physionet.org/content/mitdb)
9497
```text
9598
100.dat 212 200 11 1024 995 -22131 0 MLII
9699
100.dat 212 200 11 1024 1011 20052 0 V5
97100
```
98-
- `100.dat`: Filename of the signal file.
99-
- `212`: Storage format (12-bit two's complement).
101+
102+
- `100.dat`: File name of the signal file.
103+
- `212`: Format samples are stored in (12-bit two's complement).
100104
- `200`: ADC gain (i.e. number of digital values per physical unit).
101105
- `11`: ADC resolution (bits).
102106
- `1024`: ADC zero value.
103107
- `995`, `1011`: Initial value.
104108
- `-22131`, `20052`: Checksum (sum of all signal samples modulo 2^16).
105109
- `0`: Block size.
106-
- `MLII`, `V5`: Signal labels (e.g., lead names).
110+
- `MLII`, `V5`: Description (e.g., signal lead names).
107111

108-
#### Multi-frequency header (unique sampling rates per channel):
112+
**Multi-frequency header (unique sampling rates per channel):**
109113
```text
110114
12345.dat 16x4 200/μV 12 0 0 2178 0 ECG
111115
12345.dat 16x2 16/mmHg 12 0 0 3497 0 ICP
112116
12345.dat 16x1 2500/Ohm 12 0 0 1366 0 RESP
113117
```
114-
- `12345.dat`: Filename of the signal file.
115-
- `16`: Storage format (16-bit integers).
118+
119+
- `12345.dat`: File name of the signal file.
120+
- `16`: Format samples are stored in (16-bit integers).
116121
- `x4`,`x2`,`x1`: 4, 2, and 1 samples per frame, respectively. This indicates that the ECG signal has `157 * 4 = 628` samples while the ICP signal has 314 samples and the RESP signal has 157 samples.
117122
- `200/μV`, `16/mmHg`, `2500/Ohm`: ADC gain (i.e., number of digital values per physical unit).
118123
- `12`: ADC resolution (bits).
119124
- `0`: ADC zero value.
120125
- `0`: Initial value.
121126
- `2178 `, `3497`, `1366`: Checksum (sum of all signal samples modulo 2^16).
122127
- `0`: Block size.
123-
- `ECG`, `ICP`, `RESP`: Signal labels (e.g., lead names).
128+
- `ECG`, `ICP`, `RESP`: Description (e.g., signal lead names).
124129

125130
---
126131

0 commit comments

Comments
 (0)