From e219daf96c384dbd5693e274a4cf9f0051e00cc7 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 28 Sep 2023 18:55:22 +0000 Subject: [PATCH] Deployed 0ae6fe1 with MkDocs version: 1.5.2 --- 404.html | 23 +- .../index.html | 568 ++----- contact/index.html | 28 +- converting_legacy_data/index.html | 1290 ++++++++++++++++ data/example_binary.bin | Bin 0 -> 60 bytes data/example_meta.json | 30 + data/ppp_format_meta_legacy.json | 58 + index.html | 31 +- installation/index.html | 38 +- sitemap.xml | 19 +- sitemap.xml.gz | Bin 268 -> 314 bytes tsdf_fields_table/index.html | 42 +- validating_files/index.html | 1293 ++++++++++++++++ writing_data_from_scratch/index.html | 1345 +++++++++++++++++ 14 files changed, 4296 insertions(+), 469 deletions(-) rename {processing_example => basic_reading_and_writing}/index.html (95%) create mode 100644 converting_legacy_data/index.html create mode 100644 data/example_binary.bin create mode 100644 data/example_meta.json create mode 100644 data/ppp_format_meta_legacy.json create mode 100644 validating_files/index.html create mode 100644 writing_data_from_scratch/index.html diff --git a/404.html b/404.html index b699d92..1b8ceaf 100644 --- a/404.html +++ b/404.html @@ -33,20 +33,29 @@ +

The format

+

Usage

+

About

diff --git a/processing_example/index.html b/basic_reading_and_writing/index.html similarity index 95% rename from processing_example/index.html rename to basic_reading_and_writing/index.html index 1f017b7..1388c9d 100644 --- a/processing_example/index.html +++ b/basic_reading_and_writing/index.html @@ -3,18 +3,18 @@ - + - Usage Examples - tsdf + Basic reading and writing - tsdf + + + + + + +
+ + +
+ +
+
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/data/example_binary.bin b/data/example_binary.bin new file mode 100644 index 0000000000000000000000000000000000000000..be558becf19bead136a8365764e20d361759af65 GIT binary patch literal 60 tcmW-X2@U`t2*U~@#Q%TTYL+d#nqZM^bvUM?L6@TKLe~F`&GYHL#RU&80DAxc literal 0 HcmV?d00001 diff --git a/data/example_meta.json b/data/example_meta.json new file mode 100644 index 0000000..1c0bd7d --- /dev/null +++ b/data/example_meta.json @@ -0,0 +1,30 @@ +{ + "subject_id": "dummy", + "study_id": "dummy", + "device_id": "dummy", + "endianness": "little", + "metadata_version": "0.1", + "start_datetime_unix_ms": 1571135957025, + "start_iso8601": "2019-10-15T10:39:17.025000+00:00", + "end_datetime_unix_ms": 1571168851826, + "end_iso8601": "2019-10-15T19:47:31.826000+00:00", + "file_name": "example_binary.bin", + "channels": [ + "x", + "y", + "z" + ], + "units": [ + "m/s/s", + "m/s/s", + "m/s/s" + ], + "scale_factors": [ + 0.00469378, + 0.00469378, + 0.00469378 + ], + "data_type": "int", + "bits": 16, + "rows": 10 +} \ No newline at end of file diff --git a/data/ppp_format_meta_legacy.json b/data/ppp_format_meta_legacy.json new file mode 100644 index 0000000..cf238b5 --- /dev/null +++ b/data/ppp_format_meta_legacy.json @@ -0,0 +1,58 @@ +{ + "project_id": "PPP", + "device_id": "Verily Study Watch", + "subject_id": "77", + "source_file_name": "WatchData.IMU.Week10.raw", + "endianness": "little", + "metadata_version": "0.1", + "start_datetime_unix_ms": 1571135957025, + "start_datetime_iso8601": "2019-10-15T10:39:17.025000+00:00", + "end_datetime_unix_ms": 1571168851826, + "end_datetime_iso8601": "2019-10-15T19:47:31.826000+00:00", + "datasets": [ + { + "file_name": "ppp_format_time.bin", + "quantities": "time", + "time_encode": "difference", + "units": "ms", + "scale_factors": [ + 1 + ], + "datatype": "float", + "bits": 32, + "columns": 1, + "rows": 17 + }, + { + "file_name": "ppp_format_samples.bin", + "quantities": [ + "acceleration_x", + "acceleration_y", + "acceleration_z", + "rotation_x", + "rotation_y", + "rotation_z" + ], + "units": [ + "m/s/s", + "m/s/s", + "m/s/s", + "deg/s", + "deg/s", + "deg/s" + ], + "scale_factors": [ + 0.00469378, + 0.00469378, + 0.00469378, + 0.06097561, + 0.06097561, + 0.06097561 + ], + "datatype": "int", + "bits": 16, + "columns": 6, + "rows": 17 + } + ] +} \ No newline at end of file diff --git a/index.html b/index.html index fbdc751..e51ceb6 100644 --- a/index.html +++ b/index.html @@ -48,20 +48,29 @@ +

The format

+

Usage

+

About

@@ -90,8 +99,6 @@

Welcome to the TSDF (Time Series Data Format) Python package

A package to work with TSDF data in Python. This implementation is based on the the TSDF format specification, which can be found in this preprint.

What is TSDF data?

-

tsdf stands for time series data format. -It is a unified, standardized format for storing all types of physiological sensor data. It was originally introduced in this preprint.

TSDF provides a unified, user-friendly format for both numerical sensor data and metadata, utilizing raw binary data and JSON-format text files for measurements/timestamps and metadata, respectively. It defines essential metadata fields to enhance data interpretability and exchangeability, aiming to bolster scientific reproducibility in studies reliant on digital biosensor data as a critical evidence base across various disease domains.

Example: TSDF Metadata

This example demonstrates a TSDF metadata JSON file, showcasing the structured format used to easily interpret and read the corresponding binary data. For more intricate examples and detailed specifications, the paper serves as a comprehensive reference.

@@ -171,7 +178,7 @@

The python library - tsdf