updated readme

README.md

@@ -37,20 +37,40 @@ The GUI now looks like this:
 
 ![gui](figures/gui.png)
 
-- The `Channels` pannel enables you to configure each electrode:
-  - `disabled`: the electrode is not used
-  - `simple`: the electrode is simply used to measure signal (not recommended)
-  - `bias in`: the electrode is used to measure signal and to compute a bias ("ground") signal
-  - `bias out`: the electrode is used to output the bias ("ground") signal
-- Use the `Freq` widget to enter your desired sampling rate
-- Use the `Time` widget to enter a maximum duration for the experiment (you can also stop the experiment manually)
-- Use the `Recording` widget to enter the name of a `.edf` output file if you wish to record the signal
-- If you tick the `Record` checkbox, the signal will be recorded in this file
-- If you tick the `Display` checkbox, the signal will be displayed for the duration of the whole experiment
+### Channels:
+
+The `Channels` pannel enables you to configure each electrode:
+- `disabled`: the electrode is not used
+- `simple`: the electrode is simply used to measure signal (not recommended)
+- `with bias`: the electrode is used to measure signal and to compute a bias ("ground") signal
+- `bias out`: the electrode is used to output the bias ("ground") signal
+
+### General controls:
+
+- `Freq` is the desired sampling rate
+- `Time` is the maximum duration of the experiment (you can also stop the experiment manually)
+- `Recording` is the name of the `.edf` output file if you wish to record the signal locally
+- Tick `Filter` to enable the online filtering pipeline
+- Tick `Detect` to enable the online detection pipeline
+- Tick `Stimulate` to enable the online stimulation pipeline
+- Tick `Record EDF` to record the signal in the file designated in `Recording`
+- Tick `Stream LSL` to broadcast the signal on the local network via [LSL](https://labstreaminglayer.readthedocs.io/info/intro.html)
+- Tick `Display` to display the signal in the GUI
+- `Threshold` enables customizing the optional detection threshold from the GUI (e.g., for classifiers)
 - The `Clock` widget lets you select the sampling method:
-  - `Coral` sets the `ADS1299` sampling rate to twice your target, and uses the Coral RT clock to sample at your target
-  - `ADS` sets the `ADS1299` sampling rate to the closest compatible to your target and uses the ADS interrupts to sample
-- Finally, the `Capture` widget lets you start and stop the experiment at any point in time
+  - `Coral` sets the `ADS1299` sampling rate to twice your target sampling rate, and uses the Coral Real-Time clock to stick to your target sampling rate
+  - `ADS` sets the `ADS1299` sampling rate to the closest compatible to your target sampling rate and uses the ADS interrupts
+
+### Custom Filtering
+
+The `Filtering` section lets you customize the filtering pipeline from the GUI.
+
+- The `FIR filter` switch lets you select between the default low-pass FIR filter (used in the Portiloop [paper](https://arxiv.org/abs/2107.13473)), or customize this filter according to your needs (`FIR order` and `FIR cutoff`)
+- `Polyak mean`, `Polyak std` and `Epsilon` let you customize the online standardization pipeline, which also acts as a high-pass filter
+
+### Capture
+
+The `Capture` switch lets you start and stop the experiment at any point in time
 
 _Note: once the experiment is started, all widgets are deactivated until you stop the experiment._
 
@@ -62,6 +82,10 @@ Follow these instruction if the software is not readily installed on your `Porti
 
 _(Requires python 3)_
 
+#### Install the following libraries from apt to avoid issues:
+- `sudo apt install python3-numpy`
+- `sudo apt install python3-scipy`
+- `sudo apt install python3-pycoral`
 - Clone this repository on the `Coral` board
 - `cd` to he root of the repository where the `setup.py` file is located
 - Execute `pip3 install -e .`