Skip to content

Commit

Permalink
add temporal alignment diagrams (#899)
Browse files Browse the repository at this point in the history
Co-authored-by: Cody Baker <[email protected]>
  • Loading branch information
bendichter and CodyCBakerPhD authored Jun 12, 2024
1 parent 1f6573c commit 5a65e74
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 0 deletions.
Binary file added docs/_static/images/time_alignment_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/time_alignment_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/time_alignment_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions docs/user_guide/temporal_alignment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -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
Expand Down

0 comments on commit 5a65e74

Please sign in to comment.