Skip to content

Commit

Permalink
Update Epoch_Timing.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
LMBooth authored Dec 13, 2024
1 parent 8dedf0e commit 52390ca
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/source/BackgroundInformation/Epoch_Timing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Epochs are periods of time.

In relation to training models on set actions for brain computer interfaces, it is useful to define epochs by the amount of time-series data before and after a marker has been received indicating a desired classification action has been executed. A selected LSL marker stream is used to send strings which represent unique target training markers. Once data is sliced in to epochs it may be processed for feature extraction, or in some cases passed as raw time-series input, see :ref:`custom-extractor` and :ref:`raw-extractor` for more information on feature extraction.

Setting the :py:data:`globalEpochSettings` with the :class:`GlobalEpochSettings()` class sets the target window length and overlap for the training time windows. It is desirable to have a single global window length that all epochs are sliced to match, this gives a uniform array when passing to the classifier. When in testing mode a having a continuous rolling window of data is sliced to this size and overlapped based on the windowOverlap, see :ref:`set_custom_epoch_times` for more info.
Setting the :py:data:`globalEpochSettings` variable when initialising pybci with the :class:`GlobalEpochSettings() = gs` class sets the target window length and overlap for the training time windows. It is desirable to have a single global window length (:py:data:`gs.windowLength`) that all epochs are sliced to match, this gives a uniform array when passing to the classifier. In testing mode there is a continuous rolling window of data sliced to the specified size set with :py:data:`gs.windowLength` and overlapped based on the :py:data:`gs.windowOverlap`, see :ref:`set_custom_epoch_times` for more info.

.. _set_custom_epoch_times:

Expand Down

0 comments on commit 52390ca

Please sign in to comment.