Skip to content

README update for clock resets and improve table formatting #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cbrnr merged 2 commits into from
Mar 14, 2025
Merged

README update for clock resets and improve table formatting #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48d25d4
README: Format data tables consistently
jamieforth Mar 10, 2025
d563bb3
README: Update clock_resets.xdf info
jamieforth Mar 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 148 additions & 48 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,21 +52,17 @@ Minimal example file with two streams.

#### Time-series data

Data:

```
[192, 255, 238],
[ 12, 22, 32],
[ 13, 23, 33],
[ 14, 24, 34],
[ 15, 25, 35],
[ 12, 22, 32],
[ 13, 23, 33],
[ 14, 24, 34],
[ 15, 25, 35]
```

Timestamps: 5.1 to 5.9 in .1 steps
| time_stamp | 0 | 1 | 2 |
|------------|-----|-----|-----|
| 5.1 | 192 | 255 | 238 |
| 5.2 | 12 | 22 | 32 |
| 5.3 | 13 | 23 | 33 |
| 5.4 | 14 | 24 | 34 |
| 5.5 | 15 | 25 | 35 |
| 5.6 | 12 | 22 | 32 |
| 5.7 | 13 | 23 | 33 |
| 5.8 | 14 | 24 | 34 |
| 5.9 | 15 | 25 | 35 |

These time-stamps precede the first clock offset measurement, but for
synchronization they will be handled with respect to the first (and
Expand Down Expand Up @@ -109,17 +105,27 @@ Identical to stream 0.

#### Time-series data

Data: `[ (the XML footer), 'Hello', 'World', 'from', 'LSL', 'Hello', 'World', 'from', 'LSL']`

Timestamps: as above
| time_stamp | 0 |
|------------|--------------|
| 5.1 | (XML footer) |
| 5.2 | Hello |
| 5.3 | World |
| 5.4 | from |
| 5.5 | LSL |
| 5.6 | Hello |
| 5.7 | World |
| 5.8 | from |
| 5.9 | LSL |

#### Clock offsets

No clock offsets, so synchronization will have no effect.


## clock\_resets.xdf
### Stream 1

1 `string` channel, 175 samples

#### Header

``` xml
Expand Down Expand Up @@ -151,7 +157,7 @@ No clock offsets, so synchronization will have no effect.
<info>
<first_timestamp>653153.2121885</first_timestamp>
<last_timestamp>259.6538279</last_timestamp>
<sample_count>174</sample_count>
<sample_count>175</sample_count>
<clock_offsets>
<offset>
<time>653156.02616855</time>
Expand All @@ -166,7 +172,43 @@ No clock offsets, so synchronization will have no effect.
</info>
```

#### Time-series data

| time_stamp | 0 |
|---------------|------------|
| 653153.212188 | XXX |
| 653156.001700 | Test |
| 653158.235593 | Blah |
| 653158.674409 | Test |
| 653161.255786 | Test-1-2-3 |
| … | … |
| 255.326187 | Test-1-2-3 |
| 255.794242 | Testtest |
| 257.288286 | Test |
| 258.881481 | Test-1-2-3 |
| 259.653828 | XXX |

#### Clock offsets

| time | value |
|---------------|-------------|
| 653156.026169 | -652340.284 |
| 653161.027235 | -652340.284 |
| 653166.028073 | -652340.284 |
| 653171.029007 | -652340.284 |
| 653176.029238 | -652340.284 |
| … | … |
| 244.642270 | 1121.166 |
| 249.642364 | 1121.166 |
| 254.642595 | 1121.166 |
| 259.642718 | 1121.166 |
| 264.643002 | 1121.166 |


### Stream 2

8 `float32` channels, 27815 samples

#### Header

``` xml
Expand All @@ -193,11 +235,12 @@ No clock offsets, so synchronization will have no effect.
```

#### Footer

``` xml
<info>
<first_timestamp>653150.379117</first_timestamp>
<last_timestamp>261.9267033</last_timestamp>
<sample_count>27814</sample_count>
<sample_count>27815</sample_count>
<clock_offsets>
<offset>
<time>653156.0261441499</time>
Expand All @@ -212,6 +255,39 @@ No clock offsets, so synchronization will have no effect.
</info>
```

#### Time-series data

| time_stamp | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 |
|---------------|-------|-------|-------|-------|-------|-------|-------|-------|
| 653150.314061 | 0.142 | 0.463 | 0.354 | 0.220 | 0.761 | 0.323 | 0.312 | 0.861 |
| 653150.324786 | 0.311 | 0.740 | 0.949 | 0.505 | 0.034 | 0.518 | 0.326 | 0.788 |
| 653150.335512 | 0.611 | 0.838 | 0.780 | 0.767 | 0.065 | 0.214 | 0.044 | 0.238 |
| 653150.346237 | 0.732 | 0.318 | 0.249 | 0.272 | 0.923 | 0.575 | 0.177 | 0.086 |
| 653150.356962 | 0.863 | 0.334 | 0.301 | 0.645 | 1.000 | 0.248 | 0.664 | 0.246 |
| … | … | … | … | … | … | … | … | … |
| 261.975481 | 0.418 | 0.359 | 0.277 | 0.898 | 0.627 | 0.562 | 0.021 | 0.015 |
| 261.986272 | 0.061 | 0.215 | 0.190 | 0.046 | 0.938 | 0.523 | 0.931 | 0.481 |
| 261.997063 | 0.792 | 0.337 | 0.299 | 0.959 | 0.023 | 0.603 | 0.620 | 0.861 |
| 262.007853 | 0.890 | 0.883 | 0.638 | 0.113 | 0.022 | 0.533 | 0.604 | 0.743 |
| 262.018644 | 0.873 | 0.064 | 0.684 | 0.153 | 0.306 | 0.123 | 0.711 | 0.892 |


#### Clock offsets

| time | value |
|---------------|-------------|
| 653156.026144 | -652340.284 |
| 653161.027186 | -652340.284 |
| 653166.028073 | -652340.284 |
| 653171.029031 | -652340.284 |
| 653176.029199 | -652340.284 |
| … | … |
| 244.637258 | 1121.166 |
| 249.637401 | 1121.166 |
| 254.637443 | 1121.166 |
| 259.638406 | 1121.166 |
| 264.638576 | 1121.166 |

## empty\_streams.xdf

Example containing empty and non-empty data and marker streams.
Expand Down Expand Up @@ -270,21 +346,21 @@ Example containing empty and non-empty data and marker streams.

#### Time-series data

| time_stamp | 0 |
|------------|--------------|
| 91725 | {"state": 2} |
| time_stamp | 0 |
|--------------|--------------|
| 91725.014004 | {"state": 2} |

#### Clock offsets

| time | value |
|---------|-------|
| 91716.7 | ≅0 |
| 91721.7 | ≅0 |
| 91726.7 | ≅0 |
| 91731.7 | ≅0 |
| 91736.7 | ≅0 |
| 91741.7 | ≅0 |
| 91746.7 | ≅0 |
| time | value |
|--------------|-------|
| 91716.691546 | ≅0 |
| 91721.691770 | ≅0 |
| 91726.692053 | ≅0 |
| 91731.692211 | ≅0 |
| 91736.692330 | ≅0 |
| 91741.692493 | ≅0 |
| 91746.692620 | ≅0 |

### Stream 2

Expand Down Expand Up @@ -340,7 +416,15 @@ Empty stream.

#### Clock offsets

As above.
| time | value |
|--------------|-------|
| 91716.691514 | ≅0 |
| 91721.691774 | ≅0 |
| 91726.692058 | ≅0 |
| 91731.692287 | ≅0 |
| 91736.692447 | ≅0 |
| 91741.692554 | ≅0 |
| 91746.692766 | ≅0 |

### Stream 3

Expand Down Expand Up @@ -402,7 +486,15 @@ Empty stream.

#### Clock offsets

As above.
| time | value |
|--------------|-------|
| 91716.691530 | ≅0 |
| 91721.691776 | ≅0 |
| 91726.692048 | ≅0 |
| 91731.692247 | ≅0 |
| 91736.692367 | ≅0 |
| 91741.692487 | ≅0 |
| 91746.692694 | ≅0 |

### Stream 4

Expand Down Expand Up @@ -464,19 +556,27 @@ As above.

#### Time-series data

| time_stamp | ch:00 |
|------------|-------|
| 91725.2 | 0 |
| 91726.2 | 1 |
| 91727.2 | 2 |
| 91728.2 | 3 |
| 91729.2 | 4 |
| 91730.2 | 5 |
| 91731.2 | 6 |
| 91732.2 | 7 |
| 91733.2 | 8 |
| 91734.2 | 9 |
| time_stamp | ch:00 |
|--------------|-------|
| 91725.213948 | 0 |
| 91726.213948 | 1 |
| 91727.213948 | 2 |
| 91728.213948 | 3 |
| 91729.213948 | 4 |
| 91730.213948 | 5 |
| 91731.213948 | 6 |
| 91732.213948 | 7 |
| 91733.213948 | 8 |
| 91734.213948 | 9 |

#### Clock offsets

As above.
| time | value |
|--------------|-------|
| 91716.691572 | ≅0 |
| 91721.691773 | ≅0 |
| 91726.692049 | ≅0 |
| 91731.692249 | ≅0 |
| 91736.692457 | ≅0 |
| 91741.692557 | ≅0 |
| 91746.692746 | ≅0 |