aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/timestamped_data/data_synchronisation.md
diff options
context:
space:
mode:
authorThéo de la Hogue2023-09-27 23:08:38 +0200
committerThéo de la Hogue2023-09-27 23:08:38 +0200
commit2d59cfc56590ed356a30d28cc52c00b533ab7a9e (patch)
treed5e94d4d99f97f1d1c2c2833feb8c9c11c23cbf1 /docs/user_guide/timestamped_data/data_synchronisation.md
parent66b84b019fe760a2cb9901a9f17b2d202d935ba4 (diff)
downloadargaze-2d59cfc56590ed356a30d28cc52c00b533ab7a9e.zip
argaze-2d59cfc56590ed356a30d28cc52c00b533ab7a9e.tar.gz
argaze-2d59cfc56590ed356a30d28cc52c00b533ab7a9e.tar.bz2
argaze-2d59cfc56590ed356a30d28cc52c00b533ab7a9e.tar.xz
Removing hidden sections and chapters.
Diffstat (limited to 'docs/user_guide/timestamped_data/data_synchronisation.md')
-rw-r--r--docs/user_guide/timestamped_data/data_synchronisation.md106
1 files changed, 0 insertions, 106 deletions
diff --git a/docs/user_guide/timestamped_data/data_synchronisation.md b/docs/user_guide/timestamped_data/data_synchronisation.md
deleted file mode 100644
index 5190eab..0000000
--- a/docs/user_guide/timestamped_data/data_synchronisation.md
+++ /dev/null
@@ -1,106 +0,0 @@
-Data synchronisation
-====================
-
-Recorded data needs to be synchronized to link them before further processings.
-
-The [TimeStampedBuffer](../../argaze.md/#argaze.DataStructures.TimeStampedBuffer) class provides various methods to help in such task.
-
-## Pop last before
-
-![Pop last before](../../img/pop_last_before.png)
-
-The code below shows how to use [pop_last_before](../../argaze.md/#argaze.DataStructures.TimeStampedBuffer.pop_last_before) method in order to synchronise two timestamped data buffers with different timestamps:
-
-``` python
-from argaze import DataStructures
-
-# Assuming A_data_record and B_data_record are TimeStampedBuffer instances with different timestamps
-
-for A_ts, A_data in A_data_record.items():
-
- try:
-
- # Get nearest B data before current A data and remove all B data before (including the returned one)
- B_ts, B_data = B_data_record.pop_last_before(A_ts)
-
- # No data stored before A_ts timestamp
- except KeyError:
-
- pass
-
-```
-
-## Pop last until
-
-![Pop last until](../../img/pop_last_until.png)
-
-The code below shows how to use [pop_last_until](../../argaze.md/#argaze.DataStructures.TimeStampedBuffer.pop_last_until) method in order to synchronise two timestamped data buffers with different timestamps:
-
-``` python
-from argaze import DataStructures
-
-# Assuming A_data_record and B_data_record are TimeStampedBuffer instances with different timestamps
-
-for A_ts, A_data in A_data_record.items():
-
- try:
-
- # Get nearest B data after current A data and remove all B data before
- B_ts, B_data = B_data_record.pop_last_until(A_ts)
-
- # No data stored until A_ts timestamp
- except KeyError:
-
- pass
-
-```
-
-## Get last before
-
-![Get last before](../../img/get_last_before.png)
-
-The code below shows how to use [get_last_before](../../argaze.md/#argaze.DataStructures.TimeStampedBuffer.get_last_before) method in order to synchronise two timestamped data buffers with different timestamps:
-
-``` python
-from argaze import DataStructures
-
-# Assuming A_data_record and B_data_record are TimeStampedBuffer instances with different timestamps
-
-for A_ts, A_data in A_data_record.items():
-
- try:
-
- # Get nearest B data before current A data
- B_ts, B_data = B_data_record.get_last_before(A_ts)
-
- # No data stored before A_ts timestamp
- except KeyError:
-
- pass
-
-```
-
-## Get last until
-
-![Get last until](../../img/get_last_until.png)
-
-The code below shows how to use [get_last_until](../../argaze.md/#argaze.DataStructures.TimeStampedBuffer.get_last_until) method in order to synchronise two timestamped data buffers with different timestamps:
-
-``` python
-from argaze import DataStructures
-
-# Assuming A_data_record and B_data_record are TimeStampedBuffer instances with different timestamps
-
-for A_ts, A_data in A_data_record.items():
-
- try:
-
- # Get nearest B data after current A data
- B_ts, B_data = B_data_record.get_last_until(A_ts)
-
- # No data stored until A_ts timestamp
- except KeyError:
-
- pass
-
-```