You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A package for decomposing raw EMG signals into individual motor unit activity.
6
+
A package for decomposing multi-channel intramuscular and surface EMG signals into individual motor unit activity based off the blind source algorithm described in [`Negro et al. (2016)](https://iopscience.iop.org/article/10.1088/1741-2560/13/2/026027/meta).
7
7
8
8
## Proposal
9
9
@@ -19,20 +19,34 @@ To generate the proposal locally, run the following command from the root direct
19
19
pip install emgdecompy
20
20
```
21
21
22
-
## Usage
22
+
## Usage and Example
23
23
24
-
- TODO
24
+
After installing `EMGdecomPy`, to use the package import it with the following commands:
25
+
26
+
```
27
+
from emgdecompy.decomposition import decomposition
28
+
```
29
+
30
+
**Run the blind source separation algorithm on your data to extract out the separation vectors, motor unit firing times, and associated silhouette scores and pulse-to-noise ratios.**
31
+
32
+
```
33
+
decomposition(data)
34
+
```
25
35
26
36
## Contributing
27
37
28
38
Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.
29
39
30
40
## License
31
41
32
-
`emgdecompy` was created by Daniel King, Jasmine Ortega, Rada Rudyak, and Rowan Sivanandam. It is licensed under the terms of the MIT license.
42
+
`EMGdecomPy` was created by [Daniel King](github.com/danfke), [Jasmine Ortega](github.com/jasmineortega), [Rada Rudyak](github.com/Radascript), and [Rowan Sivanandam](github.com/Rowansiv). It is licensed under the terms of the MIT license.
33
43
34
44
## Credits
35
45
36
-
`emgdecompy` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter`[template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
46
+
`EMGdecomPy` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter`[template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
47
+
48
+
The blind source separation algorithm in this package was based off of [`Negro et al. (2016)](https://iopscience.iop.org/article/10.1088/1741-2560/13/2/026027/meta).
37
49
38
50
The data used for validation was obtained from [`Hug et al. (2021)`](https://figshare.com/articles/dataset/Analysis_of_motor_unit_spike_trains_estimated_from_high-density_surface_electromyography_is_highly_reliable_across_operators/13695937).
51
+
52
+
[Guilherme Ricioli](https://github.com/guilhermerc) was consulted for his work on [`semg-decomposition`](https://github.com/guilhermerc/semg-decomposition).
0 commit comments