PsychoPy - Revision history

Swiftj: /* Using Use Expression Option */

2025-05-13T00:29:02Z

Using Use Expression Option

← Older revision		Revision as of 00:29, 13 May 2025
Line 120:		Line 120:
	<br/>		<br/>
	<li>		<li>
	Start BCI2000 - Navigate to the '''instruct''' tab and click on '''BCI2000Start'''. Enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in the ''Path'' field and <code>responseTime 0 600</code><br/> in the ''~~States~~'' field as shown in the image. '''responseTime''' is the name we want the new ~~state~~ to have in BCI2000, '''0''' is the default value the ~~state~~ should have and '''600''' is the maximum value the ~~state~~ can take in any case, i.e, the maximum response time could be 10 minutes.<br/>		Start BCI2000 - Navigate to the '''instruct''' tab and click on '''BCI2000Start'''. Enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in the ''Path'' field and <code>responseTime 0 600</code><br/> in the ''Events'' field as shown in the image. '''responseTime''' is the name we want the new event to have in BCI2000, '''0''' is the default value the event should have and '''600''' is the maximum value the event can take in any case, i.e, the maximum response time could be 10 minutes.<br/>

	<gallery mode="packed" widths=400px heights=400px>		<gallery mode="packed" widths=400px heights=400px>
	File:PsychoPyBciStart2.png\|alt="PsychoPy- Add ~~State~~ into BCI2000"\|PsychoPy - Add ~~State~~ into BCI2000		File:PsychoPyBciStart2.png\|alt="PsychoPy- Add Event into BCI2000"\|PsychoPy - Add Event into BCI2000
	</gallery>		</gallery>

Line 129:		Line 129:
	<br/>		<br/>
	<li>		<li>
	Update BCI2000 ~~State~~ - Navigate to the '''trial''' tab and click on '''~~BCI2000UpdateState~~'''. Check on the '''Use Expression''' option to run the expression that is written in the '''Expression''' field. Write the lines of python code in the '''Expression''' field as shown in the image. These lines first set the 'RUNNING' state of BCI2000 to 1 to make sure that BCI2000 is running. It then checks if the type of the 'resp.rt' is float. If yes, that means 'resp.rt' stores the response time and sets the ~~state~~ 'responseTime' to the rounded value of 'resp.rt' ('resp' is the name of the keyboard which takes the input and 'rt' is its property that stores the time it took user to press the key; you can see this variable being used in the program when you compile it to script) using the bci.Execute and SET ~~STATE~~ commands. <br/>		Update BCI2000 Event - Navigate to the '''trial''' tab and click on '''BCI2000UpdateEvent'''. Check on the '''Use Expression''' option to run the expression that is written in the '''Expression''' field. Write the lines of python code in the '''Expression''' field as shown in the image. These lines first set the 'RUNNING' state of BCI2000 to 1 to make sure that BCI2000 is running. It then checks if the type of the 'resp.rt' is float. If yes, that means 'resp.rt' stores the response time and sets the event 'responseTime' to the rounded value of 'resp.rt' ('resp' is the name of the keyboard which takes the input and 'rt' is its property that stores the time it took user to press the key; you can see this variable being used in the program when you compile it to script) using the bci.Execute and SET EVENT commands. <br/>
	<code>bci.Execute('SET STATE RUNNING 1') <br/>		<code>bci.Execute('SET STATE RUNNING 1') <br/>
	if(type(resp.rt) == float): <br/>		if(type(resp.rt) == float): <br/>
	bci.Execute('SET ~~STATE~~ responseTime %d' % round(resp.rt))		bci.Execute('SET EVENT responseTime %d' % round(resp.rt))
	</code><br/>		</code><br/>

	<gallery mode="packed" widths=400px heights=400px>		<gallery mode="packed" widths=400px heights=400px>
	File:PsychoPyBciUpdateState2.png\|alt="PsychoPy - Update ~~State~~ in BCI2000"\|PsychoPy - Update ~~State~~ in BCI2000		File:PsychoPyBciUpdateState2.png\|alt="PsychoPy - Update Event in BCI2000"\|PsychoPy - Update Event in BCI2000
	</gallery>		</gallery>

Line 142:		Line 142:
	<br/>		<br/>
	<li>		<li>
	Run the experiment. BCI2000 will start. Add the newly created ~~state~~ to watch (in the BCI2000 operator, click on View -> States and Events.., right click on responseTime and add to watch. Click Ok on the States and Events screen) and proceed with your PsychoPy experiment. The output of this experiment would be similar to the image shown below. '''Note:''' Make sure you don't run the experiments in full screen mode if you are using a single screen. <br/>		Run the experiment. BCI2000 will start. Add the newly created event to watch (in the BCI2000 operator, click on View -> States and Events.., right click on responseTime and add to watch. Click Ok on the States and Events screen) and proceed with your PsychoPy experiment. The output of this experiment would be similar to the image shown below. '''Note:''' Make sure you don't run the experiments in full screen mode if you are using a single screen. <br/>

	<gallery mode="packed" widths=400px heights=400px>		<gallery mode="packed" widths=400px heights=400px>

Swiftj: /* Using Response Component Variable Option */

2025-05-12T22:24:35Z

Using Response Component Variable Option

← Older revision		Revision as of 22:24, 12 May 2025
Line 100:		Line 100:

	<gallery mode="packed" widths=400px heights=400px>		<gallery mode="packed" widths=400px heights=400px>
	File:~~PsychoPyBciDemoRun1~~.png\|alt="PsychoPy Stroop Extended Demo Run 1"\|PsychoPy Stroop Extended Demo Run 1		File:Psychopy10.png\|alt="PsychoPy Stroop Extended Demo Run 1"\|PsychoPy Stroop Extended Demo Run 1
	</gallery>		</gallery>

Swiftj: /* Using Response Component Variable Option */

2025-05-12T22:17:39Z

Using Response Component Variable Option

← Older revision		Revision as of 22:17, 12 May 2025
Line 66:		Line 66:

	=== Using Response Component Variable Option ===		=== Using Response Component Variable Option ===
	In this tutorial, we will add a new ~~state~~ called '''correctKey''' in BCI2000 using PsychoPy. This ~~state~~ will be changed to 1 if the key pressed by user is correct, otherwise 0.		In this tutorial, we will add a new event called '''correctKey''' in BCI2000 using PsychoPy. This event will be changed to 1 if the key pressed by user is correct, otherwise 0.
	<ol>		<ol>
	<li>		<li>
Line 79:		Line 79:
	<br/>		<br/>
	<li>		<li>
	Start BCI2000 - Navigate to the '''instruct''' tab and click on '''BCI2000Start'''. Enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in the ''Path'' field and <code>correctKey 0 1</code> <br/> in the ''~~States~~'' field as shown in the image. '''correctKey''' is the name we want the new ~~state~~ to have in BCI2000, '''0''' is the default value the ~~state~~ should have and '''1''' is the maximum value the ~~state~~ can take in any case. <br/>		Start BCI2000 - Navigate to the '''instruct''' tab and click on '''BCI2000Start'''. Enter the path to the '''prog''' directory of BCI2000 (within which BCI2000Remote.py exists) in the ''Path'' field and <code>correctKey 0 1</code> <br/> in the ''Events'' field as shown in the image. '''correctKey''' is the name we want the new event to have in BCI2000, '''0''' is the default value the event should have and '''1''' is the maximum value the event can take in any case. <br/>

	<gallery mode="packed" widths=400px heights=400px>		<gallery mode="packed" widths=400px heights=400px>
	File:PsychoPyBciStart1.png\|alt="PsychoPy - Add ~~State~~ into BCI2000"\|PsychoPy - Add ~~State~~ into BCI2000		File:PsychoPyBciStart1.png\|alt="PsychoPy - Add Event into BCI2000"\|PsychoPy - Add Event into BCI2000
	</gallery>		</gallery>

Line 88:		Line 88:
	<br/>		<br/>
	<li>		<li>
	Update BCI2000 ~~State~~ - Navigate to the '''trial''' tab and click on '''~~BCI2000UpdateState~~'''. Fill in the fields ''~~State~~ Name'' with '''$correctKey''' (the BCI2000 ~~state~~ we want to update; '$' is used to indicate to PsychoPy to treat it as a variable) and ''Response Component Variable'' with '''$resp.corr''' ('resp' is the name of the keyboard that takes the input and 'corr' is its property that stores whether the key pressed is correct or not. you can see this variable being used in the program when you compile it to script) as shown in the image. This will essentially update the ~~state~~ 'correctKey' with the value of 'resp.corr'. <br/>		Update BCI2000 Event - Navigate to the '''trial''' tab and click on '''BCI2000UpdateEvent'''. Fill in the fields ''Event Name'' with '''$correctKey''' (the BCI2000 event we want to update; '$' is used to indicate to PsychoPy to treat it as a variable) and ''Response Component Variable'' with '''$resp.corr''' ('resp' is the name of the keyboard that takes the input and 'corr' is its property that stores whether the key pressed is correct or not. you can see this variable being used in the program when you compile it to script) as shown in the image. This will essentially update the event 'correctKey' with the value of 'resp.corr'. <br/>

	<gallery mode="packed" widths=400px heights=400px>		<gallery mode="packed" widths=400px heights=400px>
	File:~~PsychoPyBciUpdateState1~~.png\|alt="PsychoPy - Update ~~State~~ in BCI2000"\|PsychoPy - Update ~~State~~ in BCI2000		File:PsychoPyBciUpdateEvent1.png\|alt="PsychoPy - Update Event in BCI2000"\|PsychoPy - Update Event in BCI2000
	</gallery>		</gallery>

Line 97:		Line 97:
	<br/>		<br/>
	<li>		<li>
	Run the experiment. BCI2000 will start. Add the newly created ~~state~~ to watch (in the BCI2000 operator, click on View -> States and Events.., right click on correctKey and add to watch, then click Ok on States and Events screen) and proceed as with your PsychoPy experiment. The output of this experiment would be similar to the image shown below. '''Note:''' Make sure you don't run the experiments in full screen mode if you are using a single screen. <br/>		Run the experiment. BCI2000 will start. Add the newly created event to watch (in the BCI2000 operator, click on View -> States and Events.., right click on correctKey and add to watch, then click Ok on States and Events screen) and proceed as with your PsychoPy experiment. The output of this experiment would be similar to the image shown below. '''Note:''' Make sure you don't run the experiments in full screen mode if you are using a single screen. <br/>

	<gallery mode="packed" widths=400px heights=400px>		<gallery mode="packed" widths=400px heights=400px>

Swiftj: /* Integrating BCI2000 into PyschoPy */

2025-05-12T22:12:20Z

Integrating BCI2000 into PyschoPy

← Older revision		Revision as of 22:12, 12 May 2025
Line 56:		Line 56:
	Start PsychoPy application by running "python \psychopy\app\psychopyApp.py" from wherever you cloned your PsychoPy repository. If you downloaded the standalone version installer, you can simply press the Windows key and search for PsychoPy. Once you're under the '''Custom''' Components (in the rightmost column), you should see the three new components - ''BCI2000Start'', ''BCIUpdateEvent'', and ''BCI2000UpdateState'' as shown in the figure below.		Start PsychoPy application by running "python \psychopy\app\psychopyApp.py" from wherever you cloned your PsychoPy repository. If you downloaded the standalone version installer, you can simply press the Windows key and search for PsychoPy. Once you're under the '''Custom''' Components (in the rightmost column), you should see the three new components - ''BCI2000Start'', ''BCIUpdateEvent'', and ''BCI2000UpdateState'' as shown in the figure below.

	<gallery mode="packed" widths=~~400px~~ heights=~~400px~~>		<gallery mode="packed" widths=550px heights=550px>
	File:PsychoPy_Start.png\|alt="PsychoPy Homepage with BCI2000 Components"\|PsychoPy Homepage with BCI2000 Components		File:PsychoPy_Start.png\|alt="PsychoPy Homepage with BCI2000 Components"\|PsychoPy Homepage with BCI2000 Components
	</gallery>		</gallery>

Swiftj: /* Developer version */

2025-05-12T22:06:20Z

Developer version

← Older revision		Revision as of 22:06, 12 May 2025
Line 54:		Line 54:
	<code>pip install -e .</code> <br/><br/>		<code>pip install -e .</code> <br/><br/>
	<br/><br/>		<br/><br/>
	Start PsychoPy application by running "python \psychopy\app\psychopyApp.py" from wherever you cloned your PsychoPy repository. If you downloaded the standalone version installer, you can simply press the Windows key and search for PsychoPy. Once you're under the '''Custom''' Components (in the rightmost column), you should see the ~~two~~ new components - ''BCI2000Start'', ''BCIUpdateEvent'', and ''BCI2000UpdateState'' as shown in the figure below.		Start PsychoPy application by running "python \psychopy\app\psychopyApp.py" from wherever you cloned your PsychoPy repository. If you downloaded the standalone version installer, you can simply press the Windows key and search for PsychoPy. Once you're under the '''Custom''' Components (in the rightmost column), you should see the three new components - ''BCI2000Start'', ''BCIUpdateEvent'', and ''BCI2000UpdateState'' as shown in the figure below.

	<gallery mode="packed" widths=400px heights=400px>		<gallery mode="packed" widths=400px heights=400px>

Swiftj: /* BCI2000Start */

2025-05-12T21:59:51Z

BCI2000Start

← Older revision		Revision as of 21:59, 12 May 2025
Line 13:		Line 13:
	'''NOTE:''' You can specify the modules with which you want to run the experiment with the ''BCI.StartupModules'' command in the Init.py file previously copied into your PsychoPy environment. You can also specify which parameters to use for the experiment and specify other command-line arguments with the ''BCI.LoadParameterRemote'' command.		'''NOTE:''' You can specify the modules with which you want to run the experiment with the ''BCI.StartupModules'' command in the Init.py file previously copied into your PsychoPy environment. You can also specify which parameters to use for the experiment and specify other command-line arguments with the ''BCI.LoadParameterRemote'' command.

	[[File:BCI2000Start.png\|alt="BCI2000 start component image showing its parameters"\|BCIStart Component]]		[[File:BCI2000Start.png\|500px\|alt="BCI2000 start component image showing its parameters"\|BCIStart Component]]

	=== BCI2000UpdateEvent ===		=== BCI2000UpdateEvent ===

Swiftj: /* Integrating BCI2000 into PyschoPy */

2025-05-12T21:56:15Z

Integrating BCI2000 into PyschoPy

← Older revision		Revision as of 21:56, 12 May 2025
Line 45:		Line 45:

	=== Standalone version ===		=== Standalone version ===
	For Windows, Copy the folders '''BCIStart''' and '''BCIUpdateState''' from the ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\Lib\site-packages\psychopy\experiment\components folder.		For Windows, Copy the folders '''BCIStart''', '''BCIUpdateEvent''', and '''BCIUpdateState''' from the ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\Lib\site-packages\psychopy\experiment\components folder.


	=== Developer version ===		=== Developer version ===
	Copy the folders '''BCIStart''' and '''BCIUpdateState''' from the ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\psychopy\experiment\components.		Copy the folders '''BCIStart''', '''BCIUpdateEvent''', and '''BCIUpdateState''' from the ''src/contrib/PsychoPy Components'' directory of your BCI2000 repository into the folder {$PsychoPyHome}\psychopy\experiment\components.
	Open the terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.		Open the terminal and navigate to the PsychoPy home directory where ''setup.py'' resides.
	Run the following command in the terminal: <br/>		Run the following command in the terminal: <br/>
	<code>pip install -e .</code> <br/><br/>		<code>pip install -e .</code> <br/><br/>
	<br/><br/>		<br/><br/>
	Start PsychoPy application by running "python \psychopy\app\psychopyApp.py" from wherever you cloned your PsychoPy repository. If you downloaded the standalone version installer, you can simply press the Windows key and search for PsychoPy. Once you're under the '''Custom''' Components (in the rightmost column), you should see the two new components - ''BCI2000Start'' and ''BCI2000UpdateState'' as shown in the figure below.		Start PsychoPy application by running "python \psychopy\app\psychopyApp.py" from wherever you cloned your PsychoPy repository. If you downloaded the standalone version installer, you can simply press the Windows key and search for PsychoPy. Once you're under the '''Custom''' Components (in the rightmost column), you should see the two new components - ''BCI2000Start'', ''BCIUpdateEvent'', and ''BCI2000UpdateState'' as shown in the figure below.

	<gallery mode="packed" widths=400px heights=400px>		<gallery mode="packed" widths=400px heights=400px>

Swiftj: /* BCI2000UpdateEvent */

2025-05-12T16:41:58Z

BCI2000UpdateEvent

← Older revision		Revision as of 16:41, 12 May 2025
Line 20:		Line 20:
	This component defines which event to update and when. It takes the following parameters:		This component defines which event to update and when. It takes the following parameters:
	; Event Name : The name of the event in BCI2000 to update.		; Event Name : The name of the event in BCI2000 to update.
	; Response Component Variable : The variable to which the ~~state~~ is to be set OR the variable which contains the new value of the event. '''Note-''' the variable is written as ''$VariableName''.		; Response Component Variable : The variable to which the event is to be set OR the variable which contains the new value of the event. '''Note-''' the variable is written as ''$VariableName''.
	; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified in the Response Component Variable is not used to update the event.		; Use Expression : If it is checked, the code written in 'Expression' is executed for each Frame and the variable specified in the Response Component Variable is not used to update the event.
	; Expression : The code to execute for each Frame. It is given for the cases where the Response Component Variable is not available and the user wants more control over how the event is updated. '''Note-''' the user would have to use commands such as ''bci.Execute'' and ''SET EVENT'' to update the ~~state~~ in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.		; Expression : The code to execute for each Frame. It is given for the cases where the Response Component Variable is not available and the user wants more control over how the event is updated. '''Note-''' the user would have to use commands such as ''bci.Execute'' and ''SET EVENT'' to update the event in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.

	[[File:BCIUpdateEvent.PNG\|500px\|alt="BCI2000 update event component image showing its parameters"\|BCIUpdateEvent Component]]		[[File:BCIUpdateEvent.PNG\|500px\|alt="BCI2000 update event component image showing its parameters"\|BCIUpdateEvent Component]]

Swiftj: /* BCI2000UpdateEvent */

2025-05-12T16:40:28Z

BCI2000UpdateEvent

← Older revision		Revision as of 16:40, 12 May 2025
Line 24:		Line 24:
	; Expression : The code to execute for each Frame. It is given for the cases where the Response Component Variable is not available and the user wants more control over how the event is updated. '''Note-''' the user would have to use commands such as ''bci.Execute'' and ''SET EVENT'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.		; Expression : The code to execute for each Frame. It is given for the cases where the Response Component Variable is not available and the user wants more control over how the event is updated. '''Note-''' the user would have to use commands such as ''bci.Execute'' and ''SET EVENT'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.

	[[File:BCIUpdateEvent.PNG\|alt="BCI2000 update event component image showing its parameters"\|BCIUpdateEvent Component]]		[[File:BCIUpdateEvent.PNG\|500px\|alt="BCI2000 update event component image showing its parameters"\|BCIUpdateEvent Component]]

	=== BCI2000UpdateState ===		=== BCI2000UpdateState ===

Swiftj: /* BCI2000UpdateEvent */

2025-05-12T16:22:42Z

BCI2000UpdateEvent

← Older revision		Revision as of 16:22, 12 May 2025
Line 24:		Line 24:
	; Expression : The code to execute for each Frame. It is given for the cases where the Response Component Variable is not available and the user wants more control over how the event is updated. '''Note-''' the user would have to use commands such as ''bci.Execute'' and ''SET EVENT'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.		; Expression : The code to execute for each Frame. It is given for the cases where the Response Component Variable is not available and the user wants more control over how the event is updated. '''Note-''' the user would have to use commands such as ''bci.Execute'' and ''SET EVENT'' to update the state in such cases. See [[Programming Reference:BCI2000Remote Class]] and [[User Reference:Operator Module Scripting]] for more details.

	[[File:BCIUpdateEvent.~~png~~\|alt="BCI2000 update event component image showing its parameters"\|BCIUpdateEvent Component]]		[[File:BCIUpdateEvent.PNG\|alt="BCI2000 update event component image showing its parameters"\|BCIUpdateEvent Component]]

	=== BCI2000UpdateState ===		=== BCI2000UpdateState ===