[WIP] examples for BEP044, Stim-BIDS

stimuli_structure/README

@@ -0,0 +1,3 @@
+# Draft Structure for the stimuli directory
+
+Following the discussions under https://github.com/bids-standard/bids-specification/issues/153 and https://github.com/bids-standard/bids-specification/issues/751, here is a draft structure for the stimuli directory and how it could be integrated into the BIDS data runs.

stimuli_structure/dataset_description.json

@@ -0,0 +1,8 @@
+{
+  "Name": "Stimuli structure sample dataset.",
+  "License": "CC BY-NC-SA 4.0",
+  "Authors": ["Seyed Yahya Shirazi"], 
+  "EthicsApprovals": ["Both data runs have ethical epproval in their respective experiments."],
+  "BIDSVersion": "1.8.0",
+  "HEDVersion": "8.2.0"
+}

stimuli_structure/participants.json

@@ -0,0 +1,17 @@
+{
+    "participant_id": {
+        "Description": "The prticipant ID set in the HBN dataset"
+    },
+    "sex": {
+        "LongName": "Gender",
+        "Description": "Gender",
+        "Levels": {
+            "F": "Female",
+            "M": "Male"
+            }
+    },
+    "age": {
+        "LongName": "Age",
+        "Description": "Age in years"
+    }
+}

stimuli_structure/participants.tsv

@@ -0,0 +1,3 @@
+participant_id	sex	age
+sub-sampleTimeVarying	F	7.98
+sub-sampleStillImage	M	xxx

stimuli_structure/stimuli/stim-the-present_annot-LogLumRatio_events.json

@@ -0,0 +1,17 @@
+{
+    "onset": {
+        "LongName": "Event onset",
+        "Description": "Position (latency) of event marker in seconds relative to the start.",
+        "Units": "seconds"
+    },
+    "duration": {
+        "Description": "Duration of the event. For this stimulus, this is the duration of the shot.",
+        "Units": "seconds"
+    },
+    "shot_number": {
+        "Description": "Shot sequence number in the movie"
+    },
+    "LLR": {
+        "Description": "Log Luminance Ratio"
+    }
+}

stimuli_structure/stimuli/stim-the-present_annot-LogLumRatio_events.tsv

@@ -0,0 +1,59 @@
+onset	duration	shot_number	LLR
+0	n/a	video_start	video_start
+0	7.25	1	n/a
+7.25	3.542	2	-1.557820733
+10.792	5.208	3	0.3358234903
+16	5	4	-0.03306866929
+21	4.208	5	-0.2070276568
+25.208	9.375	6	0.04327900913
+34.583	0.792	7	-0.1644478802
+35.375	1.333	8	-0.06762669846
+36.708	3.167	9	0.1579466073
+39.875	3.292	10	0.2663627968
+43.167	3.5	11	-0.2664832696
+46.667	2.333	12	0.04315495832
+49	1.917	13	-0.04155285906
+50.917	4.125	14	0.04001208653
+55.042	2.917	15	-0.08485806694
+57.958	2.042	16	0.008346347475
+60	3.958	17	0.02230250862
+63.958	1.458	18	-0.06699408597
+65.417	1.083	19	0.04519596032
+66.5	1.917	20	0.07562682269
+68.417	2.208	21	-0.09718166316
+70.625	4.667	22	0.04645434208
+75.292	1.667	23	0.01865315886
+76.958	0.833	24	0.02023945652
+77.792	1.583	25	-0.01044289204
+79.375	2.292	26	0.07107341152
+81.667	4.5	27	-0.07068154365
+86.167	2.625	28	-0.09355068459
+88.792	2.542	29	0.127618289
+91.333	5.583	30	-0.03570772929
+96.917	4.458	31	0.1251853136
+101.375	3.042	32	-0.1428285775
+104.417	1.25	33	0.0998938008
+105.667	0.792	34	-0.007754262065
+106.458	1.5	35	-0.06120459462
+107.958	0.667	36	-0.02361673076
+108.625	2.208	37	0.01752653383
+110.833	3	38	0.07973702237
+113.833	2.292	39	-0.08752530512
+116.125	1	40	0.05044258775
+117.125	2.25	41	-0.0466125638
+119.375	2.708	42	0.09235464595
+122.083	3.375	43	-0.1067268907
+125.458	6.292	44	0.02212250449
+131.75	4.833	45	0.1053584879
+136.583	3.583	46	-0.06164775268
+140.167	1.708	47	0.001148701321
+141.875	4.292	48	-0.1751332264
+146.167	4.708	49	0.1760542644
+150.875	3.667	50	-0.06821788465
+154.542	2.958	51	0.01782704926
+157.5	3.125	52	-0.0693816018
+160.625	1.833	53	0.0899746917
+162.458	2.792	54	0.09733030527
+165.25	6.667	55	-0.2270603551
+171.917	31.292	56	0.1188704433
+203.208	n/a	video_stop	video_stop

stimuli_structure/stimuli/stim-the-present_annot-action_events.json

@@ -0,0 +1,18 @@
+{
+  "dog_action": {
+    "Description": "This describes the actions of the dog character in the movie",
+    "HED": "Label/dog_action, (Visual-presentation, (Agent-action, Animal-agent, (Action, Description/#)))"
+  },
+  "boy_action": {
+    "Description": "This describes the actions of the boy character in the movie",
+    "HED": "Label/boy_action, (Visual-presentation, (Agent-action, (Human-agent, Male), (Action, Description/#)))"
+  },
+  "mother_action": {
+    "Description": "This describes the actions of the mother character in the movie",
+    "HED": "Label/mother_action, (Visual-presentation, (Agent-action, (Human-agent, Female), (Action, Description/#)))"
+  },
+  "environment_action": {
+    "Description": "This describes the actions happening in the background environment in the movie",
+    "HED": "Label/environment_action, (Visual-presentation, Description/#)"
+  }
+}

stimuli_structure/stimuli/stim-the-present_annot-auditory_events.json

@@ -0,0 +1,28 @@
+{
+  "mother_voice": {
+    "Description": "This describes the utterances from the mother character in the movie",
+    "HED": "Label/mother_voice, (Sensory-event, (Auditory-presentation, (Human-agent, Female, Speak)))"
+  },
+  "boy_voice": {
+    "Description": "This describes the utterances from the boy character in the movie",
+    "HED": "Label/boy_voice, (Sensory-event, (Auditory-presentation, (Human-agent, Male, Speak))"
+  },
+  "dog_voice": {
+    "Description": "This describes the utterances from the dog character in the movie",
+    "HED": "Label/dog_voice, (Sensory-event, (Auditory-presentation, (Animal-agent, Barking)))"
+  },
+  "foley_sound": {
+    "HED": "Label/foley_sound, (Sensory-event, Auditory-presentation, (Named-object-sound, Label/#))"
+  },  
+  "background_music": {
+    "HED": "Label/background_music, (Sensory-event, Auditory-presentation, Label/#)"
+  },
+  "game_sound": {
+    "Description": "This describes the background sound generated from the video game played in the movie",
+    "HED": "Label/game_sound, (Sensory-event, Auditory-presentation, Description/#)"
+  },
+  "game_voice": {
+    "Description": "This describes the utterances of the video game played in the movie",
+    "HED": "Label/game_voice, Sensory-event, (Auditory-presentation, (Software-agent, Communicate-vocally/#))"
+  }
+}

stimuli_structure/stimuli/stim-the-present_annot-auditory_events.tsv

@@ -0,0 +1,79 @@
+onset	duration	mother_voice	boy_voice	dog_voice	foley_sound	background_music	game_sound	game_voice
+0	226.62							
+1.42	5.81					Intensifying battlefield audio with beginning credits	Intensifying battlefield audio with beginning credits	
+7.25	3.59					Intense battlefield audio	Intense battlefield audio	
+10.853	9.88					Low degree battlefield audio	Low degree battlefield audio	
+16	1				Video game voice hold your positions			Hold your positions
+20.733	23.04					Lower degree battlefield audio	Lower degree battlefield audio	
+20.78	0.68				Door swing			
+21.52	0.32				character1 mother sighs			
+22.198	0.682				Video game voice watch out			Watch out
+23.706	0.12				Door shuts			
+24.833	2.5							
+24.86	2.44	Hey Sweetie! Sorry I got home so late...						
+27.583	1.917							
+27.6	1.9	... but I had to pick something up after work.						
+28.04	0.253				Present box placed on the table			
+28.25	0.666							
+28.279	0.621		Mom					
+30.666	2.959							
+30.7	2.9	"It's such a beautiful day outside, you should let some sun inside."						
+35.44	1.16				Curtains raised			
+37.8	0.8				Telephone ringing			
+38.958	2.542							
+38.98	2.52	Why don't you stop playing and open the present I got for you?						
+39.75	0.8				Telephone ringing			
+41.77	0.8				Telephone ringing			
+43.125	0.625							
+43.15	0.6		For me?					
+43.773	0.36				Video game pauses			Video game pauses
+44.083	0.583							
+44.11	0.53	Hello?!?						
+44.958	0.417							
+44.99	0.37	Oh!						
+45.958	2.792							
+46	2.72	"Yes Sir, I don't know why you didn't get the papers"						
+48.72	0.506				character1 mother sighs			
+51.958	0.875							
+52	0.825		Okay.					
+54.973	0.72				Box pop opens			
+55.708	2.042							
+55.74	1.98		Woah! Cool!					
+58.97	0.67			Woof! Woof!				
+61.159	0.56				Character2 boy chuckles			
+62.106	0.134				Character3 dog chuckles			
+63.16	0.28				Character2 boy gasps			
+65.56	0.786				Character2 boy disgusted			
+67.186	0.654				character3 dog falls			
+67.97	1.23		She's gotta be kidding me!					
+68.666	1.6				Empty box thrown/rattles			
+71.026	0.36				Video game resumes			Video game resumes
+75.84	1.026			Woof! Woof! Woof!				
+77.453	1.853				"Character3 Dog falls, rolls and sighs"			
+77.76	0.74		GET LOST!?					
+80.16	0.36				"Character2 boy relieves frustration, arrogation and least care"			
+86.546	10.88					Guitar and piano music		
+93.48	0.77				Character3 dog collides			
+97.426	5.08					Battlefield audio with guitar and piano music	Battlefield audio�	
+102.507	3.073					lowest degreee battlefield audio	lowest degreee of volume based battlefield audio	
+104.88	0.32				Character2 boy sighs			
+105.34	0.18				Character2 boy kicks ball			
+105.62	14.3					Guitar and piano music with lowest degree battlefield audio	Lowest degree of volume based battlefield audio	
+106.8	0.18				Ball colliding sound			
+119.92	2.68					Transition guitar music		
+122.62	31.726					Guitar and piano music with xylophone		
+124.772	1.067				Character2 dog collides with the box			
+127.493	1.333				Box rattles			
+129.733	1.093			Woof! Woof! Woof!				
+154.346	1.88					Transition guitar music		
+157.6	2.64					transition guitar music		
+161.426	0.146				Character2 boy chuckles			
+162.62	1.98					transition guitar music		
+165.613	1.013				uncertain rattling sound			
+168.24	3.84				uncertain rattling sound with footsteps			
+174.56	0.18				Crutch on ground			
+174.725	20.673					Guitar music resumes		
+175.946	2.574			Woof! Woof! Woof!Woof! Woof! Woof!				
+184.6	2.18		MUM! WE'LL BE OUTSIDE!					
+191.039	2			Woof! WoofWoof! Woof!				
+195.399	7.752					vocal music start with guitar		

stimuli_structure/stimuli/stimuli.json

@@ -0,0 +1,20 @@
+{
+    "stim_id": {
+        "Description": "The stimulus ID included in the stimli directory"
+    },
+    "type": {
+        "Description": "The type of stimulus"
+    },
+    "nsd_id": {
+        "Description": "The Natural Scene ID of the stimulus"
+    },
+    "coco_id": {
+        "Description": "The COCO ID of the stimulus"
+    },
+    "first_coco_description": {
+        "Description": "The first COCO description of the stimulus"
+    },
+    "HED": {
+        "Description": "The HED description of the stimulus"
+    }
+}

stimuli_structure/stimuli/stimuli.tsv

@@ -0,0 +1,3 @@
+stim_id	type	NSD_id	COCO_id	first_COCO_description	HED
+nsd02951.png	still_image	2951	262145	"an open market full of people and piles of vegetables."	"((Item-count, High), Ingestible-object)), (Background-view, ((Human, Body, Agent-trait/Adult), Outdoors, Furnishing, Natural-feature/Sky, Urban, Man-made-object))"
+the_present_movie.txt	video	n/a	n/a	n/a	n/a

stimuli_structure/sub-sampleTimeVarying/eeg/sub-sampleTimeVarying_task-ThePresent_eeg.json

@@ -0,0 +1,13 @@
+{
+  "InstitutionName": "Child Mind Institute",
+  "InstitutionAddress": "101 E 56th St, New York, NY 10022",
+  "Manufacturer": "Magtism EGI",
+  "ManufacturersModelName": "128-channel GSN 200 v.2.1",
+  "PowerLineFrequency": 60,
+  "TaskName": "ThePresent",
+  "EEGReference": "Cz",
+  "RecordingType": "continuous",
+  "RecordingDuration": 205.624,
+  "SamplingFrequency": 500,
+  "SoftwareFilters": "n/a"
+}

stimuli_structure/sub-sampleTimeVarying/eeg/sub-sampleTimeVarying_task-ThePresent_events.tsv

@@ -0,0 +1,4 @@
+onset	duration	sample	value	event_code	stim_id
+0	0.002	0	9999	9999	n/a
+2.034	0.002	1017	video_start	84	stim-the-present_stimulus.txt
+205.098	0.002	102549	video_stop	104	s