diff --git a/docs/_static/images/time_alignment_1.png b/docs/_static/images/time_alignment_1.png new file mode 100644 index 000000000..25dff320f Binary files /dev/null and b/docs/_static/images/time_alignment_1.png differ diff --git a/docs/_static/images/time_alignment_2.png b/docs/_static/images/time_alignment_2.png new file mode 100644 index 000000000..da76d65c7 Binary files /dev/null and b/docs/_static/images/time_alignment_2.png differ diff --git a/docs/_static/images/time_alignment_3.png b/docs/_static/images/time_alignment_3.png new file mode 100644 index 000000000..934dbf513 Binary files /dev/null and b/docs/_static/images/time_alignment_3.png differ diff --git a/docs/user_guide/temporal_alignment.rst b/docs/user_guide/temporal_alignment.rst index ab31aecd5..1e74442fd 100644 --- a/docs/user_guide/temporal_alignment.rst +++ b/docs/user_guide/temporal_alignment.rst @@ -26,6 +26,11 @@ indicating the temporal offset between the two systems. To do this, use the Data The advantage of this approach is its simplicity, but it cannot account for any drift due to misalignment between the clocks of the two systems. +.. image:: ../../_static/images/time_alignment_1.png + :alt: Diagram of the first method of time alignment, where the start time of the secondary system is shifted to match the primary system. + :width: 600px + :align: center + 2. Synchronize Timestamps ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -38,6 +43,11 @@ system, aligning the times to that system. Once the timestamps are known they ca DataInterface method :py:meth:`~neuroconv.basetemporalalignmentinterface.BaseTemporalAlignmentInterface.set_aligned_timestamps`. +.. image:: ../../_static/images/time_alignment_2.png + :alt: Diagram of the second method of time alignment, where the timestamps of the secondary system are aligned to the primary system. + :width: 600px + :align: center + 3. Synchronize Based on a Synchronization Signal ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -51,6 +61,11 @@ via the DataInterface method Note the data values for the series itself is *not* changed during the process, only the timestamp values are inferred for common reference time. +.. image:: ../../_static/images/time_alignment_3.png + :alt: Diagram of the third method of time alignment, where the timestamps of the secondary system are aligned to the primary system using a synchronization signal. + :width: 600px + :align: center + To use this type of synchronization, all the user must provide is the mapping determined by the .. code-block:: python