-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathprocessing_and_plotting_functions.py
More file actions
1331 lines (1021 loc) · 62.1 KB
/
Copy pathprocessing_and_plotting_functions.py
File metadata and controls
1331 lines (1021 loc) · 62.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import numpy as np
from scipy.signal import hilbert, find_peaks, resample, butter, filtfilt
import mne
import mne_bids
import pathlib
import os
from badsMarker import *
import json
import statistics
import warnings
import matplotlib.pyplot as plt
from sklearn.metrics import confusion_matrix
import seaborn as sns
from mne.preprocessing import ICA
from mne_icalabel import label_components
import asrpy
from scipy.stats import zscore
import ast
#Note that to maximise the effectiveness of normalisation, we do this before epoching.
#Then, to minimise loss of temporal resolution, we epoch before downsampling.
#Suppress the specific RuntimeWarning by message
warnings.filterwarnings(
"ignore",
message="No bad channels to interpolate. Doing nothing...",
category=RuntimeWarning)
mne.set_log_level('WARNING')
def process_stimuli(stim_all, lpf_freq, ds_factor, fs):
processed_stimuli = []
for stim in stim_all:
#Compute the envelope using the Hilbert transform
a = np.abs(hilbert(stim)) #Mono -> only one stim channel -> no need to average
#Find peaks in the envelope
peaks, _ = find_peaks(a)
#Prepare for interpolation
b = np.concatenate(([0], a[peaks], [0]))
iB = np.concatenate(([0], peaks, [len(stim) - 1]))
#Interpolate the envelope
c = np.interp(np.arange(len(stim)), iB, b)
#Lowpass filter the interpolated signal
nyquist = 0.5 * fs
normal_cutoff = lpf_freq / nyquist
b, a = butter(4, normal_cutoff, btype='low', analog=False)
d = filtfilt(b, a, c)
#Downsample the filtered signal
downsampled = resample(d, len(d) * ds_factor // fs)
processed_stimuli.append(downsampled)
return processed_stimuli
def preprocessAndEpoch(subject, para): #Trim start and end
modifiers = []
if not para.interpBads: modifiers.append("retainedBads")
if para.filterTimingOutliers: modifiers.append("removedTimeOutliers")
if para.doICA and not para.stricterICA: modifiers.append("ICA")
if para.stricterICA: modifiers.append("stricterICA")
if para.doASR: modifiers.append("ASR")
mod_tag = "_".join(modifiers) if modifiers else "raw"
cache_file = os.path.join(para.cache_dir, f"{subject}_multStreamLast30s_scalp_{mod_tag}-epo.fif")
if os.path.exists(cache_file):
print(f"Loading cached epochs for subject {subject}")
return mne.read_epochs(cache_file, preload=True)
else:
task = 'attnMultInstOBs'
eeg_type = 'scalp'
subjFolder = "sub-" + subject
base_path = para.basePath
bids_path = mne_bids.BIDSPath(root=para.dir_data, subject=subject, datatype='eeg', task=task, acquisition=eeg_type)
eeg_raw = mne_bids.read_raw_bids(bids_path)
eeg_raw.load_data()
eeg_bpFiltered = eeg_raw.filter(l_freq=para.hpf, h_freq=para.lpf)
#Handle bads by either marking and interpolating them, or keeping them:
if para.interpBads == True:
eeg_bpFiltered = badsMarker(eeg_bpFiltered, subjFolder, eeg_type, task)
eeg_bpFiltered.set_eeg_reference(ref_channels="average")
eeg_pastInterpStage = eeg_bpFiltered.copy().interpolate_bads()
eeg_pastInterpStage.set_eeg_reference(ref_channels="average")
else:
eeg_pastInterpStage = eeg_bpFiltered
if para.doASR == True:
asr = asrpy.ASR(sfreq=eeg_pastInterpStage.info["sfreq"], cutoff=20)
asr.fit(eeg_pastInterpStage)
eeg_pastASRstage = asr.transform(eeg_pastInterpStage)
else:
eeg_pastASRstage = eeg_pastInterpStage
if para.doICA == True:
ninterped = len(eeg_bpFiltered.info['bads'])
nchans = eeg_pastASRstage.info['nchan']
dims = nchans - ninterped - 1
ica = ICA(n_components=dims, max_iter="auto", random_state=97, method='infomax', fit_params=dict(extended=True))
ica.fit(eeg_pastASRstage)
#ICLabel to estimate probabilities
ic_labels = label_components(eeg_pastASRstage, ica, method="iclabel")
#List to store indices of components to exclude
exclusion_indices = []
if para.stricterICA == False: #Only remove ones labelled as eye artifacts
#Iterate through each prediction and label
for i, (label, proba) in enumerate(zip(ic_labels['labels'], ic_labels['y_pred_proba'])):
#Check if label is 'eye blink'
if label in ['eye blink']:
#Mark component for exclusion
exclusion_indices.append(i)
elif para.stricterICA == True:
#Threshold for exclusion
threshold = 0.5
#Iterate through each prediction and label
for i, (label, proba) in enumerate(zip(ic_labels['labels'], ic_labels['y_pred_proba'])):
#Check if label is not 'brain' or 'other' and probability is over threshold
if label not in ['brain'] or proba < threshold:
#Mark component for exclusion
exclusion_indices.append(i)
print("Components to exclude:", exclusion_indices)
eeg_preprocessed = eeg_pastASRstage.copy()
ica.apply(eeg_preprocessed, exclude=exclusion_indices, n_pca_components=dims)
if para.doICA != True:
eeg_preprocessed = eeg_pastASRstage
#Load event data
pathToEventsFile = os.path.join(para.dir_data, subjFolder, 'eeg', f'{subjFolder}_task-{task}_acq-{eeg_type}_events.tsv')
eventsData = pd.read_csv(pathToEventsFile, sep='\t')
#Load event configuration
pathToConfigFile = os.path.join(para.dir_data, 'task-attnMultInstOBs_events.json')
with open(pathToConfigFile, 'r') as configFile:
triggerConfig = json.load(configFile)
eventsArray = np.column_stack([(eventsData['onset']*1000).astype(int), np.zeros(len(eventsData), dtype=int), eventsData['value']])
unique_events_raw = np.unique(eventsArray[:, 2])
possibleTrialStartIDs = np.arange(1, 145, 2)
missing_events = set(possibleTrialStartIDs) - set(unique_events_raw)
trialStartIDs = list(set(possibleTrialStartIDs) - missing_events)
tmin = 35 + para.trial_trim_start
tmax = tmin + para.eegPeriodAfterTrim
epochs = mne.Epochs(eeg_preprocessed, eventsArray, event_id=trialStartIDs,
tmin=tmin, tmax=tmax, baseline=None, detrend=1, preload=True)
#Extract labels
attd_inst = []
setID = []
for event_id in trialStartIDs:
trigger_info = next((trigger for trigger in triggerConfig['triggers'] if trigger['value'] == event_id), None)
if trigger_info:
setID.append(trigger_info['additional_info'][0:5])
if 'Vibr' in trigger_info['additional_info']:
attd_inst.append('Vibr')
elif 'Harm' in trigger_info['additional_info']:
attd_inst.append('Harm')
elif 'Keyb' in trigger_info['additional_info']:
attd_inst.append('Keyb')
epochs.metadata = pd.DataFrame({'Set': setID, 'attd_inst': attd_inst})
epochs.metadata.reset_index(drop=True, inplace=True)
if para.filterTimingOutliers:
#Filter out
pathToErrorsDataFile = os.path.join(para.dir_data, "derivatives/significantEventTimingErrors_perSub", f'{subjFolder}_significantEventTimingErrors_triLen.tsv')
trigErrorData = pd.read_csv(pathToErrorsDataFile, sep='\t')
relevantRow = trigErrorData[(trigErrorData['Task']==task) & (trigErrorData['EEG Type']==eeg_type)]
timingOutliers = relevantRow['Trials with |Δt - <Δt>|>10ms'].iloc[0]
if pd.isna(timingOutliers): #Accounts for where there are none
timingOutliers = []
else:
timingOutliers = ast.literal_eval(timingOutliers) # safely convert to list
timingOutliers = [int(i) for i in timingOutliers] # ensure they're ints
epochs.drop(timingOutliers)
epochs_normalised = epochs.apply_function(lambda x: zscore(x, axis=-1))
#Downsample EEG
decimFactor = int(para.eegFs / para.ds)
epochs_normalised.decimate(decim=decimFactor, offset=0, verbose=None)
epochs_normalised.save(cache_file, overwrite=True)
return epochs_normalised
def preprocessAndEpoch_MSfirst30s(subject, para): #Trim start and end
modifiers = []
if not para.interpBads: modifiers.append("retainedBads")
if para.filterTimingOutliers: modifiers.append("removedTimeOutliers")
if para.doICA and not para.stricterICA: modifiers.append("ICA")
if para.stricterICA: modifiers.append("stricterICA")
if para.doASR: modifiers.append("ASR")
mod_tag = "_".join(modifiers) if modifiers else "raw"
cache_file = os.path.join(para.cache_dir, f"{subject}_multStream1st30s_scalp_{mod_tag}-epo.fif")
if os.path.exists(cache_file):
print(f"Loading cached epochs for subject {subject}")
return mne.read_epochs(cache_file, preload=True)
else:
task = 'attnMultInstOBs'
eeg_type = 'scalp'
subjFolder = "sub-" + subject
base_path = para.basePath
bids_path = mne_bids.BIDSPath(root=para.dir_data, subject=subject, datatype='eeg', task=task, acquisition=eeg_type)
eeg_raw = mne_bids.read_raw_bids(bids_path)
eeg_raw.load_data()
eeg_bpFiltered = eeg_raw.filter(l_freq=para.hpf, h_freq=para.lpf)
#Handle bads by either marking and interpolating them, or keeping them:
if para.interpBads == True:
eeg_bpFiltered = badsMarker(eeg_bpFiltered, subjFolder, eeg_type, task)
eeg_bpFiltered.set_eeg_reference(ref_channels="average")
eeg_pastInterpStage = eeg_bpFiltered.copy().interpolate_bads()
eeg_pastInterpStage.set_eeg_reference(ref_channels="average")
else:
eeg_pastInterpStage = eeg_bpFiltered
if para.doASR == True:
asr = asrpy.ASR(sfreq=eeg_pastInterpStage.info["sfreq"], cutoff=20)
asr.fit(eeg_pastInterpStage)
eeg_pastASRstage = asr.transform(eeg_pastInterpStage)
else:
eeg_pastASRstage = eeg_pastInterpStage
if para.doICA == True:
ninterped = len(eeg_bpFiltered.info['bads'])
nchans = eeg_pastASRstage.info['nchan']
dims = nchans - ninterped - 1
ica = ICA(n_components=dims, max_iter="auto", random_state=97, method='infomax', fit_params=dict(extended=True))
ica.fit(eeg_pastASRstage)
#ICLabel to estimate probabilities
ic_labels = label_components(eeg_pastASRstage, ica, method="iclabel")
#List to store indices of components to exclude
exclusion_indices = []
if para.stricterICA == False: #Only remove ones labelled as eye artifacts
#Iterate through each prediction and label
for i, (label, proba) in enumerate(zip(ic_labels['labels'], ic_labels['y_pred_proba'])):
#Check if label is 'eye blink'
if label in ['eye blink']:
#Mark component for exclusion
exclusion_indices.append(i)
elif para.stricterICA == True:
#Threshold for exclusion
threshold = 0.5
#Iterate through each prediction and label
for i, (label, proba) in enumerate(zip(ic_labels['labels'], ic_labels['y_pred_proba'])):
#Check if label is not 'brain' or 'other' and probability is over threshold
if label not in ['brain'] or proba < threshold:
#Mark component for exclusion
exclusion_indices.append(i)
print("Components to exclude:", exclusion_indices)
eeg_preprocessed = eeg_pastASRstage.copy()
ica.apply(eeg_preprocessed, exclude=exclusion_indices, n_pca_components=dims)
if para.doICA != True:
eeg_preprocessed = eeg_pastASRstage
#Load event data
pathToEventsFile = os.path.join(para.dir_data, subjFolder, 'eeg', f'{subjFolder}_task-{task}_acq-{eeg_type}_events.tsv')
eventsData = pd.read_csv(pathToEventsFile, sep='\t')
#Load event configuration
pathToConfigFile = os.path.join(para.dir_data, 'task-attnMultInstOBs_events.json')
with open(pathToConfigFile, 'r') as configFile:
triggerConfig = json.load(configFile)
eventsArray = np.column_stack([(eventsData['onset']*1000).astype(int), np.zeros(len(eventsData), dtype=int), eventsData['value']])
unique_events_raw = np.unique(eventsArray[:, 2])
possibleTrialStartIDs = np.arange(1, 145, 2)
missing_events = set(possibleTrialStartIDs) - set(unique_events_raw)
trialStartIDs = list(set(possibleTrialStartIDs) - missing_events)
tmin = para.trial_trim_start
tmax = tmin + para.eegPeriodAfterTrim
epochs = mne.Epochs(eeg_preprocessed, eventsArray, event_id=trialStartIDs,
tmin=tmin, tmax=tmax, baseline=None, detrend=1, preload=True)
#Extract labels
attd_inst = []
setID = []
for event_id in trialStartIDs:
trigger_info = next((trigger for trigger in triggerConfig['triggers'] if trigger['value'] == event_id), None)
if trigger_info:
setID.append(trigger_info['additional_info'][0:5])
if 'Vibr' in trigger_info['additional_info']:
attd_inst.append('Vibr')
elif 'Harm' in trigger_info['additional_info']:
attd_inst.append('Harm')
elif 'Keyb' in trigger_info['additional_info']:
attd_inst.append('Keyb')
epochs.metadata = pd.DataFrame({'Set': setID, 'attd_inst': attd_inst})
epochs.metadata.reset_index(drop=True, inplace=True)
if para.filterTimingOutliers:
#Filter out
pathToErrorsDataFile = os.path.join(para.dir_data, "derivatives/significantEventTimingErrors_perSub", f'{subjFolder}_significantEventTimingErrors_triLen.tsv')
trigErrorData = pd.read_csv(pathToErrorsDataFile, sep='\t')
relevantRow = trigErrorData[(trigErrorData['Task']==task) & (trigErrorData['EEG Type']==eeg_type)]
timingOutliers = relevantRow['Trials with |Δt - <Δt>|>10ms'].iloc[0]
if pd.isna(timingOutliers): #Accounts for where there are none
timingOutliers = []
else:
timingOutliers = ast.literal_eval(timingOutliers) # safely convert to list
timingOutliers = [int(i) for i in timingOutliers] # ensure they're ints
epochs.drop(timingOutliers)
epochs_normalised = epochs.apply_function(lambda x: zscore(x, axis=-1))
#Downsample EEG
decimFactor = int(para.eegFs / para.ds)
epochs_normalised.decimate(decim=decimFactor, offset=0, verbose=None)
epochs_normalised.save(cache_file, overwrite=True)
return epochs_normalised
def preprocessAndEpoch_singleStream(subject, para):
modifiers = []
if not para.interpBads: modifiers.append("retainedBads")
if para.filterTimingOutliers: modifiers.append("removedTimeOutliers")
if para.doICA and not para.stricterICA: modifiers.append("ICA")
if para.stricterICA: modifiers.append("stricterICA")
if para.doASR: modifiers.append("ASR")
mod_tag = "_".join(modifiers) if modifiers else "raw"
cache_file = os.path.join(para.cache_dir, f"{subject}_singStream_scalp_{mod_tag}-epo.fif")
if os.path.exists(cache_file):
print(f"Loading cached epochs for subject {subject}")
return mne.read_epochs(cache_file, preload=True)
else:
task = 'attnOneInstNoOBs'
eeg_type = 'scalp'
subjFolder = "sub-" + subject
base_path = pathlib.Path(__file__).resolve().parents[2]
bids_path = mne_bids.BIDSPath(root=para.dir_data, subject=subject, datatype='eeg', task=task, acquisition=eeg_type)
eeg_raw = mne_bids.read_raw_bids(bids_path)
eeg_raw.load_data()
eeg_bpFiltered = eeg_raw.filter(l_freq=para.hpf, h_freq=para.lpf)
#Handle bads by either marking and interpolating them, or keeping them:
if para.interpBads == True:
eeg_bpFiltered = badsMarker(eeg_bpFiltered, subjFolder, eeg_type, task)
eeg_bpFiltered.set_eeg_reference(ref_channels="average")
eeg_pastInterpStage = eeg_bpFiltered.copy().interpolate_bads()
eeg_pastInterpStage.set_eeg_reference(ref_channels="average")
else:
eeg_pastInterpStage = eeg_bpFiltered
if para.doASR == True:
asr = asrpy.ASR(sfreq=eeg_pastInterpStage.info["sfreq"], cutoff=20)
asr.fit(eeg_pastInterpStage)
eeg_pastASRstage = asr.transform(eeg_pastInterpStage)
else:
eeg_pastASRstage = eeg_pastInterpStage
if para.doICA == True:
ninterped = len(eeg_bpFiltered.info['bads'])
nchans = eeg_pastASRstage.info['nchan']
dims = nchans - ninterped - 1
ica = ICA(n_components=dims, max_iter="auto", random_state=97, method='infomax', fit_params=dict(extended=True))
ica.fit(eeg_pastASRstage)
#ICLabel to estimate probabilities
ic_labels = label_components(eeg_pastASRstage, ica, method="iclabel")
#List to store indices of components to exclude
exclusion_indices = []
if para.stricterICA == False: #Only remove ones labelled as eye artifacts
#Iterate through each prediction and label
for i, (label, proba) in enumerate(zip(ic_labels['labels'], ic_labels['y_pred_proba'])):
#Check if label is 'eye blink'
if label in ['eye blink']:
#Mark component for exclusion
exclusion_indices.append(i)
elif para.stricterICA == True:
#Threshold for exclusion
threshold = 0.5
#Iterate through each prediction and label
for i, (label, proba) in enumerate(zip(ic_labels['labels'], ic_labels['y_pred_proba'])):
#Check if label is not 'brain' or 'other' and probability is over threshold
if label not in ['brain'] or proba < threshold:
#Mark component for exclusion
exclusion_indices.append(i)
print("Components to exclude:", exclusion_indices)
eeg_preprocessed = eeg_pastASRstage.copy()
ica.apply(eeg_preprocessed, exclude=exclusion_indices, n_pca_components=dims)
if para.doICA != True:
eeg_preprocessed = eeg_pastASRstage
#Load event data
pathToEventsFile = os.path.join(para.dir_data, subjFolder, 'eeg', f'{subjFolder}_task-{task}_acq-{eeg_type}_events.tsv')
eventsData = pd.read_csv(pathToEventsFile, sep='\t')
#Load event configuration
pathToConfigFile = os.path.join(para.dir_data, 'task-attnOneInstNoOBs_events.json')
with open(pathToConfigFile, 'r') as configFile:
triggerConfig = json.load(configFile)
#MUST CONVERT eventsData['onset'] FROM SECONDS TO MS
eventsArray = np.column_stack([(eventsData['onset']*para.eegFs).astype(int), np.zeros(len(eventsData), dtype=int), eventsData['value']])
unique_events_raw = np.unique(eventsArray[:, 2]) #All event IDs in this particular task
possibleTrialStartIDs = np.arange(1, 145, 2) #ALL possible trial start IDs for all tasks
missing_events = set(possibleTrialStartIDs) - set(unique_events_raw) #Possible start IDs NOT in this particular task
trialStartIDs = []
for event in eventsArray:
event_id = event[2]
if event_id in possibleTrialStartIDs and event_id not in missing_events and event_id not in trialStartIDs:
trialStartIDs.append(event_id)
event_id = dict(zip(map(str, trialStartIDs), trialStartIDs))
tmin = para.trial_trim_start
tmax = tmin+para.eegPeriodAfterTrim
#Create epochs
epochs = mne.Epochs(eeg_preprocessed, eventsArray, event_id=event_id,
tmin=tmin, tmax=tmax, baseline=None, detrend=1, preload=True)
#Add labels:
pathToAttendanceData = os.path.join(para.dir_data, subjFolder, 'beh', f'{subjFolder}_task-{task}_beh.tsv')
df = pd.read_csv(pathToAttendanceData,sep='\t')
df = df[['stimuli','music_attended']]
labels = []
stimulus_all = []
for i in range(0, len(df)-1): #Includes prac trial
attdMus = df.iloc[i]['music_attended']
if attdMus == "Yes":
label = "attd"
if attdMus == "No":
label = "unattd"
labels+= [label]
stimulus = df.iloc[i]['stimuli'][-32:-22]
stimulus_all += [stimulus]
#Add metadata with labels to epochs
epochs.metadata = pd.DataFrame({'stimulus': stimulus_all,'music_attd': labels})
epochs.metadata.reset_index(drop=True, inplace=True) #Reset index to ensure correct indexing
if para.filterTimingOutliers:
#Filter out
pathToErrorsDataFile = os.path.join(para.dir_data, "derivatives/significantEventTimingErrors_perSub", f'{subjFolder}_significantEventTimingErrors_triLen.tsv')
trigErrorData = pd.read_csv(pathToErrorsDataFile, sep='\t')
relevantRow = trigErrorData[(trigErrorData['Task']==task) & (trigErrorData['EEG Type']==eeg_type)]
timingOutliers = relevantRow['Trials with |Δt - <Δt>|>10ms'].iloc[0]
if pd.isna(timingOutliers): #Accounts for where there are none
timingOutliers = []
else:
timingOutliers = ast.literal_eval(timingOutliers) # safely convert to list
timingOutliers = [int(i) for i in timingOutliers] # ensure they're ints
epochs.drop(timingOutliers)
epochs_normalised = epochs.apply_function(lambda x: zscore(x, axis=-1))
#Downsample EEG
decimFactor = int(para.eegFs / para.ds)
epochs_normalised.decimate(decim=decimFactor, offset=0, verbose=None)
epochs_normalised.save(cache_file, overwrite=True)
return epochs_normalised
def preprocessAndEpoch_emoDec(subject, para):
modifiers = []
if not para.interpBads: modifiers.append("retainedBads")
if para.filterTimingOutliers: modifiers.append("removedTimeOutliers")
if para.doICA and not para.stricterICA: modifiers.append("ICA")
if para.stricterICA: modifiers.append("stricterICA")
if para.doASR: modifiers.append("ASR")
mod_tag = "_".join(modifiers) if modifiers else "raw"
cache_file = os.path.join(para.cache_dir, f"{subject}_emoDec_scalp_{mod_tag}-epo.fif")
if os.path.exists(cache_file):
print(f"Loading cached epochs for subject {subject}")
return mne.read_epochs(cache_file, preload=True)
else:
task = 'emotion'
eeg_type = 'scalp'
subjFolder = "sub-" + subject
base_path = pathlib.Path(__file__).resolve().parents[2]
bids_path = mne_bids.BIDSPath(root=para.dir_data, subject=subject, datatype='eeg', task=task, acquisition=eeg_type)
eeg_raw = mne_bids.read_raw_bids(bids_path)
eeg_raw.load_data()
eeg_bpFiltered = eeg_raw.filter(l_freq=para.hpf, h_freq=para.lpf)
#Handle bads by either marking and interpolating them, or keeping them:
if para.interpBads == True:
eeg_bpFiltered = badsMarker(eeg_bpFiltered, subjFolder, eeg_type, task)
eeg_bpFiltered.set_eeg_reference(ref_channels="average")
eeg_pastInterpStage = eeg_bpFiltered.copy().interpolate_bads()
eeg_pastInterpStage.set_eeg_reference(ref_channels="average")
else:
eeg_pastInterpStage = eeg_bpFiltered
if para.doASR == True:
asr = asrpy.ASR(sfreq=eeg_pastInterpStage.info["sfreq"], cutoff=20)
asr.fit(eeg_pastInterpStage)
eeg_pastASRstage = asr.transform(eeg_pastInterpStage)
else:
eeg_pastASRstage = eeg_pastInterpStage
if para.doICA == True:
ninterped = len(eeg_bpFiltered.info['bads'])
nchans = eeg_pastASRstage.info['nchan']
dims = nchans - ninterped - 1
ica = ICA(n_components=dims, max_iter="auto", random_state=97, method='infomax', fit_params=dict(extended=True))
ica.fit(eeg_pastASRstage)
#ICLabel to estimate probabilities
ic_labels = label_components(eeg_pastASRstage, ica, method="iclabel")
#List to store indices of components to exclude
exclusion_indices = []
if para.stricterICA == False: #Only remove ones labelled as eye artifacts
#Iterate through each prediction and label
for i, (label, proba) in enumerate(zip(ic_labels['labels'], ic_labels['y_pred_proba'])):
#Check if label is 'eye blink'
if label in ['eye blink']:
#Mark component for exclusion
exclusion_indices.append(i)
elif para.stricterICA == True:
#Threshold for exclusion
threshold = 0.5
#Iterate through each prediction and label
for i, (label, proba) in enumerate(zip(ic_labels['labels'], ic_labels['y_pred_proba'])):
#Check if label is not 'brain' or 'other' and probability is over threshold
if label not in ['brain'] or proba < threshold:
#Mark component for exclusion
exclusion_indices.append(i)
print("Components to exclude:", exclusion_indices)
eeg_preprocessed = eeg_pastASRstage.copy()
ica.apply(eeg_preprocessed, exclude=exclusion_indices, n_pca_components=dims)
if para.doICA != True:
eeg_preprocessed = eeg_pastASRstage
#Load event data
pathToEventsFile = os.path.join(para.dir_data, subjFolder, 'eeg', f'{subjFolder}_task-{task}_acq-{eeg_type}_events.tsv')
eventsData = pd.read_csv(pathToEventsFile, sep='\t')
#Load event configuration
pathToConfigFile = os.path.join(para.dir_data, 'task-attnOneInstNoOBs_events.json')
with open(pathToConfigFile, 'r') as configFile:
triggerConfig = json.load(configFile)
#MUST CONVERT eventsData['onset'] FROM SECONDS TO MS
eventsArray = np.column_stack([(eventsData['onset']*para.eegFs).astype(int), np.zeros(len(eventsData), dtype=int), eventsData['value']])
unique_events_raw = np.unique(eventsArray[:, 2]) #All event IDs in this particular task
possibleTrialStartIDs = np.arange(1, 145, 2) #ALL possible trial start IDs for all tasks
missing_events = set(possibleTrialStartIDs) - set(unique_events_raw) #Possible start IDs NOT in this particular task
trialStartIDs = []
for event in eventsArray:
event_id = event[2]
if event_id in possibleTrialStartIDs and event_id not in missing_events and event_id not in trialStartIDs:
trialStartIDs.append(event_id)
event_id = dict(zip(map(str, trialStartIDs), trialStartIDs))
tmin = para.trial_trim_start
tmax = tmin+para.eegPeriodAfterTrim
#Create epochs
epochs = mne.Epochs(eeg_preprocessed, eventsArray, event_id=event_id,
tmin=tmin, tmax=tmax, baseline=None, detrend=1, preload=True)
#Add labels:
pathToAttendanceData = os.path.join(para.dir_data, subjFolder, 'beh', f'{subjFolder}_task-{task}_beh.tsv')
df = pd.read_csv(pathToAttendanceData,sep='\t')
df = df[['stimuli']]
stimulus_all = []
for i in range(0, len(df)-1): #Includes prac trial
stimulus = df.iloc[i]['stimuli'][-32:-22]
stimulus_all += [stimulus]
#Add metadata with labels to epochs
epochs.metadata = pd.DataFrame({'stimulus': stimulus_all})
epochs.metadata.reset_index(drop=True, inplace=True) #Reset index to ensure correct indexing
if para.filterTimingOutliers:
#Filter out
pathToErrorsDataFile = os.path.join(para.dir_data, "derivatives/significantEventTimingErrors_perSub", f'{subjFolder}_significantEventTimingErrors_triLen.tsv')
trigErrorData = pd.read_csv(pathToErrorsDataFile, sep='\t')
relevantRow = trigErrorData[(trigErrorData['Task']==task) & (trigErrorData['EEG Type']==eeg_type)]
timingOutliers = relevantRow['Trials with |Δt - <Δt>|>10ms'].iloc[0]
if pd.isna(timingOutliers): #Accounts for where there are none
timingOutliers = []
else:
timingOutliers = ast.literal_eval(timingOutliers) # safely convert to list
timingOutliers = [int(i) for i in timingOutliers] # ensure they're ints
epochs.drop(timingOutliers)
epochs_normalised = epochs.apply_function(lambda x: zscore(x, axis=-1))
#Downsample EEG
decimFactor = int(para.eegFs / para.ds)
epochs_normalised.decimate(decim=decimFactor, offset=0, verbose=None)
epochs_normalised.save(cache_file, overwrite=True)
return epochs_normalised
#Plotting function for confusion matrix
def plot_confusion_matrix(cm, classes, title, cmap=plt.cm.Blues):
plt.figure()
sns.heatmap(cm, annot=True, fmt='d', cmap=cmap, xticklabels=classes, yticklabels=classes)
plt.title(title)
plt.ylabel('True label')
plt.xlabel('Predicted label')
plt.show()
def preprocessAndEpoch_ceegrid(subject, para): #Trim start and end
modifiers = []
if not para.interpBads: modifiers.append("retainedBads")
if para.filterTimingOutliers: modifiers.append("removedTimeOutliers")
if para.doICA and not para.stricterICA: modifiers.append("ICA")
if para.stricterICA: modifiers.append("stricterICA")
if para.doASR: modifiers.append("ASR")
if para.removeFpz != True:
modifiers.append("FpzKept")
mod_tag = "_".join(modifiers) if modifiers else "raw"
cache_file = os.path.join(para.cache_dir, f"{subject}_multStreamLasthalf_ceegrid_{mod_tag}-epo.fif")
if os.path.exists(cache_file):
print(f"Loading cached epochs for subject {subject}")
return mne.read_epochs(cache_file, preload=True)
else:
task = 'attnMultInstOBs'
eeg_type = 'ceegrid'
subjFolder = "sub-" + subject
base_path = para.basePath
bids_path = mne_bids.BIDSPath(root=para.dir_data, subject=subject, datatype='eeg', task=task, acquisition=eeg_type)
eeg_raw = mne_bids.read_raw_bids(bids_path)
eeg_raw.load_data()
if para.removeFpz == True:
eeg_raw.drop_channels(['Fpz'])
eeg_raw.set_eeg_reference(ref_channels="average") #Removed a channel, so given that we're using average ref it is best to reref
eeg_bpFiltered = eeg_raw.filter(l_freq=para.hpf, h_freq=para.lpf)
#Handle bads by either marking and interpolating them, or keeping them:
if para.interpBads == True:
eeg_bpFiltered = badsMarker(eeg_bpFiltered, subjFolder, eeg_type, task)
eeg_bpFiltered.set_eeg_reference(ref_channels="average")
eeg_pastInterpStage = eeg_bpFiltered.copy().interpolate_bads()
eeg_pastInterpStage.set_eeg_reference(ref_channels="average")
else:
eeg_pastInterpStage = eeg_bpFiltered
if para.doASR == True:
asr = asrpy.ASR(sfreq=eeg_pastInterpStage.info["sfreq"], cutoff=20)
asr.fit(eeg_pastInterpStage)
eeg_pastASRstage = asr.transform(eeg_pastInterpStage)
else:
eeg_pastASRstage = eeg_pastInterpStage
if para.doICA == True:
ninterped = len(eeg_bpFiltered.info['bads'])
nchans = eeg_pastASRstage.info['nchan']
dims = nchans - ninterped - 1
ica = ICA(n_components=dims, max_iter="auto", random_state=97, method='infomax', fit_params=dict(extended=True))
ica.fit(eeg_pastASRstage)
#ICLabel to estimate probabilities
ic_labels = label_components(eeg_pastASRstage, ica, method="iclabel")
#List to store indices of components to exclude
exclusion_indices = []
if para.stricterICA == False: #Only remove ones labelled as eye artifacts
#Iterate through each prediction and label
for i, (label, proba) in enumerate(zip(ic_labels['labels'], ic_labels['y_pred_proba'])):
#Check if label is 'eye blink'
if label in ['eye blink']:
#Mark component for exclusion
exclusion_indices.append(i)
elif para.stricterICA == True:
#Threshold for exclusion
threshold = 0.5
#Iterate through each prediction and label
for i, (label, proba) in enumerate(zip(ic_labels['labels'], ic_labels['y_pred_proba'])):
#Check if label is not 'brain' or 'other' and probability is over threshold
if label not in ['brain'] or proba < threshold:
#Mark component for exclusion
exclusion_indices.append(i)
print("Components to exclude:", exclusion_indices)
eeg_preprocessed = eeg_pastASRstage.copy()
ica.apply(eeg_preprocessed, exclude=exclusion_indices, n_pca_components=dims)
if para.doICA != True:
eeg_preprocessed = eeg_pastASRstage
#Load event data
pathToEventsFile = os.path.join(para.dir_data, subjFolder, 'eeg', f'{subjFolder}_task-{task}_acq-{eeg_type}_events.tsv')
eventsData = pd.read_csv(pathToEventsFile, sep='\t')
#Load event configuration
pathToConfigFile = os.path.join(para.dir_data, 'task-attnMultInstOBs_events.json')
with open(pathToConfigFile, 'r') as configFile:
triggerConfig = json.load(configFile)
eventsArray = np.column_stack([(eventsData['onset']*1000).astype(int), np.zeros(len(eventsData), dtype=int), eventsData['value']])
unique_events_raw = np.unique(eventsArray[:, 2])
possibleTrialStartIDs = np.arange(1, 145, 2)
missing_events = set(possibleTrialStartIDs) - set(unique_events_raw)
trialStartIDs = list(set(possibleTrialStartIDs) - missing_events)
tmin = 35 + para.trial_trim_start
tmax = tmin+para.eegPeriodAfterTrim
epochs = mne.Epochs(eeg_preprocessed, eventsArray, event_id=trialStartIDs,
tmin=tmin, tmax=tmax, baseline=None, detrend=1, preload=True)
#Extract labels
attd_inst = []
setID = []
for event_id in trialStartIDs:
trigger_info = next((trigger for trigger in triggerConfig['triggers'] if trigger['value'] == event_id), None)
if trigger_info:
setID.append(trigger_info['additional_info'][0:5])
if 'Vibr' in trigger_info['additional_info']:
attd_inst.append('Vibr')
elif 'Harm' in trigger_info['additional_info']:
attd_inst.append('Harm')
elif 'Keyb' in trigger_info['additional_info']:
attd_inst.append('Keyb')
epochs.metadata = pd.DataFrame({'Set': setID, 'attd_inst': attd_inst})
epochs.metadata.reset_index(drop=True, inplace=True)
if para.filterTimingOutliers:
#Filter out
pathToErrorsDataFile = os.path.join(para.dir_data, "derivatives/significantEventTimingErrors_perSub", f'{subjFolder}_significantEventTimingErrors_triLen.tsv')
trigErrorData = pd.read_csv(pathToErrorsDataFile, sep='\t')
relevantRow = trigErrorData[(trigErrorData['Task']==task) & (trigErrorData['EEG Type']==eeg_type)]
timingOutliers = relevantRow['Trials with |Δt - <Δt>|>10ms'].iloc[0]
if pd.isna(timingOutliers): #Accounts for where there are none
timingOutliers = []
else:
timingOutliers = ast.literal_eval(timingOutliers) # safely convert to list
timingOutliers = [int(i) for i in timingOutliers] # ensure they're ints
epochs.drop(timingOutliers)
epochs_normalised = epochs.apply_function(lambda x: zscore(x, axis=-1))
#Downsample EEG
decimFactor = int(para.eegFs / para.ds)
epochs_normalised.decimate(decim=decimFactor, offset=0, verbose=None)
epochs_normalised.save(cache_file, overwrite=True)
return epochs_normalised
def preprocessAndEpoch_ceegrid_MSfirst30s(subject, para): #Trim start and end
modifiers = []
if not para.interpBads: modifiers.append("retainedBads")
if para.filterTimingOutliers: modifiers.append("removedTimeOutliers")
if para.doICA and not para.stricterICA: modifiers.append("ICA")
if para.stricterICA: modifiers.append("stricterICA")
if para.doASR: modifiers.append("ASR")
if para.removeFpz != True:
modifiers.append("FpzKept")
mod_tag = "_".join(modifiers) if modifiers else "raw"
cache_file = os.path.join(para.cache_dir, f"{subject}_multStream1st30s_ceegrid_{mod_tag}-epo.fif")
if os.path.exists(cache_file):
print(f"Loading cached epochs for subject {subject}")
return mne.read_epochs(cache_file, preload=True)
else:
task = 'attnMultInstOBs'
eeg_type = 'ceegrid'
subjFolder = "sub-" + subject
base_path = para.basePath
bids_path = mne_bids.BIDSPath(root=para.dir_data, subject=subject, datatype='eeg', task=task, acquisition=eeg_type)
eeg_raw = mne_bids.read_raw_bids(bids_path)
eeg_raw.load_data()
if para.removeFpz == True:
eeg_raw.drop_channels(['Fpz'])
eeg_raw.set_eeg_reference(ref_channels="average") #Removed a channel, so given that we're using average ref it is best to reref
eeg_bpFiltered = eeg_raw.filter(l_freq=para.hpf, h_freq=para.lpf)
#Handle bads by either marking and interpolating them, or keeping them:
if para.interpBads == True:
eeg_bpFiltered = badsMarker(eeg_bpFiltered, subjFolder, eeg_type, task)
eeg_bpFiltered.set_eeg_reference(ref_channels="average")
eeg_pastInterpStage = eeg_bpFiltered.copy().interpolate_bads()
eeg_pastInterpStage.set_eeg_reference(ref_channels="average")
else:
eeg_pastInterpStage = eeg_bpFiltered
if para.doASR == True:
asr = asrpy.ASR(sfreq=eeg_pastInterpStage.info["sfreq"], cutoff=20)
asr.fit(eeg_pastInterpStage)
eeg_pastASRstage = asr.transform(eeg_pastInterpStage)
else:
eeg_pastASRstage = eeg_pastInterpStage
if para.doICA == True:
ninterped = len(eeg_bpFiltered.info['bads'])
nchans = eeg_pastASRstage.info['nchan']
dims = nchans - ninterped - 1
ica = ICA(n_components=dims, max_iter="auto", random_state=97, method='infomax', fit_params=dict(extended=True))
ica.fit(eeg_pastASRstage)
#ICLabel to estimate probabilities
ic_labels = label_components(eeg_pastASRstage, ica, method="iclabel")
#List to store indices of components to exclude
exclusion_indices = []
if para.stricterICA == False: #Only remove ones labelled as eye artifacts
#Iterate through each prediction and label
for i, (label, proba) in enumerate(zip(ic_labels['labels'], ic_labels['y_pred_proba'])):
#Check if label is 'eye blink'
if label in ['eye blink']:
#Mark component for exclusion
exclusion_indices.append(i)
elif para.stricterICA == True:
#Threshold for exclusion
threshold = 0.5
#Iterate through each prediction and label
for i, (label, proba) in enumerate(zip(ic_labels['labels'], ic_labels['y_pred_proba'])):
#Check if label is not 'brain' or 'other' and probability is over threshold
if label not in ['brain'] or proba < threshold:
#Mark component for exclusion
exclusion_indices.append(i)
print("Components to exclude:", exclusion_indices)
eeg_preprocessed = eeg_pastASRstage.copy()
ica.apply(eeg_preprocessed, exclude=exclusion_indices, n_pca_components=dims)
if para.doICA != True:
eeg_preprocessed = eeg_pastASRstage
#Load event data
pathToEventsFile = os.path.join(para.dir_data, subjFolder, 'eeg', f'{subjFolder}_task-{task}_acq-{eeg_type}_events.tsv')
eventsData = pd.read_csv(pathToEventsFile, sep='\t')
#Load event configuration
pathToConfigFile = os.path.join(para.dir_data, 'task-attnMultInstOBs_events.json')
with open(pathToConfigFile, 'r') as configFile:
triggerConfig = json.load(configFile)
eventsArray = np.column_stack([(eventsData['onset']*1000).astype(int), np.zeros(len(eventsData), dtype=int), eventsData['value']])
unique_events_raw = np.unique(eventsArray[:, 2])
possibleTrialStartIDs = np.arange(1, 145, 2)
missing_events = set(possibleTrialStartIDs) - set(unique_events_raw)
trialStartIDs = list(set(possibleTrialStartIDs) - missing_events)
tmin = para.trial_trim_start
tmax = tmin+para.eegPeriodAfterTrim
epochs = mne.Epochs(eeg_preprocessed, eventsArray, event_id=trialStartIDs,
tmin=tmin, tmax=tmax, baseline=None, detrend=1, preload=True)
#Extract labels
attd_inst = []
setID = []
for event_id in trialStartIDs:
trigger_info = next((trigger for trigger in triggerConfig['triggers'] if trigger['value'] == event_id), None)
if trigger_info:
setID.append(trigger_info['additional_info'][0:5])
if 'Vibr' in trigger_info['additional_info']:
attd_inst.append('Vibr')
elif 'Harm' in trigger_info['additional_info']:
attd_inst.append('Harm')
elif 'Keyb' in trigger_info['additional_info']:
attd_inst.append('Keyb')
epochs.metadata = pd.DataFrame({'Set': setID, 'attd_inst': attd_inst})
epochs.metadata.reset_index(drop=True, inplace=True)
if para.filterTimingOutliers:
#Filter out
pathToErrorsDataFile = os.path.join(para.dir_data, "derivatives/significantEventTimingErrors_perSub", f'{subjFolder}_significantEventTimingErrors_triLen.tsv')
trigErrorData = pd.read_csv(pathToErrorsDataFile, sep='\t')
relevantRow = trigErrorData[(trigErrorData['Task']==task) & (trigErrorData['EEG Type']==eeg_type)]
timingOutliers = relevantRow['Trials with |Δt - <Δt>|>10ms'].iloc[0]
if pd.isna(timingOutliers): #Accounts for where there are none
timingOutliers = []
else:
timingOutliers = ast.literal_eval(timingOutliers) # safely convert to list
timingOutliers = [int(i) for i in timingOutliers] # ensure they're ints
epochs.drop(timingOutliers)
epochs_normalised = epochs.apply_function(lambda x: zscore(x, axis=-1))
#Downsample EEG
decimFactor = int(para.eegFs / para.ds)
epochs_normalised.decimate(decim=decimFactor, offset=0, verbose=None)
epochs_normalised.save(cache_file, overwrite=True)
return epochs_normalised
def preprocessAndEpoch_singleStream_ceegrid(subject, para):
modifiers = []
if not para.interpBads: modifiers.append("retainedBads")
if para.filterTimingOutliers: modifiers.append("removedTimeOutliers")
if para.doICA and not para.stricterICA: modifiers.append("ICA")