diff --git a/doc/index.rst b/doc/index.rst index b5adf5cdc..5bf7d561c 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -66,7 +66,7 @@ The development of ``MNE-LSL`` is supported by the resources/install.rst api/index.rst resources/command_line.rst - resources/processing.rst + resources/implementations.rst generated/tutorials/index.rst generated/examples/index.rst changes/index.rst diff --git a/doc/resources/processing.rst b/doc/resources/implementations.rst similarity index 97% rename from doc/resources/processing.rst rename to doc/resources/implementations.rst index fa593e6b1..c45989ae3 100644 --- a/doc/resources/processing.rst +++ b/doc/resources/implementations.rst @@ -1,7 +1,10 @@ .. include:: ../links.inc +Implementation details +====================== + Processing -========== +---------- The :class:`~mne_lsl.stream.StreamLSL` and :class:`~mne_lsl.stream.EpochsStream` object support processing in real-time of their internal buffers. The processing is done @@ -9,7 +12,7 @@ sequentially and this page presents the available processing and their applicati order. StreamLSL ---------- +~~~~~~~~~ Processing is applied to new samples available in the :class:`~mne_lsl.lsl.StreamInlet` before rolling the buffer of the @@ -34,7 +37,7 @@ The processing is defined in the private ``_acquire`` method of the class :width: 100% EpochsStream ------------- +~~~~~~~~~~~~ Processing is applied to new events and samples available to a :class:`~mne_lsl.stream.EpochsStream` before rolling the buffer of the diff --git a/doc/resources/pylsl.rst b/doc/resources/pylsl.rst index 2b34c9a06..815e01715 100644 --- a/doc/resources/pylsl.rst +++ b/doc/resources/pylsl.rst @@ -6,7 +6,7 @@ Differences with pylsl ====================== Faster chunk pull -~~~~~~~~~~~~~~~~~ +----------------- Arguably the most important difference, pulling a chunk of numerical data with :meth:`~mne_lsl.lsl.StreamInlet.pull_chunk` is much faster than with its @@ -62,7 +62,7 @@ Note that this performance improvement is absent for ``string`` based streams. F :issue:`225` for more information. Convenience methods -~~~~~~~~~~~~~~~~~~~ +------------------- A :class:`~mne_lsl.lsl.StreamInfo` has several convenience methods to retrieve and set channel attributes: names, types, units. @@ -84,7 +84,7 @@ be set or retrieved directly from a :class:`~mne.Info` object with :meth:`~mne_lsl.lsl.StreamInfo.get_channel_info`. Improve arguments -~~~~~~~~~~~~~~~~~ +----------------- The arguments of a :class:`~mne_lsl.lsl.StreamInfo`, :class:`~mne_lsl.lsl.StreamInlet`, :class:`~mne_lsl.lsl.StreamOutlet` support a wider variety of types. For instance: @@ -98,7 +98,7 @@ Overall, the arguments are checked in ``mne_lsl.lsl``. Any type or value mistake raise an helpful error message. Unique resolve function -~~~~~~~~~~~~~~~~~~~~~~~ +----------------------- `pylsl `_ has several stream resolving functions: diff --git a/mne_lsl/stream/base.py b/mne_lsl/stream/base.py index b75649e25..8e795dbf1 100644 --- a/mne_lsl/stream/base.py +++ b/mne_lsl/stream/base.py @@ -140,7 +140,7 @@ def add_reference_channels( Notes ----- Read about the :ref:`processing applied to the underlying - buffer `. + buffer `. """ self._check_connected_and_regular_sampling("add_reference_channels()") self._check_not_epoched("add_reference_channels()") @@ -490,7 +490,7 @@ def filter( Notes ----- Read about the :ref:`processing applied to the underlying - buffer `. + buffer `. """ self._check_connected_and_regular_sampling("filter()") if len(self._epochs) != 0: @@ -678,7 +678,7 @@ def notch_filter( Notes ----- Read about the :ref:`processing applied to the underlying - buffer `. + buffer `. """ self._check_connected_and_regular_sampling("notch_filter()") if len(self._epochs) != 0: @@ -923,7 +923,7 @@ def set_eeg_reference( Notes ----- Read about the :ref:`processing applied to the underlying - buffer `. + buffer `. """ self._check_connected_and_regular_sampling("set_eeg_reference()") self._check_not_epoched("set_eeg_reference()") diff --git a/mne_lsl/stream/epochs.py b/mne_lsl/stream/epochs.py index 8a422f392..d9347bcaf 100644 --- a/mne_lsl/stream/epochs.py +++ b/mne_lsl/stream/epochs.py @@ -123,7 +123,7 @@ class EpochsStream: in the connected ``stream`` are ignored. Read about the :ref:`processing applied to the underlying - buffer `. + buffer `. """ def __init__(