Skip to content

Commit

Permalink
Update Pseudo_Device.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
LMBooth authored Sep 3, 2023
1 parent 7f846d0 commit 6df7521
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/BackgroundInformation/Pseudo_Device.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ By default the PseudoDevice has 4 markers, "baseline", "Marker1", "Marker2", "Ma
Each signal is modified for 1 second after the marker has occurred, and the seconds between the markers are spaced by 5 seconds.

Upon creating PyBCI object a dict of the following kwargs can be passed to dictate the behaviour of the pseudo device:


.. code-block::
stop_signal – multiprocessing.Event or bool: Signal used to stop the device’s operation.
is_multiprocessing – bool: Flag indicating if the class instance is running in a multiprocessing environment. Default is True.
markerConfigStrings – list(str): List of marker strings used for generating marker data. Default is [“Marker1”, “Marker2”, “Marker3”].
Expand All @@ -32,7 +34,9 @@ Upon creating PyBCI object a dict of the following kwargs can be passed to dicta
logger – Logger: Logger object for logging activities. Default is Logger(Logger.INFO).
log_queue – multiprocessing.Queue: Queue object for logging activities in a multiprocessing environment. Default is None.
Where PseudoDataConfig and PseudoDataConfig are:

.. code-block:: python
class PseudoDataConfig:
Expand Down

0 comments on commit 6df7521

Please sign in to comment.