ENH: add new neuralynx testing dataset with associated .mat files (#111)

* ENH: add new Neuralynx testing dataset * Add README.md * increment version.txt * ENH add links to MATLAB software sites in readme
mne-tools · Nov 10, 2023 · a3f4dd7 · a3f4dd7
1 parent 0decea2
commit a3f4dd7
Show file tree

Hide file tree

Showing 36 changed files with 30 additions and 14 deletions.
diff --git a/neuralynx/Events.mat b/neuralynx/Events.mat
diff --git a/neuralynx/Events.nev b/neuralynx/Events.nev
diff --git a/neuralynx/LAHC1.mat b/neuralynx/LAHC1.mat
diff --git a/neuralynx/LAHC1.ncs b/neuralynx/LAHC1.ncs
diff --git a/neuralynx/LAHC2.mat b/neuralynx/LAHC2.mat
diff --git a/neuralynx/LAHC2.ncs b/neuralynx/LAHC2.ncs
diff --git a/neuralynx/LAHC3.mat b/neuralynx/LAHC3.mat
diff --git a/neuralynx/LAHC3.ncs b/neuralynx/LAHC3.ncs
diff --git a/neuralynx/LAHCu1.mat b/neuralynx/LAHCu1.mat
diff --git a/neuralynx/LAHCu1.ncs b/neuralynx/LAHCu1.ncs
diff --git a/neuralynx/RACC1.ncs b/neuralynx/RACC1.ncs
diff --git a/neuralynx/RACC2.ncs b/neuralynx/RACC2.ncs
diff --git a/neuralynx/RACC3.ncs b/neuralynx/RACC3.ncs
diff --git a/neuralynx/RACC4.ncs b/neuralynx/RACC4.ncs
diff --git a/neuralynx/RACC5.ncs b/neuralynx/RACC5.ncs
diff --git a/neuralynx/RACC6.ncs b/neuralynx/RACC6.ncs
diff --git a/neuralynx/RACC7.ncs b/neuralynx/RACC7.ncs
diff --git a/neuralynx/RACC8.ncs b/neuralynx/RACC8.ncs
diff --git a/neuralynx/RACCuS1.nse b/neuralynx/RACCuS1.nse
diff --git a/neuralynx/RACCuS2.nse b/neuralynx/RACCuS2.nse
diff --git a/neuralynx/RACCuS3.nse b/neuralynx/RACCuS3.nse
diff --git a/neuralynx/RACCuS4.nse b/neuralynx/RACCuS4.nse
diff --git a/neuralynx/RACCuS5.nse b/neuralynx/RACCuS5.nse
diff --git a/neuralynx/RACCuS6.nse b/neuralynx/RACCuS6.nse
diff --git a/neuralynx/RACCuS7.nse b/neuralynx/RACCuS7.nse
diff --git a/neuralynx/RACCuS8.nse b/neuralynx/RACCuS8.nse
diff --git a/neuralynx/README.md b/neuralynx/README.md
@@ -1,18 +1,34 @@
-# Author: Kristijan Armeni  
+---
+
+Author: Kristijan Armeni
+
+---
+
+# Author: Kristijan Armeni
+
+This folder contains unconnected recording (i.e. not attached to a patient) with the [Neuralynx](https://neuralynx.fh-co.com/) acquisition system. The recording contributed by Ivan Skelin, Krembil Research Institute, University of Toronto.
 
-This folder contains unconnected recording (i.e. not attached to a patient) with the [Neuralynx](https://neuralynx.fh-co.com/) acquisition system.
-The recording kindly contributed by Ivan Skelin, Krembil Research Institute, University of Toronto.  
-
 Folder contents:
-- 10 `*.ncs` files/channels (continuously sampled signals)
-- 10 `*.nse` files/channels (spike snapshot files; likely empty since the recording is disconnected and no spikes were produced)
-- 1 `*.nev` file (events file)
 
-folder size:  
-```bash  
-du -h neuralynx
-504K	neuralynx
-```  
+- 5 `.ncs` files (continuously sampled signals, 2Khz sampling rate, except `LAHCu1.ncs` which is at 32Khz)
+- 5 `.mat` files (.mat version of .ncs files)
+- 1 `.nev` file (events file)
+
+The 3 .ncs files (`LAHC1.ncs, LAHC2.ncs, LAHC3.ncs`) should represent an seeg signal. `xAIR1.ncs` and `xEKG1.ncs` represent a potential non-seeg modality (airflow and EKG in this case). 
+
+Folder size: 1MB
+For more info about the file formats, see: [Neuralynx data file formats](https://support.neuralynx.com/hc/en-us/articles/360040444811-TechTip-Neuralynx-Data-File-Formats)
+
+## MATLAB reader used
+
+The `.mat` files were created via the `Nlx2MatCSC.m` (.ncs files) and `Nlx2EV.mat` (.nev file). See project page: https://www.urut.ch/new/serendipity/index.php?/pages/nlxtomatlab.html. Available at: https://neuralynx.fh-co.com/research-software/#file-converters-&-utilities
+
+Example usage:
 
-For more info about the file formats, see: [Neuralynx data file formats]( https://support.neuralynx.com/hc/en-us/articles/360040444811-TechTip-Neuralynx-Data-File-Formats)
+```matlab
+% for csc files
+[Timestamps, ChannelNumbers, SampleFrequencies, NumberOfValidSamples, Samples, Header] = Nlx2MatCSC('LAHC1.ncs', [1 1 1 1 1] , 1, 1, 1);
 
+%for events files
+[Timestamps, EventIDs, TTLs, Extras, EventStrings, Header] = Nlx2MatEV('Events.nev', [1 1 1 1 1], 1, 1, []);
+```
diff --git a/neuralynx/RMCC1.ncs b/neuralynx/RMCC1.ncs
diff --git a/neuralynx/RMCC2.ncs b/neuralynx/RMCC2.ncs
diff --git a/neuralynx/RMCCuS1.nse b/neuralynx/RMCCuS1.nse
diff --git a/neuralynx/RMCCuS2.nse b/neuralynx/RMCCuS2.nse
diff --git a/neuralynx/xAIR1.mat b/neuralynx/xAIR1.mat
diff --git a/neuralynx/xAIR1.ncs b/neuralynx/xAIR1.ncs
diff --git a/neuralynx/xEKG1.mat b/neuralynx/xEKG1.mat
diff --git a/neuralynx/xEKG1.ncs b/neuralynx/xEKG1.ncs
diff --git a/version.txt b/version.txt
@@ -1 +1 @@
-0.149
+0.150