Artefact removal

This is an implementation of the HAPPILEE pipeline for the Explore system from Mentalab. See our github page for the code for this project.

The HAPPILEE pipeline is applied to EEG data recorded by the Mentalab Explore Pro device in happilee.py and happilee.ipynb. happilee.py is the main script to apply HAPPILEE to an EXG dataset recorded by the Explore system. happilee.ipynb is a notebook to demonstrate and track steps of the HAPPILEE pipeline to a dataset recorded by the Explore system.

A realtime example is available in acquisition_example.py. Further tests and trials on different artefacts are available in testing.ipynb.

Noise removal is applied in real time to the data stream from the Explore device in acquisition_example.py.

*Steps of the pipeline included in our implementation are marked in a red rectange in the figure above.*

Steps of the HAPPILEE pipeline covered in this implementation:

Channel Selection
Line Noise Processing
Filtering
Wavelet Thresholding

These steps and evaluation results covered in the evaluation.md file.

Example Result

Figure below displays the results after applying wav thresholding.

Installation and Setup

To use HAPPILEE with your Explore device, follow these steps:

Install Requirements

Ensure you have Python installed on your system. You can check this by running:
```
python --version
```
If Python is not installed, download and install it from the official Python website.

Next, install the required Python packages using pip:
```
pip install -r requirements.txt
```
Run the Script

You can run the pipeline online or offline. Use the following commands:

Offline Mode
```
python happilee.py
```
The script will prompt for the following inputs:
- File Type: Select the file type to load (.csv or .edf).
  Example input: 1
- File Path: Enter the path to the file, including the file name.
  Example input: ExG_data/offline_exp_ExG-30s.csv
- Channel Names: Input the channel names recorded (e.g., Fp1, Fp2, O1, etc.).
  Example input: POz, Oz, O1, O2
- Line Frequency: Input the line frequency.
  Example input: 50
Online Mode

Online mode example outputs a csv file (with the name filtered_exg_data.csv) containing the results of the HAPPILEE pipeline applied to the data stream from the Explore device.
```
python acquisition_example.py --name <device_name>
```
Replace <device_name> with the appropriate device name if necessary.

Troubleshooting

Ensure all dependencies are installed correctly.
Verify the file paths and names are correct.
On macOS when running in online mode, you might encounter permission issues, so try running the scripts with sudo privileges.

For more detailed information, please contact support.