Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SOUND and SSP-SIR algorithms #12559

Open
matteo-d-m opened this issue Apr 22, 2024 · 3 comments
Open

Add SOUND and SSP-SIR algorithms #12559

matteo-d-m opened this issue Apr 22, 2024 · 3 comments
Labels
needs-discussion issues requiring a dev meeting discussion before the way forward is clear

Comments

@matteo-d-m
Copy link

Dear MNE-Python developers,

I am Matteo De Matola, doctoral student at the University of Trento (Italy).

I have noticed that MNE-Python does not include an implementation of the SOUND (Mutanen et al., 2018) and SSP-SIR (Mutanen et al., 2016) algorithms. These algorithms are widely used in TMS-EEG preprocessing, but to the best of my knowledge, they are currently implemented in MATLAB only.

The absence of a reliable Python implementation for SOUND and SSP-SIR does not facilitate the adoption of MNE-Python in the TMS-EEG community. In agreement with Tuomas Mutanen, the inventor of the two algorithms, I volunteer to translate them from MATLAB to Python and integrate them into MNE.


I did not open an ENH-type issue because:

  1. I do not have a proposed implementation yet
  2. I want to add the feature, rather than request it

If you confirm that the two algorithms are not included in MNE-Python and agree to their inclusion, I will follow up with a proposed implementation ASAP.

Thanks,
Matteo

Copy link

welcome bot commented Apr 22, 2024

Hello! 👋 Thanks for opening your first issue here! ❤️ We will try to get back to you soon. 🚴

@larsoner
Copy link
Member

From a very brief look it seems like SSP-SIR is a bit like proj="reconstruct" in #8033 / this tutorial but someone would have to dig into the details to see

For SOUND I'm not too familiar with how widely used it is. See also discussions of other potential algorithms like #7170 (comment) where we suggest possible inclusion in python-meegkit or mne-sandbox to start until we see how widely used they are

@larsoner larsoner added the needs-discussion issues requiring a dev meeting discussion before the way forward is clear label Apr 22, 2024
@matteo-d-m
Copy link
Author

Thanks for your response.

  • proj="reconstruct" might indeed be some implementation of SSP-SIR, but we are trying it on some real data to check
  • I believe that SOUND would be a valuable addition to MNE, but I also understand your concern. I'll just do the work and propose it to either MEEGKit or MNE-Incubator when it's done!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-discussion issues requiring a dev meeting discussion before the way forward is clear
Projects
None yet
Development

No branches or pull requests

2 participants