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 QuSpin .lvm file loader and tests for MNE Raw object creation #13098

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dbobela406
Copy link

Reference issue (if any)

Addresses issue #12881

What does this implement/fix?

This pull request introduces the read_raw_quspin_lvm function to handle .lvm files generated by the QuSpin N1 system. The function reads and parses the .lvm file, converts the data to an MNE Raw object, and creates the corresponding Info object. Additionally, tests and sample data are included to validate the loader's functionality. Specific changes are:

  • Added quspin folder in mne/io
  • Added quspin.py with read_raw_quspin_lvm function
  • Added init.py to initialize the quspin module
  • Added test_quspin.py with unit tests for QuSpin loader
  • Added quspin_N1_test_data.lvm, a small sample dataset for testing

Additional information

Add the read_raw_quspin_lvm function to parse QuSpin N1 .lvm files,
converting the data to an MNE Raw object. This includes handling the
metadata (e.g., sensor channels, trigger channels, and units) and
creating an appropriate Info object.

Add a new test file, test_quspin.py, to verify the functionality of
the read_raw_quspin_lvm function. The tests cover parsing of the .lvm
file, correct handling of metadata, and creation of an appropriate
MNE Raw object.

- Added quspin.py with read_raw_quspin_lvm function
- Added __init__.py to initialize the quspin module
- Added test_quspin.py with unit tests for QuSpin loader
- Added quspin_N1_test_data.lvm, a small sample dataset for testing
Copy link

welcome bot commented Feb 3, 2025

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

@@ -0,0 +1,62 @@
LabVIEW Measurement
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have moved away from storing test data in MNE-Python, could you add the file to https://github.com/mne-tools/mne-testing-data ?

@larsoner
Copy link
Member

larsoner commented Feb 3, 2025

I'll give the code a more in-depth review soon, but in the meantime just a comment above about moving the test file ☝️ . If it's unclear what you need to do from the README in that repo I can help!

@dbobela406
Copy link
Author

dbobela406 commented Feb 3, 2025 via email

@larsoner
Copy link
Member

larsoner commented Feb 3, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants