Contributions:g.EstimSwitchingUnit - Revision history

Wengelhardt: /* Digital Trigger */

2025-04-08T00:11:33Z

Digital Trigger

← Older revision		Revision as of 00:11, 8 April 2025
Line 35:		Line 35:

	====Digital Trigger====		====Digital Trigger====
	Channel switching is triggered by digital input on the back of the device, allowing for the use of foot pedals or push buttons. Only one electrode pair (one column) can be defined in the ''StimConfig'' parameter to use the digital trigger. When the digital trigger occurs, the switching configuration for that one configuration will be applied.		Channel switching is triggered by digital input on the back of the device, allowing for the use of foot pedals or push buttons. Only one electrode pair (one column) can be defined in the ''StimConfig'' parameter to use the digital trigger. When the digital trigger occurs, the switching configuration for that one configuration will be applied.

			If trigger is set to digital, the '''SwitchExpression will not be used'''. Instead, the channels will be set to active or not based on the digital input.

	===StimConfig===		===StimConfig===
	<gallery mode="packed" widths=300px heights=300px>		<gallery mode="packed" widths=300px heights=300px>

Abelsten: /* See also */

2021-01-27T18:26:05Z

Abelsten: /* Latency */

2021-01-25T21:28:18Z

Latency

← Older revision		Revision as of 21:28, 25 January 2021
Line 53:		Line 53:
	[[File:switching_unit_latency.png\|600px\|thumb\|center\|upright=2.5\|Figure 3: Latency changes greatly depending on if there is one electrode pair or multiple]]		[[File:switching_unit_latency.png\|600px\|thumb\|center\|upright=2.5\|Figure 3: Latency changes greatly depending on if there is one electrode pair or multiple]]

	The time between a SwitchExpression evaluating true and the channels switching varies based on the number of electrode pairs. The latency is much lower if there is only one electrode pair (one column) defined in StimConfig. When more than one electrode pairs are specified, the latency increases. A comparison of these latencies can be seen in Fig. 3. The large jump in latency from one electrode pair to multiple electrode pairs is due to the fact that the expression that evaluated true must now have its corresponding ~~configuration~~ uploaded to the device. In the case of one software configuration, the configuration does not need to be uploaded online because it is uploaded before the run. Checking which SwitchExpression evaluates true does not take very long, so the latency does not vary substantially when there are 2 electrode pairs defined, or 20.		The time between a SwitchExpression evaluating true and the channels switching varies based on the number of electrode pairs. The latency is much lower if there is only one electrode pair (one column) defined in StimConfig. When more than one electrode pairs are specified, the latency increases. A comparison of these latencies can be seen in Fig. 3. The large jump in latency from one electrode pair to multiple electrode pairs is due to the fact that the expression that evaluated true must now have its corresponding anode and cathode channels uploaded to the device. In the case of one software configuration, the configuration does not need to be uploaded online because it is uploaded before the run. Checking which SwitchExpression evaluates true does not take very long, so the latency does not vary substantially when there are 2 electrode pairs defined, or 20.

	Knowing what to expect in terms of switching latency allows the experimentalist to design their stimulation montage such that the switching of channels occurs before the stimulation is applied and even add some additional time to allow the switching artifact introduced to other channels to subside.		Knowing what to expect in terms of switching latency allows the experimentalist to design their stimulation montage such that the switching of channels occurs before the stimulation is applied and even add some additional time to allow the switching artifact introduced to other channels to subside.

Abelsten: /* Latency */

2021-01-25T21:24:59Z

Latency

← Older revision		Revision as of 21:24, 25 January 2021
Line 53:		Line 53:
	[[File:switching_unit_latency.png\|600px\|thumb\|center\|upright=2.5\|Figure 3: Latency changes greatly depending on if there is one electrode pair or multiple]]		[[File:switching_unit_latency.png\|600px\|thumb\|center\|upright=2.5\|Figure 3: Latency changes greatly depending on if there is one electrode pair or multiple]]

	The time between a SwitchExpression evaluating true and the channels ~~actually~~ switching varies based on the number of electrode pairs. The latency is much lower if there is only one electrode pair (one column) defined in ''StimConfig~~'', as can be seen in Fig. 3~~. When more than one electrode pairs are ~~defined~~, the latency increases. The large jump in latency from one electrode pair to multiple electrode pairs is due to the fact that the expression that evaluated true must now have its corresponding configuration uploaded to the device. In the case of one software configuration, the configuration does not need to be uploaded online because it is uploaded before the run. Checking which SwitchExpression evaluates true does not take very long so the latency does not vary substantially when there are 2 electrode pairs defined, or 20.		The time between a SwitchExpression evaluating true and the channels switching varies based on the number of electrode pairs. The latency is much lower if there is only one electrode pair (one column) defined in StimConfig. When more than one electrode pairs are specified, the latency increases. A comparison of these latencies can be seen in Fig. 3. The large jump in latency from one electrode pair to multiple electrode pairs is due to the fact that the expression that evaluated true must now have its corresponding configuration uploaded to the device. In the case of one software configuration, the configuration does not need to be uploaded online because it is uploaded before the run. Checking which SwitchExpression evaluates true does not take very long, so the latency does not vary substantially when there are 2 electrode pairs defined, or 20.

	Knowing what to expect in terms of switching latency allows the experimentalist to design their stimulation montage such that the switching of channels occurs before the stimulation is applied and even add some additional time to allow the switching artifact introduced to other channels to subside.		Knowing what to expect in terms of switching latency allows the experimentalist to design their stimulation montage such that the switching of channels occurs before the stimulation is applied and even add some additional time to allow the switching artifact introduced to other channels to subside.

Abelsten at 18:13, 25 January 2021

2021-01-25T18:13:49Z

← Older revision		Revision as of 18:13, 25 January 2021
Line 6:		Line 6:
	===Version History===		===Version History===
	* 2020/05/22: Initial release for the switching unit prototype		* 2020/05/22: Initial release for the switching unit prototype
			* 2020/01/25: Usability improvements and hardware API updated to latest version.

	===Source Code Revisions===		===Source Code Revisions===
	*Initial development: 6125		*Initial development: 6125
	*Known to compile under: ~~6177~~		*Known to compile under: 6191
	*Broken since: --		*Broken since: --

Line 16:		Line 17:

	==Integration into BCI2000==		==Integration into BCI2000==
	Compile the filter by enabling <code>BUILD_PRIVATE</code> in your CMake configuration. Access to the private directory in the SVN is necessary.		Compile the filter by enabling <code>BUILD_PRIVATE</code> in your CMake configuration. Access to the private directory in the SVN is necessary. Then compile the filter, and make <code>gEstimProSwitchingUnit</code> the filter in your batch file.

	==Parameters==		==Parameters==
Line 31:		Line 32:

	====Software Trigger====		====Software Trigger====
	Channel switching is triggered when ~~the StimulusCode state meets the stimulus condition~~ defined in the first row of the ''StimConfig'' parameter. Note: if only one state (one column) is defined in ''StimConfig'', channel information configuration will not need to be re-uploaded to the device. This results in a dramatic decrease in latency of transition between recording to stimulating. See the [[Contributions:g.EstimSwitchingUnit#Latency\|latency]] section for ~~more~~ details.		Channel switching is triggered when a ''SwitchExpression'' defined in the first row of the ''StimConfig'' parameter evaluates true. See the [[Contributions:g.EstimSwitchingUnit#Latency\|latency]] section for details on how switching latency varies based on the number of electrode pairs that are defined.

	====Digital Trigger====		====Digital Trigger====
	Channel switching is triggered by digital input on the back of the device, allowing for the use of foot pedals or push buttons. Only one ~~state~~ (one column) can be defined in the ''StimConfig'' parameter to use the digital trigger. When the digital trigger occurs, the switching configuration for that one ~~state~~ will be applied.		Channel switching is triggered by digital input on the back of the device, allowing for the use of foot pedals or push buttons. Only one electrode pair (one column) can be defined in the ''StimConfig'' parameter to use the digital trigger. When the digital trigger occurs, the switching configuration for that one configuration will be applied.

	===StimConfig===		===StimConfig===
	~~This matrix configures channel routing~~. ~~The StimConfig parameter is where expressions for the software trigger and~~ electrode ~~pairs are~~ defined. Each column contains information for a specific switching configuration and the number of configurations must be configured in accordance with the trigger type. If the trigger type is set to digital, there must only be one configuration (one column) as shown in Image 1. ~~There can also be multiple configurations if the software trigger is enabled (Image~~ 2).		<gallery mode="packed" widths=300px heights=300px>
			File:switching_unit_one_electrode_pair.png\|Figure 1: One electrode pair defined.
			File:switching_unit_multiple_electrode_pairs.png\|Figure 2: Multiple electrode pairs defined.
			</gallery>

			This matrix configures channel routing. The StimConfig parameter is where expressions for the software triggers and electrode pairs are defined. Each column contains information for a specific switching configuration and the number of configurations must be configured in accordance with the trigger type. If the trigger type is set to ''Digital'', there must only be one configuration (one column) as shown in Fig. 1. If the trigger type is ''Software'', one configuration can be defined, or multiple can be defined as seen in Fig. 2.

			The cells in rows corresponding to ''Stim+ ch'' (anode) and ''Stim- ch'' (cathode) define the electrode pairs. These cells are embedded lists that can be edited by right-clicking on the list cell and selecting “Edit submatrix.” For a given configuration, the cathode and anode electrode lists must be disjoint.
	==States==		==States==
	===EstimSU===		===EstimSU===
Line 44:		Line 51:

	==Latency==		==Latency==
	[[File:switching_unit_latency.png\|600px\|thumb\|center\|upright=2.5\|Figure 1: Latency changes greatly depending on if there is one electrode pair or multiple]]		[[File:switching_unit_latency.png\|600px\|thumb\|center\|upright=2.5\|Figure 3: Latency changes greatly depending on if there is one electrode pair or multiple]]

	The time between a SwitchExpression evaluating true and the channels actually switching varies based on the number of electrode pairs. The latency is much lower if there is only one electrode pair (one column) defined in ''StimConfig'', as can be seen in Fig. 1. When more than one electrode pairs are defined, the latency increases. The large jump in latency from one electrode pair to multiple electrode pairs is due to the fact that the expression that evaluated true must now have its corresponding configuration uploaded to the device. In the case of one software configuration, the configuration does not need to be uploaded online because it is uploaded before the run. Checking which SwitchExpression evaluates true does not take very long so the latency does not vary substantially when there are 2 electrode pairs defined, or 20.		The time between a SwitchExpression evaluating true and the channels actually switching varies based on the number of electrode pairs. The latency is much lower if there is only one electrode pair (one column) defined in ''StimConfig'', as can be seen in Fig. 3. When more than one electrode pairs are defined, the latency increases. The large jump in latency from one electrode pair to multiple electrode pairs is due to the fact that the expression that evaluated true must now have its corresponding configuration uploaded to the device. In the case of one software configuration, the configuration does not need to be uploaded online because it is uploaded before the run. Checking which SwitchExpression evaluates true does not take very long so the latency does not vary substantially when there are 2 electrode pairs defined, or 20.

	Knowing what to expect in terms of switching latency allows the experimentalist to design their stimulation montage such that the switching of channels occurs before the stimulation is applied and even add some additional time to allow the switching artifact introduced to other channels to subside.		Knowing what to expect in terms of switching latency allows the experimentalist to design their stimulation montage such that the switching of channels occurs before the stimulation is applied and even add some additional time to allow the switching artifact introduced to other channels to subside.

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

	[[Category:Contributions]][[Category:SignalProcessing]]		[[Category:Contributions]][[Category:SignalProcessing]]

Abelsten: Added latency and states section. Populated latency section with a figure. Will add screenshots of BCI2000 to further demonstrate functionalities

2021-01-25T17:27:22Z

Added latency and states section. Populated latency section with a figure. Will add screenshots of BCI2000 to further demonstrate functionalities

← Older revision		Revision as of 17:27, 25 January 2021
Line 1:		Line 1:
	~~==Location==~~
	~~http://{{SERVERNAME}}/svn/trunk/src/private/SignalProcessing/g.EstimSwitchingUnit~~
	==Versioning==		==Versioning==
	[[File:g.switching-unit-device.jpg\|400px\|thumb\|right\|g.tec g.Estim Switching Unit]]		[[File:g.switching-unit-device.jpg\|400px\|thumb\|right\|g.tec g.Estim Switching Unit]]
Line 15:		Line 13:

	==Functional Description==		==Functional Description==
	The purpose of this device and filter is to automate the process of switching channels from recording to stimulation during cortical stimulation experiments. Previously, channels had to be switched manually (unplugging electrodes from the amplifier and plugging them into a stimulator). With the switching unit and this filter, this process is automated.~~The filter has been developed using:~~		The purpose of this device and filter is to automate the process of switching channels from recording to stimulation during cortical stimulation experiments. Previously, channels had to be switched manually (unplugging electrodes from the amplifier and plugging them into a stimulator). With the switching unit and this filter, this process is automated.

	~~&emsp; <b>g.Estim Pro Switching Unit Prototype</b>~~

	~~&emsp; &emsp; Serial Number: SR-2019.10.01~~

	~~&emsp; &emsp; API Version: 0.1.0537~~

	==Integration into BCI2000==		==Integration into BCI2000==
Line 29:		Line 21:
	The g.EstimSwitchingUnit is configured in the filtering tab. The configurable parameters are:		The g.EstimSwitchingUnit is configured in the filtering tab. The configurable parameters are:

	===~~EnableSU~~===		===ActivateSwitchingUnit===
	This parameter enables the switching unit.		This parameter enables the switching unit.

Line 45:		Line 37:

	===StimConfig===		===StimConfig===
	This matrix configures channel routing. The ~~first row labeled by <code>SwitchExpression</code>~~ is the ~~channel routing condition~~. ~~When <code> SwitchExpression</code> evaluates true~~, the ~~channels will be routed for stimulation~~. ~~The~~ <code>~~Stim+ ch~~</code> and <code>~~Stim- ch~~</code> ~~nested lists define what channels should be routed to the positive side (anode~~) ~~of the stimulation input and to the negative side (cathode) of stimulation input~~.		This matrix configures channel routing. The StimConfig parameter is where expressions for the software trigger and electrode pairs are defined. Each column contains information for a specific switching configuration and the number of configurations must be configured in accordance with the trigger type. If the trigger type is set to digital, there must only be one configuration (one column) as shown in Image 1. There can also be multiple configurations if the software trigger is enabled (Image 2).

			==States==
			===EstimSU===
			This binary state records when the switching unit is switched into the active state (<code>1</code>) and inactive state (<code>0</code>).

	==Latency==		==Latency==
	~~Under construction~~... ~~Check back soon!~~		[[File:switching_unit_latency.png\|600px\|thumb\|center\|upright=2.5\|Figure 1: Latency changes greatly depending on if there is one electrode pair or multiple]]

			The time between a SwitchExpression evaluating true and the channels actually switching varies based on the number of electrode pairs. The latency is much lower if there is only one electrode pair (one column) defined in ''StimConfig'', as can be seen in Fig. 1. When more than one electrode pairs are defined, the latency increases. The large jump in latency from one electrode pair to multiple electrode pairs is due to the fact that the expression that evaluated true must now have its corresponding configuration uploaded to the device. In the case of one software configuration, the configuration does not need to be uploaded online because it is uploaded before the run. Checking which SwitchExpression evaluates true does not take very long so the latency does not vary substantially when there are 2 electrode pairs defined, or 20.

			Knowing what to expect in terms of switching latency allows the experimentalist to design their stimulation montage such that the switching of channels occurs before the stimulation is applied and even add some additional time to allow the switching artifact introduced to other channels to subside.

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

	[[Category:Contributions]][[Category:SignalProcessing]]		[[Category:Contributions]][[Category:SignalProcessing]]

Abelsten: /* Functional Description */

2021-01-15T19:52:58Z

Functional Description

← Older revision		Revision as of 19:52, 15 January 2021
Line 17:		Line 17:
	The purpose of this device and filter is to automate the process of switching channels from recording to stimulation during cortical stimulation experiments. Previously, channels had to be switched manually (unplugging electrodes from the amplifier and plugging them into a stimulator). With the switching unit and this filter, this process is automated.The filter has been developed using:		The purpose of this device and filter is to automate the process of switching channels from recording to stimulation during cortical stimulation experiments. Previously, channels had to be switched manually (unplugging electrodes from the amplifier and plugging them into a stimulator). With the switching unit and this filter, this process is automated.The filter has been developed using:

	&emsp; <b>g.Estim Switching Unit Prototype</b>		&emsp; <b>g.Estim Pro Switching Unit Prototype</b>

	&emsp; &emsp; Serial Number: SR-2019.10.01		&emsp; &emsp; Serial Number: SR-2019.10.01

Abelsten at 19:52, 15 January 2021

2021-01-15T19:52:25Z

← Older revision		Revision as of 19:52, 15 January 2021
Line 15:		Line 15:

	==Functional Description==		==Functional Description==
	~~This~~ filter ~~adds support for the g.tec g.Estim PRO Switching unit. This device~~ is ~~used in conjunction with a g.Estim and a g.tec amplifier. It allows for~~ the ~~channels the automatic~~ switching of channels from a recording ~~channel~~ to a ~~stimulating channel~~. The filter has been developed using:		The purpose of this device and filter is to automate the process of switching channels from recording to stimulation during cortical stimulation experiments. Previously, channels had to be switched manually (unplugging electrodes from the amplifier and plugging them into a stimulator). With the switching unit and this filter, this process is automated.The filter has been developed using:

	&emsp; <b>g.Estim Switching Unit Prototype</b>		&emsp; <b>g.Estim Switching Unit Prototype</b>
Line 33:		Line 33:

	===DeviceID===		===DeviceID===
	Index of device ~~to connect to~~. ~~Usually~~ 0.		Index of the device on the system. If one switching unit is plugged into the computer this value should be 0.

	===Trigger===		===Trigger===
Line 39:		Line 39:

	====Software Trigger====		====Software Trigger====
	Channel switching is triggered when the StimulusCode state meets the stimulus condition defined in the first row of the ''StimConfig'' parameter. Note: if only one state (one column) is defined in ''StimConfig'', channel information configuration will not need to be re-uploaded to the device. This results in a dramatic decrease in latency of transition between recording to stimulating.		Channel switching is triggered when the StimulusCode state meets the stimulus condition defined in the first row of the ''StimConfig'' parameter. Note: if only one state (one column) is defined in ''StimConfig'', channel information configuration will not need to be re-uploaded to the device. This results in a dramatic decrease in latency of transition between recording to stimulating. See the [[Contributions:g.EstimSwitchingUnit#Latency\|latency]] section for more details.

	====Digital Trigger====		====Digital Trigger====
	Channel switching is triggered by ~~the~~ digital in on the ~~switching unit~~. Only one state (one column) can be defined in the ''StimConfig'' parameter to use the digital trigger. When the digital trigger occurs, the switching configuration for that one state will be applied.		Channel switching is triggered by digital input on the back of the device, allowing for the use of foot pedals or push buttons. Only one state (one column) can be defined in the ''StimConfig'' parameter to use the digital trigger. When the digital trigger occurs, the switching configuration for that one state will be applied.

	===StimConfig===		===StimConfig===
	This matrix configures channel routing. The first row labeled by <code>~~StimulusCode~~</code> is the channel routing condition. When <code>~~StimulusCode~~</code> ~~is equal to this condition~~, the channels will be routed for stimulation. The <code>Stim+ ch</code> and <code>Stim- ch</code> nested lists define what channels should be routed to the positive side (anode) of the stimulation input and to the negative side (cathode) of stimulation input.		This matrix configures channel routing. The first row labeled by <code>SwitchExpression</code> is the channel routing condition. When <code> SwitchExpression</code> evaluates true, the channels will be routed for stimulation. The <code>Stim+ ch</code> and <code>Stim- ch</code> nested lists define what channels should be routed to the positive side (anode) of the stimulation input and to the negative side (cathode) of stimulation input.

			==Latency==
			Under construction... Check back soon!
	==See also==		==See also==

	[[Category:Contributions]][[Category:SignalProcessing]]		[[Category:Contributions]][[Category:SignalProcessing]]

Abelsten: Added a picture of the switching unit

2021-01-15T18:28:48Z

Added a picture of the switching unit

← Older revision		Revision as of 18:28, 15 January 2021
Line 2:		Line 2:
	http://{{SERVERNAME}}/svn/trunk/src/private/SignalProcessing/g.EstimSwitchingUnit		http://{{SERVERNAME}}/svn/trunk/src/private/SignalProcessing/g.EstimSwitchingUnit
	==Versioning==		==Versioning==
			[[File:g.switching-unit-device.jpg\|400px\|thumb\|right\|g.tec g.Estim Switching Unit]]
	===Author===		===Author===
	Alexander Belsten (belsten@neurotechcenter.org)		Alexander Belsten (belsten@neurotechcenter.org)
Line 13:		Line 14:
	*Broken since: --		*Broken since: --

	==Functional Description==		==Functional Description==
	This filter adds support for the g.tec g.Estim PRO Switching unit. This device is used in conjunction with a g.Estim and a g.tec amplifier. It allows for the channels the automatic switching of channels from a recording channel to a stimulating channel. The filter has been developed using:		This filter adds support for the g.tec g.Estim PRO Switching unit. This device is used in conjunction with a g.Estim and a g.tec amplifier. It allows for the channels the automatic switching of channels from a recording channel to a stimulating channel. The filter has been developed using:

Abelsten: /* Software trigger */

2021-01-15T18:22:09Z

Software trigger

← Older revision		Revision as of 18:22, 15 January 2021
Line 37:		Line 37:
	There are two options for the trigger, a software trigger, and a digital trigger.		There are two options for the trigger, a software trigger, and a digital trigger.

	====Software ~~trigger~~====		====Software Trigger====
	Channel switching is triggered when the StimulusCode state meets the stimulus condition defined in the first row of the ''StimConfig'' parameter. Note: if only one state (one column) is defined in ''StimConfig'', channel information configuration will not need to be re-uploaded to the device. This results in a dramatic decrease in latency of transition between recording to stimulating.		Channel switching is triggered when the StimulusCode state meets the stimulus condition defined in the first row of the ''StimConfig'' parameter. Note: if only one state (one column) is defined in ''StimConfig'', channel information configuration will not need to be re-uploaded to the device. This results in a dramatic decrease in latency of transition between recording to stimulating.

← Older revision		Revision as of 18:26, 27 January 2021
Line 56:		Line 56:

	Knowing what to expect in terms of switching latency allows the experimentalist to design their stimulation montage such that the switching of channels occurs before the stimulation is applied and even add some additional time to allow the switching artifact introduced to other channels to subside.		Knowing what to expect in terms of switching latency allows the experimentalist to design their stimulation montage such that the switching of channels occurs before the stimulation is applied and even add some additional time to allow the switching artifact introduced to other channels to subside.

	~~==See also==~~
	~~[[Category:Contributions]][[Category:SignalProcessing]]~~