User Reference:NeuroStimulationParamsGUI - Revision history

Wengelhardt: redirect page

2023-10-02T22:27:00Z

redirect page

← Older revision		Revision as of 22:27, 2 October 2023
Line 1:		Line 1:
	[[~~Image:CerestimGUIimg1.png\|500px\|right\|thumb\|frame\|An example configuration for the CereStim. ]]~~		#REDIRECT [[User Reference:StimulationConfigurationIntegrativeTool (SCIT)]]

	~~==Functional Description==~~
	This Matlab tool helps create parameter files for the Blackrock CereStim and the Neuro Omega from Alpha Omega. It also can load parameter files and visualize the configurations. If this tool is desired for another stimulation device, please contact engelhardt@neurotechcenter.org and it can be implemented.
	~~==Versioning==~~
	~~===Authors===~~
	* William Engelhardt (engelhardt@neurotechcenter.org)

	~~===Version History===~~
	* 2022/05/10: Initial working release R6736.
	* 2022/06/08: Can load existing parameter files and visualize multiple graphs.

	~~===Source Code Revisions===~~
	*Initial development: ~~6736~~
	*Known to compile under: 6785
	*Broken since: --

	~~==Installation==~~
	Assuming you have already installed BCI2000, navigate to "tools", then "NeuroStimulationParamsGUI". This folder will contain the installation file for the Matlab application. Double-clicking this will automatically open Matlab, and install the app in your apps. You can find it under the header "APPS". Open this app, and you are set.

	~~==General Overview==~~
	~~===Loading parameter files===~~
	~~Go to the header bar, click on <code>Files</code>, then <code>Load Parameter File</code>. This will load the parameters into the tables on the right, allowing you to visualize them.~~
	~~===Creating your own parameter files===~~
	The left panel is where you define the parameters for your desired stimulation. The bottom button, <code>Export to parameter file</code>, lets you export the tables on the Right Panel to a valid BCI2000 parameter file. To update the tables on the right, click <code>Save Configuration to Tables</code>.
	~~===Visualizing configurations===~~
	The middle panel contains three graphs, each with a different time scale. The top left, labeled ''Single Pulse'', shows one single pulse. The top right graph shows the full time range of the stimulation pulses. The bottom shows the full stimulation train, which is mainly defined by the parameters <code>Train Duration</code> and <code>Train Frequency</code>. Each "pulse", where the height is 1, is the duration of the stimulation, which is shown in the top right figure. You can think of it as increasing the time scale as you go clockwise from the ''Single Pulse'' graph.

	These graphs are updated automatically as you change the values in either the Left Panel or the tables. To choose which to visualize, this can be specified in the checklist on the bottom labeled ''Visualize Configurations''. The name "Test Values" correspond to the values in the Left Panel. The legends for the ''Full stimulation'' and the ''Complete stimulation train'' specify the number of pulses visualized in the graph.
	~~===Viewing your parameters===~~
	The right panel is where you can look at the parameters as they would be in BCI2000. They are split up into two tables: Configurations and Triggers. The Configuration table specifies what you are seeing in the figures. The Triggers table correlates to when each configuration is triggered, and to which electrode(s) ~~the configuration goes to.~~

	~~===Preferences===~~
	*''Auto-increment Trigger Expression'': If checked, when you add a trigger to the table it auto-increments the number of the expression. This is helpful for quickly adding new columns. If you want the trigger expression to stay constant, uncheck this option.
	*''Auto-visualize new config'': When you add a new configuration, it will automatically be checked in the "Visualize Configurations" and will be visualized. If not desired, uncheck and new configurations will not be automatically visualized. You can still visualize them by manually checking it in the "Visualize Configurations" list.


	~~==CereStim==~~
	~~<gallery mode="packed" widths=350px heights=350px>~~
	~~File:CerestimGUIimg.png\|Figure 1: An example configuration for the CereStim.~~
	~~</gallery>~~
	~~Refer to the [[Contributions:CereStim\|CereStim Wiki page]] to see the description and limits on each parameter.~~

	~~==NeuroOmega==~~
	~~<gallery mode="packed" widths=350px heights=350px>~~
	~~File:NeuroOmegaGUIimg1.png\|Figure 2: An example configuration for the NeuroOmega.~~
	~~</gallery>~~
	~~Refer to the [[Contributions:NeuroOmegaADC\|Neuro Omega Wiki page]] to see the description and limits on each parameter.~~
	* The "Recording Channels" section changes the channels listed in the "Channel" dropdown. If you want to use a channel that is not in any of the options, you can manually change it in the table.

	~~==gEstim==~~
	~~<gallery mode="packed" widths=350px heights=350px>~~
	~~File:gEstimGUIimg.png\|Figure 3: An example configuration for the gEstim.~~
	~~</gallery>~~
	~~Refer to the [[Contributions:gEstimFilter\|gEstim Wiki page]] to see the description and limits on each parameter.~~

	~~==See also==~~
	~~[[Contributions:NeuroOmegaADC]], [[Contributions:CereStim]], [[Contributions:gEstimFilter]]~~

	~~[[Category:User Interface~~]]

Wengelhardt: Added gEstim

2023-03-30T00:32:06Z

Added gEstim

← Older revision		Revision as of 00:32, 30 March 2023
Line 48:		Line 48:
	Refer to the [[Contributions:NeuroOmegaADC\|Neuro Omega Wiki page]] to see the description and limits on each parameter.		Refer to the [[Contributions:NeuroOmegaADC\|Neuro Omega Wiki page]] to see the description and limits on each parameter.
	* The "Recording Channels" section changes the channels listed in the "Channel" dropdown. If you want to use a channel that is not in any of the options, you can manually change it in the table.		* The "Recording Channels" section changes the channels listed in the "Channel" dropdown. If you want to use a channel that is not in any of the options, you can manually change it in the table.

			==gEstim==
			<gallery mode="packed" widths=350px heights=350px>
			File:gEstimGUIimg.png\|Figure 3: An example configuration for the gEstim.
			</gallery>
			Refer to the [[Contributions:gEstimFilter\|gEstim Wiki page]] to see the description and limits on each parameter.

	==See also==		==See also==
	[[Contributions:NeuroOmegaADC]], [[Contributions:CereStim]]		[[Contributions:NeuroOmegaADC]], [[Contributions:CereStim]], [[Contributions:gEstimFilter]]

	[[Category:User Interface]]		[[Category:User Interface]]

Wengelhardt at 23:04, 16 June 2022

2022-06-16T23:04:08Z

← Older revision		Revision as of 23:04, 16 June 2022
Line 2:		Line 2:

	==Functional Description==		==Functional Description==
	This Matlab tool helps create parameter files for the Blackrock CereStim and the Neuro Omega from Alpha Omega. If this tool is desired for another stimulation device, please contact engelhardt@neurotechcenter.org and it can be implemented.		This Matlab tool helps create parameter files for the Blackrock CereStim and the Neuro Omega from Alpha Omega. It also can load parameter files and visualize the configurations. If this tool is desired for another stimulation device, please contact engelhardt@neurotechcenter.org and it can be implemented.
	==Versioning==		==Versioning==
	===Authors===		===Authors===
Line 9:		Line 9:
	===Version History===		===Version History===
	* 2022/05/10: Initial working release R6736.		* 2022/05/10: Initial working release R6736.
			* 2022/06/08: Can load existing parameter files and visualize multiple graphs.

	===Source Code Revisions===		===Source Code Revisions===
	*Initial development: 6736		*Initial development: 6736
	*Known to compile under: ~~6736~~		*Known to compile under: 6785
	*Broken since: --		*Broken since: --
	~~===Known Issues/Important Things to Know===~~
	*On some versions of Matlab the table column and row names may not show up. If this happens, please change your version of Matlab.

	==Installation==		==Installation==
Line 21:		Line 20:

	==General Overview==		==General Overview==
	~~There are three main sections~~ to the ~~app:~~		===Loading parameter files===
	===~~Left panel~~===		Go to the header bar, click on <code>Files</code>, then <code>Load Parameter File</code>. This will load the parameters into the tables on the right, allowing you to visualize them.
	~~This~~ is where you define the parameters for your desired stimulation. The bottom button, "Export to parameter file", lets you export the tables on the Right Panel to a valid BCI2000 parameter file.		===Creating your own parameter files===
	===~~Middle panel~~===		The left panel is where you define the parameters for your desired stimulation. The bottom button, <code>Export to parameter file</code>, lets you export the tables on the Right Panel to a valid BCI2000 parameter file. To update the tables on the right, click <code>Save Configuration to Tables</code>.
	~~Here~~ three graphs ~~are visualized~~, each with a different time scale. The top left, labeled "Single Pulse", shows one single pulse. The top right graph shows the full time range of the stimulation pulses. The bottom shows the full stimulation train, which is mainly defined by the parameters "Train Duration" and "Train Frequency". Each "pulse", where the ~~value~~ is 1, is the duration of the stimulation, which is shown in the top right figure. You can think of it as increasing the time scale as you go clockwise from the "Single Pulse" graph.		===Visualizing configurations===
	===~~Right panel~~===		The middle panel contains three graphs, each with a different time scale. The top left, labeled ''Single Pulse'', shows one single pulse. The top right graph shows the full time range of the stimulation pulses. The bottom shows the full stimulation train, which is mainly defined by the parameters <code>Train Duration</code> and <code>Train Frequency</code>. Each "pulse", where the height is 1, is the duration of the stimulation, which is shown in the top right figure. You can think of it as increasing the time scale as you go clockwise from the ''Single Pulse'' graph.
	~~Here~~ is where you can look at the parameters as they would be in BCI2000. They are split up into two tables: Configurations and Triggers. The Configuration table specifies what you are seeing in the figures. The Triggers table correlates to when each configuration is triggered, and to which electrode(s) the configuration goes to.
			These graphs are updated automatically as you change the values in either the Left Panel or the tables. To choose which to visualize, this can be specified in the checklist on the bottom labeled ''Visualize Configurations''. The name "Test Values" correspond to the values in the Left Panel. The legends for the ''Full stimulation'' and the ''Complete stimulation train'' specify the number of pulses visualized in the graph.
			===Viewing your parameters===
			The right panel is where you can look at the parameters as they would be in BCI2000. They are split up into two tables: Configurations and Triggers. The Configuration table specifies what you are seeing in the figures. The Triggers table correlates to when each configuration is triggered, and to which electrode(s) the configuration goes to.

			===Preferences===
			*''Auto-increment Trigger Expression'': If checked, when you add a trigger to the table it auto-increments the number of the expression. This is helpful for quickly adding new columns. If you want the trigger expression to stay constant, uncheck this option.
			*''Auto-visualize new config'': When you add a new configuration, it will automatically be checked in the "Visualize Configurations" and will be visualized. If not desired, uncheck and new configurations will not be automatically visualized. You can still visualize them by manually checking it in the "Visualize Configurations" list.

	~~===Important Notes===~~
	* The expression that is automatically added is "StimulusCode==", and the number increases from 1. This seems to be the most common trigger in experiments, but if you desire something else, you can manually change it in the table on the right. It still must be a [[User_Reference:Expression_Syntax\|valid BCI2000 expression]].
	* When electrodes with the same configuration are added, they are added under the same Trigger column. If you want to stimulate electrodes separately with the same configuration, just change one number of the configuration, generate a new configuration, then change that number back to match the original configuration.

	==CereStim==		==CereStim==

Wengelhardt: /* NeuroOmega */

2022-06-16T18:50:09Z

NeuroOmega

← Older revision		Revision as of 18:50, 16 June 2022
Line 41:		Line 41:
	==NeuroOmega==		==NeuroOmega==
	<gallery mode="packed" widths=350px heights=350px>		<gallery mode="packed" widths=350px heights=350px>
	File:~~NeuroOmegaGUIimg~~.png\|Figure 2: An example configuration for the NeuroOmega.		File:NeuroOmegaGUIimg1.png\|Figure 2: An example configuration for the NeuroOmega.
	</gallery>		</gallery>
	Refer to the [[Contributions:NeuroOmegaADC\|Neuro Omega Wiki page]] to see the description and limits on each parameter.		Refer to the [[Contributions:NeuroOmegaADC\|Neuro Omega Wiki page]] to see the description and limits on each parameter.
	* The "Recording Channels" section changes the channels listed in the "Channel" dropdown. If you want to use a channel that is not in any of the options, you can manually change it in the table.		* The "Recording Channels" section changes the channels listed in the "Channel" dropdown. If you want to use a channel that is not in any of the options, you can manually change it in the table.


	==See also==		==See also==

Wengelhardt at 16:38, 16 June 2022

2022-06-16T16:38:39Z

← Older revision		Revision as of 16:38, 16 June 2022
Line 1:		Line 1:
	[[Image:~~CerestimGUIimg~~.png\|500px\|right\|thumb\|frame\|An example configuration for the CereStim. ]]		[[Image:CerestimGUIimg1.png\|500px\|right\|thumb\|frame\|An example configuration for the CereStim. ]]

	==Functional Description==		==Functional Description==

Swiftj: /* Important Notes */

2022-05-19T16:11:18Z

Important Notes

← Older revision		Revision as of 16:11, 19 May 2022
Line 31:		Line 31:
	===Important Notes===		===Important Notes===
	* The expression that is automatically added is "StimulusCode==", and the number increases from 1. This seems to be the most common trigger in experiments, but if you desire something else, you can manually change it in the table on the right. It still must be a [[User_Reference:Expression_Syntax\|valid BCI2000 expression]].		* The expression that is automatically added is "StimulusCode==", and the number increases from 1. This seems to be the most common trigger in experiments, but if you desire something else, you can manually change it in the table on the right. It still must be a [[User_Reference:Expression_Syntax\|valid BCI2000 expression]].
	* When ~~channels~~ with the same configuration are added, they are added under the same Trigger column. If you want to stimulate ~~channels~~ separately with the same configuration, just change one number of the configuration, generate a new configuration, then change that number back to match the original configuration		* When electrodes with the same configuration are added, they are added under the same Trigger column. If you want to stimulate electrodes separately with the same configuration, just change one number of the configuration, generate a new configuration, then change that number back to match the original configuration.

	==CereStim==		==CereStim==
	<gallery mode="packed" widths=350px heights=350px>		<gallery mode="packed" widths=350px heights=350px>

Swiftj: /* Right panel */

2022-05-19T16:10:39Z

Right panel

← Older revision		Revision as of 16:10, 19 May 2022
Line 27:		Line 27:
	Here three graphs are visualized, each with a different time scale. The top left, labeled "Single Pulse", shows one single pulse. The top right graph shows the full time range of the stimulation pulses. The bottom shows the full stimulation train, which is mainly defined by the parameters "Train Duration" and "Train Frequency". Each "pulse", where the value is 1, is the duration of the stimulation, which is shown in the top right figure. You can think of it as increasing the time scale as you go clockwise from the "Single Pulse" graph.		Here three graphs are visualized, each with a different time scale. The top left, labeled "Single Pulse", shows one single pulse. The top right graph shows the full time range of the stimulation pulses. The bottom shows the full stimulation train, which is mainly defined by the parameters "Train Duration" and "Train Frequency". Each "pulse", where the value is 1, is the duration of the stimulation, which is shown in the top right figure. You can think of it as increasing the time scale as you go clockwise from the "Single Pulse" graph.
	===Right panel===		===Right panel===
	Here is where you can look at the parameters as they would be in BCI2000. They are split up into two tables: Configurations and Triggers. The Configuration table specifies what you are seeing in the figures. The Triggers table correlates to when each configuration is triggered, and to which ~~channel~~ the configuration goes to.		Here is where you can look at the parameters as they would be in BCI2000. They are split up into two tables: Configurations and Triggers. The Configuration table specifies what you are seeing in the figures. The Triggers table correlates to when each configuration is triggered, and to which electrode(s) the configuration goes to.

	===Important Notes===		===Important Notes===
	* The expression that is automatically added is "StimulusCode==", and the number increases from 1. This seems to be the most common trigger in experiments, but if you desire something else, you can manually change it in the table on the right. It still must be a [[User_Reference:Expression_Syntax\|valid BCI2000 expression]].		* The expression that is automatically added is "StimulusCode==", and the number increases from 1. This seems to be the most common trigger in experiments, but if you desire something else, you can manually change it in the table on the right. It still must be a [[User_Reference:Expression_Syntax\|valid BCI2000 expression]].

Wengelhardt at 15:30, 17 May 2022

2022-05-17T15:30:25Z

← Older revision		Revision as of 15:30, 17 May 2022
Line 2:		Line 2:

	==Functional Description==		==Functional Description==
	This Matlab tool helps create parameter files for the Blackrock CereStim and the Neuro Omega from Alpha Omega.		This Matlab tool helps create parameter files for the Blackrock CereStim and the Neuro Omega from Alpha Omega. If this tool is desired for another stimulation device, please contact engelhardt@neurotechcenter.org and it can be implemented.
	==Versioning==		==Versioning==
	===Authors===		===Authors===
Line 28:		Line 28:
	===Right panel===		===Right panel===
	Here is where you can look at the parameters as they would be in BCI2000. They are split up into two tables: Configurations and Triggers. The Configuration table specifies what you are seeing in the figures. The Triggers table correlates to when each configuration is triggered, and to which channel the configuration goes to.		Here is where you can look at the parameters as they would be in BCI2000. They are split up into two tables: Configurations and Triggers. The Configuration table specifies what you are seeing in the figures. The Triggers table correlates to when each configuration is triggered, and to which channel the configuration goes to.
			===Important Notes===
			* The expression that is automatically added is "StimulusCode==", and the number increases from 1. This seems to be the most common trigger in experiments, but if you desire something else, you can manually change it in the table on the right. It still must be a [[User_Reference:Expression_Syntax\|valid BCI2000 expression]].
			* When channels with the same configuration are added, they are added under the same Trigger column. If you want to stimulate channels separately with the same configuration, just change one number of the configuration, generate a new configuration, then change that number back to match the original configuration
	==CereStim==		==CereStim==
			<gallery mode="packed" widths=350px heights=350px>
			File:CerestimGUIimg.png\|Figure 1: An example configuration for the CereStim.
			</gallery>
			Refer to the [[Contributions:CereStim\|CereStim Wiki page]] to see the description and limits on each parameter.

	==NeuroOmega==		==NeuroOmega==
			<gallery mode="packed" widths=350px heights=350px>
			File:NeuroOmegaGUIimg.png\|Figure 2: An example configuration for the NeuroOmega.
			</gallery>
			Refer to the [[Contributions:NeuroOmegaADC\|Neuro Omega Wiki page]] to see the description and limits on each parameter.
			* The "Recording Channels" section changes the channels listed in the "Channel" dropdown. If you want to use a channel that is not in any of the options, you can manually change it in the table.

Wengelhardt: Initial creation of page

2022-05-10T22:20:35Z

Initial creation of page

New page

[[Image:CerestimGUIimg.png|500px|right|thumb|frame|An example configuration for the CereStim. ]]

==Functional Description==
This Matlab tool helps create parameter files for the Blackrock CereStim and the Neuro Omega from Alpha Omega.
==Versioning==
===Authors===
* William Engelhardt (engelhardt@neurotechcenter.org)

===Version History===
* 2022/05/10: Initial working release R6736.

===Source Code Revisions===
*Initial development: 6736
*Known to compile under: 6736
*Broken since: --
===Known Issues/Important Things to Know===
*On some versions of Matlab the table column and row names may not show up. If this happens, please change your version of Matlab.

==Installation==
Assuming you have already installed BCI2000, navigate to "tools", then "NeuroStimulationParamsGUI". This folder will contain the installation file for the Matlab application. Double-clicking this will automatically open Matlab, and install the app in your apps. You can find it under the header "APPS". Open this app, and you are set.

==General Overview==
There are three main sections to the app:
===Left panel===
This is where you define the parameters for your desired stimulation. The bottom button, "Export to parameter file", lets you export the tables on the Right Panel to a valid BCI2000 parameter file.
===Middle panel===
Here three graphs are visualized, each with a different time scale. The top left, labeled "Single Pulse", shows one single pulse. The top right graph shows the full time range of the stimulation pulses. The bottom shows the full stimulation train, which is mainly defined by the parameters "Train Duration" and "Train Frequency". Each "pulse", where the value is 1, is the duration of the stimulation, which is shown in the top right figure. You can think of it as increasing the time scale as you go clockwise from the "Single Pulse" graph.
===Right panel===
Here is where you can look at the parameters as they would be in BCI2000. They are split up into two tables: Configurations and Triggers. The Configuration table specifies what you are seeing in the figures. The Triggers table correlates to when each configuration is triggered, and to which channel the configuration goes to.
==CereStim==

==NeuroOmega==

==See also==
[[Contributions:NeuroOmegaADC]], [[Contributions:CereStim]]

[[Category:User Interface]]