|
1 | | -# PyHFO |
2 | | -[ProjectPage](https://roychowdhuryresearch.github.io/PyHFO_Project_Page/) | |
3 | | -[Download](https://github.com/roychowdhuryresearch/pyHFO/releases) | |
4 | | -[Manual](https://docs.google.com/document/d/1KzQpfuPFDk2lr9V3TgSkmc21jISB54ZOxo3pIYKQsp0/edit?usp=sharing) | |
5 | | - |
6 | | -PyHFO is a multi-window desktop application providing an integrated and user-friendly platform that includes time-efficient HFO detection algorithms such as short-term energy (STE) and Montreal Neurological Institute and Hospital (MNI) detectors and deep learning models for artifact and HFO with spike classification. |
7 | | - |
8 | | -## Bibtex |
9 | | -If you find our project is useful in your research, please cite: |
10 | | - |
11 | | -``` |
12 | | -Zhang, Y., Liu, L., Ding, Y., Chen, X., Monsoor, T., Daida, A., Oana, S., Hussain, S. A., Sankar, R., Fallah, A., Santana-Gomez, C., Engel, J., Staba, R. J., Speier, W., Zhang, J., Nariai, H., & Roychowdhury, V. (2024). PyHFO: lightweight deep learning-powered end-to-end high-frequency oscillations analysis application. Journal of neural engineering, 10.1088/1741-2552/ad4916. Advance online publication. https://doi.org/10.1088/1741-2552/ad4916 |
13 | | -``` |
14 | | - |
15 | | -## Related Projects |
16 | | - |
17 | | -* [HFODetector](https://github.com/roychowdhuryresearch/HFO_Detector) - A Python toolbox for very fast HFO detection. |
18 | | - |
19 | | -* [HFO-Classification](https://github.com/roychowdhuryresearch/HFO-Classification) - Many HFO classification projects powered by deep learning. |
20 | | - |
21 | | -* [EEG-Viz](https://github.com/jebbica/EEG-Viz) - A Python toolbox for EEG visualization. |
22 | | - |
23 | | - |
24 | | -## Installation |
25 | | - |
26 | | -You can download the latest version of PyHFO from the [releases](https://github.com/roychowdhuryresearch/pyHFO/releases) page. |
27 | | - |
28 | | -If you choose to use the **macOS version** of the standalone distributable application, please follow these additional steps: |
29 | | - |
30 | | -1. **Download and unzip** the `.zip` file. |
31 | | -2. You will get a file named `pyHFO.dmg`. |
32 | | -3. Navigate to the directory containing the `pyHFO.dmg` file. |
33 | | -4. Open the terminal and run the following command to remove the quarantine attribute: |
34 | | - |
35 | | -``` |
36 | | -xattr -cr pyHFO.dmg |
37 | | -``` |
38 | | - |
39 | | -You can also install it from the source code: |
40 | | - |
41 | | -``` |
42 | | -git clone https://github.com/roychowdhuryresearch/pyHFO.git |
43 | | -cd pyHFO |
44 | | -pip install -r requirements.txt |
45 | | -python main.py |
46 | | -``` |
47 | | - |
48 | | -## Usage |
49 | | - |
50 | | -The overview of the PyHFO is shown below: |
51 | | - |
52 | | - |
53 | | - |
54 | | -The manual is available [here](https://docs.google.com/document/d/1KzQpfuPFDk2lr9V3TgSkmc21jISB54ZOxo3pIYKQsp0/edit?usp=sharing). |
55 | | - |
56 | | -## License |
57 | | - |
58 | | -This project is licensed under the UCLA Academic License - see the [LICENSE](LICENSE) file for details. |
59 | | - |
60 | | -## Acknowledgments |
61 | | - |
62 | | -### Contributors: |
63 | | -This project is under supervsion of Prof. [Vwani Roychowdhury](https://www.ee.ucla.edu/vwani-p-roychowdhury/). |
64 | | - |
65 | | -Department of Electrical and Computer Engineering, University of California, Los Angeles |
66 | | -- [Yipeng Zhang](https://zyp5511.github.io/) |
67 | | -- [Lawrence Liu](https://www.linkedin.com/in/lawrence-liu-0a01391a7/) |
68 | | -- [Yuanyi Ding](https://www.linkedin.com/in/yuanyi-ding-4a981a132/) |
69 | | -- [Xin Chen](https://www.linkedin.com/in/xin-chen-980521/) |
70 | | -- [Jessica Lin](https://www.linkedin.com/in/jessica4903/) |
71 | | - |
72 | | -Division of Pediatric Neurology, Department of Pediatrics, UCLA Mattel Children’s Hospital David Geffen School of Medicine |
73 | | -- [Hiroki Nariai](https://www.uclahealth.org/providers/hiroki-nariai) |
74 | | - |
75 | | - |
76 | | - |
77 | | - |
78 | | - |
79 | | - |
80 | | - |
| 1 | +# PyHFO |
| 2 | +[ProjectPage](https://roychowdhuryresearch.github.io/PyHFO_Project_Page/) | |
| 3 | +[Download](https://github.com/roychowdhuryresearch/pyHFO/releases) | |
| 4 | +[Manual](https://docs.google.com/document/d/1KzQpfuPFDk2lr9V3TgSkmc21jISB54ZOxo3pIYKQsp0/edit?usp=sharing) | |
| 5 | + |
| 6 | +PyHFO is a multi-window desktop application providing an integrated and user-friendly platform that includes time-efficient HFO detection algorithms such as short-term energy (STE) and Montreal Neurological Institute and Hospital (MNI) detectors and deep learning models for artifact and HFO with spike classification. |
| 7 | + |
| 8 | +## Bibtex |
| 9 | +If you find our project is useful in your research, please cite: |
| 10 | + |
| 11 | +``` |
| 12 | +Zhang, Y., Liu, L., Ding, Y., Chen, X., Monsoor, T., Daida, A., Oana, S., Hussain, S. A., Sankar, R., Fallah, A., Santana-Gomez, C., Engel, J., Staba, R. J., Speier, W., Zhang, J., Nariai, H., & Roychowdhury, V. (2024). PyHFO: lightweight deep learning-powered end-to-end high-frequency oscillations analysis application. Journal of neural engineering, 10.1088/1741-2552/ad4916. Advance online publication. https://doi.org/10.1088/1741-2552/ad4916 |
| 13 | +``` |
| 14 | + |
| 15 | +## Related Projects |
| 16 | + |
| 17 | +* [HFODetector](https://github.com/roychowdhuryresearch/HFO_Detector) - A Python toolbox for very fast HFO detection. |
| 18 | + |
| 19 | +* [HFO-Classification](https://github.com/roychowdhuryresearch/HFO-Classification) - Many HFO classification projects powered by deep learning. |
| 20 | + |
| 21 | +* [EEG-Viz](https://github.com/jebbica/EEG-Viz) - A Python toolbox for EEG visualization. |
| 22 | + |
| 23 | + |
| 24 | +## Installation |
| 25 | + |
| 26 | +You can download the latest version of PyHFO from the [releases](https://github.com/roychowdhuryresearch/pyHFO/releases) page. |
| 27 | + |
| 28 | +If you choose to use the **macOS version** of the standalone distributable application, please follow these additional steps: |
| 29 | + |
| 30 | +1. **Download and unzip** the `.zip` file. |
| 31 | +2. You will get a file named `pyHFO.dmg`. |
| 32 | +3. Navigate to the directory containing the `pyHFO.dmg` file. |
| 33 | +4. Open the terminal and run the following command to remove the quarantine attribute: |
| 34 | + |
| 35 | +``` |
| 36 | +xattr -cr pyHFO.dmg |
| 37 | +``` |
| 38 | + |
| 39 | +You can also install it from the source code: |
| 40 | + |
| 41 | +``` |
| 42 | +git clone https://github.com/roychowdhuryresearch/pyHFO.git |
| 43 | +cd pyHFO |
| 44 | +pip install -r requirements.txt |
| 45 | +python main.py |
| 46 | +``` |
| 47 | + |
| 48 | +## Usage |
| 49 | + |
| 50 | +The overview of the PyHFO is shown below: |
| 51 | + |
| 52 | + |
| 53 | + |
| 54 | +The manual is available [here](https://docs.google.com/document/d/1KzQpfuPFDk2lr9V3TgSkmc21jISB54ZOxo3pIYKQsp0/edit?usp=sharing). |
| 55 | + |
| 56 | +## License |
| 57 | + |
| 58 | +This project is licensed under the UCLA Academic License - see the [LICENSE](LICENSE) file for details. |
| 59 | + |
| 60 | +## Acknowledgments |
| 61 | + |
| 62 | +### Contributors: |
| 63 | +This project is under supervsion of Prof. [Vwani Roychowdhury](https://www.ee.ucla.edu/vwani-p-roychowdhury/). |
| 64 | + |
| 65 | +Department of Electrical and Computer Engineering, University of California, Los Angeles |
| 66 | +- [Yipeng Zhang](https://zyp5511.github.io/) |
| 67 | +- [Lawrence Liu](https://www.linkedin.com/in/lawrence-liu-0a01391a7/) |
| 68 | +- [Yuanyi Ding](https://www.linkedin.com/in/yuanyi-ding-4a981a132/) |
| 69 | +- [Xin Chen](https://www.linkedin.com/in/xin-chen-980521/) |
| 70 | +- [Jessica Lin](https://www.linkedin.com/in/jessica4903/) |
| 71 | + |
| 72 | +Division of Pediatric Neurology, Department of Pediatrics, UCLA Mattel Children’s Hospital David Geffen School of Medicine |
| 73 | +- [Hiroki Nariai](https://www.uclahealth.org/providers/hiroki-nariai) |
| 74 | + |
| 75 | + |
| 76 | + |
| 77 | + |
| 78 | + |
| 79 | + |
| 80 | + |
0 commit comments