aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/timestamped_data
diff options
context:
space:
mode:
authorThéo de la Hogue2023-06-19 10:01:10 +0200
committerThéo de la Hogue2023-06-19 10:01:10 +0200
commit91857bacd4f82e48d8a06b43bcc48294701d6a1d (patch)
tree93d95d0bc6ec4b01c295efe8b788ac69d369d6e2 /docs/user_guide/timestamped_data
parent053726042d48f68bce7f0bfb4d53c5be097e234d (diff)
downloadargaze-91857bacd4f82e48d8a06b43bcc48294701d6a1d.zip
argaze-91857bacd4f82e48d8a06b43bcc48294701d6a1d.tar.gz
argaze-91857bacd4f82e48d8a06b43bcc48294701d6a1d.tar.bz2
argaze-91857bacd4f82e48d8a06b43bcc48294701d6a1d.tar.xz
Using relative path to code reference to make it works online.
Diffstat (limited to 'docs/user_guide/timestamped_data')
-rw-r--r--docs/user_guide/timestamped_data/data_synchronisation.md10
-rw-r--r--docs/user_guide/timestamped_data/introduction.md2
-rw-r--r--docs/user_guide/timestamped_data/ordered_dictionary.md2
-rw-r--r--docs/user_guide/timestamped_data/pandas_dataframe_conversion.md2
-rw-r--r--docs/user_guide/timestamped_data/saving_and_loading.md2
5 files changed, 9 insertions, 9 deletions
diff --git a/docs/user_guide/timestamped_data/data_synchronisation.md b/docs/user_guide/timestamped_data/data_synchronisation.md
index de861a9..24a474c 100644
--- a/docs/user_guide/timestamped_data/data_synchronisation.md
+++ b/docs/user_guide/timestamped_data/data_synchronisation.md
@@ -3,13 +3,13 @@ Data synchronisation
Recorded data needs to be synchronized to link them before further processings.
-The [TimeStampedBuffer](/argaze/#argaze.DataStructures.TimeStampedBuffer) class provides various methods to help in such task.
+The [TimeStampedBuffer](../../../argaze/#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/#argaze.DataStructures.TimeStampedBuffer.pop_last_before) method in order to synchronise two timestamped data buffers with different timestamps:
+The code below shows how to use [pop_last_before](../../../argaze/#argaze.DataStructures.TimeStampedBuffer.pop_last_before) method in order to synchronise two timestamped data buffers with different timestamps:
``` python
from argaze import DataStructures
@@ -34,7 +34,7 @@ for A_ts, A_data in A_data_record.items():
![Pop last until](../../img/pop_last_until.png)
-The code below shows how to use [pop_last_until](/argaze/#argaze.DataStructures.TimeStampedBuffer.pop_last_until) method in order to synchronise two timestamped data buffers with different timestamps:
+The code below shows how to use [pop_last_until](../../../argaze/#argaze.DataStructures.TimeStampedBuffer.pop_last_until) method in order to synchronise two timestamped data buffers with different timestamps:
``` python
from argaze import DataStructures
@@ -59,7 +59,7 @@ for A_ts, A_data in A_data_record.items():
![Get last before](../../img/get_last_before.png)
-The code below shows how to use [get_last_before](/argaze/#argaze.DataStructures.TimeStampedBuffer.get_last_before) method in order to synchronise two timestamped data buffers with different timestamps:
+The code below shows how to use [get_last_before](../../../argaze/#argaze.DataStructures.TimeStampedBuffer.get_last_before) method in order to synchronise two timestamped data buffers with different timestamps:
``` python
from argaze import DataStructures
@@ -84,7 +84,7 @@ for A_ts, A_data in A_data_record.items():
![Get last until](../../img/get_last_until.png)
-The code below shows how to use [get_last_until](/argaze/#argaze.DataStructures.TimeStampedBuffer.get_last_until) method in order to synchronise two timestamped data buffers with different timestamps:
+The code below shows how to use [get_last_until](../../../argaze/#argaze.DataStructures.TimeStampedBuffer.get_last_until) method in order to synchronise two timestamped data buffers with different timestamps:
``` python
from argaze import DataStructures
diff --git a/docs/user_guide/timestamped_data/introduction.md b/docs/user_guide/timestamped_data/introduction.md
index 2cee263..ed13d85 100644
--- a/docs/user_guide/timestamped_data/introduction.md
+++ b/docs/user_guide/timestamped_data/introduction.md
@@ -3,4 +3,4 @@ Timestamped data
Working with wearable eye tracker devices implies to handle various timestamped data like frames, gaze positions, pupils diameter, fixations, saccades, ...
-This section mainly refers to [DataStructures.TimeStampedBuffer](/argaze/#argaze.DataStructures.TimeStampedBuffer) class.
+This section mainly refers to [DataStructures.TimeStampedBuffer](../../../argaze/#argaze.DataStructures.TimeStampedBuffer) class.
diff --git a/docs/user_guide/timestamped_data/ordered_dictionary.md b/docs/user_guide/timestamped_data/ordered_dictionary.md
index 8c93fc6..a3154eb 100644
--- a/docs/user_guide/timestamped_data/ordered_dictionary.md
+++ b/docs/user_guide/timestamped_data/ordered_dictionary.md
@@ -1,7 +1,7 @@
Ordered dictionary
==================
-[TimeStampedBuffer](/argaze/#argaze.DataStructures.TimeStampedBuffer) class inherits from [OrderedDict](https://docs.python.org/3/library/collections.html#collections.OrderedDict) as data are de facto ordered by time.
+[TimeStampedBuffer](../../../argaze/#argaze.DataStructures.TimeStampedBuffer) class inherits from [OrderedDict](https://docs.python.org/3/library/collections.html#collections.OrderedDict) as data are de facto ordered by time.
Any data type can be stored using int or float keys as timestamp.
diff --git a/docs/user_guide/timestamped_data/pandas_dataframe_conversion.md b/docs/user_guide/timestamped_data/pandas_dataframe_conversion.md
index 3e6c0a4..839460a 100644
--- a/docs/user_guide/timestamped_data/pandas_dataframe_conversion.md
+++ b/docs/user_guide/timestamped_data/pandas_dataframe_conversion.md
@@ -7,7 +7,7 @@ Pandas DataFrame conversion
A [Pandas DataFrame](https://pandas.pydata.org/docs/getting_started/intro_tutorials/01_table_oriented.html#min-tut-01-tableoriented) is a python data structure allowing powerful table processings.
-[TimeStampedBuffer](/argaze/#argaze.DataStructures.TimeStampedBuffer) instance can be converted into dataframe provided that data values are stored as dictionaries.
+[TimeStampedBuffer](../../../argaze/#argaze.DataStructures.TimeStampedBuffer) instance can be converted into dataframe provided that data values are stored as dictionaries.
```python
from argaze import DataStructures
diff --git a/docs/user_guide/timestamped_data/saving_and_loading.md b/docs/user_guide/timestamped_data/saving_and_loading.md
index d3f2b9c..ae26052 100644
--- a/docs/user_guide/timestamped_data/saving_and_loading.md
+++ b/docs/user_guide/timestamped_data/saving_and_loading.md
@@ -1,7 +1,7 @@
Saving and loading
==================
-[TimeStampedBuffer](/argaze/#argaze.DataStructures.TimeStampedBuffer) instance can be saved as and loaded from JSON file format.
+[TimeStampedBuffer](../../../argaze/#argaze.DataStructures.TimeStampedBuffer) instance can be saved as and loaded from JSON file format.
```python