From 55035310c4c2b8c4c9d3d464e35ca75db4982f9f Mon Sep 17 00:00:00 2001 From: Vedran Kasalica Date: Tue, 28 Nov 2023 11:30:03 +0100 Subject: [PATCH 1/2] Update the time description. --- docs/tsdf_dbpd_channels_and_units.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/tsdf_dbpd_channels_and_units.md b/docs/tsdf_dbpd_channels_and_units.md index 6c06a34..e26bf1e 100644 --- a/docs/tsdf_dbpd_channels_and_units.md +++ b/docs/tsdf_dbpd_channels_and_units.md @@ -12,7 +12,7 @@ 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) | +| `time` | `time_absolute_unix_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. | @@ -147,9 +147,10 @@ Within the `DBPD` project, some of the field types are further specialised to pr |-----------------|-----------------------------------------------------------------------------------------------------| | `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. | +| `time_absolute_unix_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. | + From 9ec52d41b4195ca963886323f4aadbca1cd99acc Mon Sep 17 00:00:00 2001 From: Vedran Kasalica Date: Tue, 28 Nov 2023 16:44:17 +0100 Subject: [PATCH 2/2] Update the tsdf units --- docs/tsdf_dbpd_channels_and_units.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/tsdf_dbpd_channels_and_units.md b/docs/tsdf_dbpd_channels_and_units.md index e26bf1e..89ba7da 100644 --- a/docs/tsdf_dbpd_channels_and_units.md +++ b/docs/tsdf_dbpd_channels_and_units.md @@ -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_absolute_unix_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. | +| `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. | --- @@ -145,9 +146,9 @@ 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` | 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. |