Skip to content

Commit

Permalink
Merge pull request #52 from biomarkersParkinson/tsdf_documentation
Browse files Browse the repository at this point in the history 
Improve the Tsdf documentation
  • Loading branch information
@Erikpostt
Erikpostt authored Nov 28, 2023
2 parents ef4bcd6 + 9ec52d4 commit 8d44032
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/tsdf_dbpd_channels_and_units.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,14 @@ Within the `DBPD` project, some of the field types are further specialised to pr

| `channel_type` name | Recommended `unit` | Description
|--------------------------|--------------------|------------------------------------------------------------------------------------|
| `time` | `time_relative_ms` | Time corresponding to each datapoint (also see units below) |
| `acceleration_x` | `m/s^2` | Acceleration along the x-axis. |
| `acceleration_y` | `m/s^2` | Acceleration along the y-axis. |
| `acceleration_z` | `m/s^2` | Acceleration along the z-axis. |
| `time` | `absolute_ms` | Time corresponding to the start of each window/segment (also see units below). |
| `acceleration_x` | `m/s^2` | Acceleration along the x-axis. |
| `acceleration_y` | `m/s^2` | Acceleration along the y-axis. |
| `acceleration_z` | `m/s^2` | Acceleration along the z-axis. |
| `rotation_x` | `deg/s` | Angular rotation rate around the x-axis. |
| `rotation_y` | `deg/s` | Angular rotation rate around the y-axis. |
| `rotation_z` | `deg/s` | Angular rotation rate around the z-axis. |
| `green` | `deg/s` | Green signal values indicate blood volume changes for physiological analysis. |


---
Expand Down Expand Up @@ -145,11 +146,12 @@ Within the `DBPD` project, some of the field types are further specialised to pr

| `unit_type` | Description |
|-----------------|-----------------------------------------------------------------------------------------------------|
| `time_relative_ms` | Time in milliseconds, relative to the `start_iso8601`. |
| `time_absolute_unix_s` | Absolute time in seconds, relative to unix epoch. |
| `time_absolute_unix_ms` | [TODO] Absolute time in milliseconds, relative to unix epoch. |
| `relative_ms` | Time (in milliseconds), relative to the `start_iso8601`, i.e., time elapsed since the start time of the recording. |
| `difference_ms` | Time (in milliseconds) elapsed since the previous sample. |
| `absolute_ms` | Absolute time in milliseconds, relative to Unix epoch. |
| `probability` | Probability values (0 to 1) indicating the likelihood of tremor activity for each sample. |
| `boolean_num` | `[TODO]` Integer values (0 or 1) representing the true (1) or false (0) presence of an activity. |
| `unitless` | Numerical values without units. |
| `m/s^2` | Acceleration in meters per second squared. |
| `deg/s` | Angular velocity in degrees per second. |

0 comments on commit 8d44032

Please sign in to comment.