https://github.com/sccn/nwbio
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sccn/nwbio
- Owner: sccn
- Created: 2024-04-12T16:28:50.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-05-09T16:14:10.000Z (about 1 year ago)
- Last Synced: 2025-06-27T19:47:46.534Z (12 months ago)
- Language: MATLAB
- Size: 43 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README

# NWBio EEGLAB plugin
This plugin imports data from the Neurodata Without Borders
data format. Time series, channel information, and
event information are imported. Use the EEGLAB import/export menus to
import/export files, or use the command line function pop_nwbimport.m
or pop_nwbexport.m
# Example
Export the tutorial EEGLAB data.
```matlab
pop_nwbexport(EEG, 'test.nwb');
```
Import the file exported above.
```matlab
EEG = pop_nwbimport('test.nwb');
```
# Use with EEGLAB
Use menu item **File > EEGLAB extensions** and search for the "nwbio" plugin. Once you have found it
install it. Then, use the menu item **File > Import data > From NWB file** to import a file. Once you
have selected a file, the following graphical interface will pop up.

It lets you decide which event information you want to use as the primary information for EEGLAB (EEGLAB event type).
EEGLAB perform most operations on event types, although it is also possible to use other fields. Note that all fields
will be imported in EEGLAB, but the primary field will be duplicated and in the event type field.
The checkbox allows importing neurons' spikes as EEGLAB event when they are present in the data file (when greyed out,
spikes are not present). Note that EEGLAB will not import all NWB information (such as spacial movement, calcium imaging, etc...).
This EEGLAB plugin only import electrophysiology data.
To export EEG or iEEG data, use the menu item **File > Export > Data to NWB file**. The following graphical interface
will pop up, allowing you to enter NWB-specific information.

Most entries are NWB-specific, so you may refer to the [NWB documentation](https://www.nwb.org/) for more information. The last two
entries are specific to EEGLAB. "Event fields to export" lists the EEGLAB event fields available to export. Event onset and duration
are exported by default and are not listed. "Export channel (x, y, z) locations" allow exporting channel locations. If you use
the template channel location, you may leave this option unchecked.
# Version history
1.0 - import, and export, tested on multiple files
1.1 - update matnwb to fix issue https://github.com/NeurodataWithoutBorders/matnwb/issues/650
1.2 - fix compatiblity issues