Contributions:gEstimFilter - Revision history

Wengelhardt at 23:36, 7 May 2025

2025-05-07T23:36:44Z

← Older revision		Revision as of 23:36, 7 May 2025
Line 1:		Line 1:
	[[File:gEstim_PRO.jpg\|400px\|thumb\|right\|g.tec g.Estim PRO cortical stimulator]]		[[File:gEstim_PRO.jpg\|400px\|thumb\|right\|g.tec g.Estim PRO cortical stimulator]]
	This filter allows for cortical stimulation with the g.tec gEstim PRO.		This filter allows for cortical stimulation with the g.tec gEstim PRO. This extension resides in the Application module and allows for electrical stimulation.
			Note: As of rev.6131, this extension does not work the the gEstim FES Research. The extension has only been tested with the g.Estim PRO.

	==Versioning==		==Versioning==
Line 16:		Line 17:
	*Broken since: --		*Broken since: --

	==~~Functional Description~~==		==Installation / Versions==
	~~This extension resides~~ in the ~~Application module and allows for electrical stimulation~~.		The gEstimPro drivers must be installed. Contact gTec to obtain access.
	~~Note: As~~ of ~~rev~~.~~6131~~, ~~this extension does not work the the gEstim FES Research~~. ~~The extension has only been tested with the g~~.~~Estim PRO~~.
			The gEstim has 2 modes that can be used in BCI2000: basic and advanced. These are set by the parameter [[#DeviceMode\|DeviceMode]]. There are a variety of features that require the advanced mode, which can only be enabled when a gTec USB dongle is attached. These also require various firmware versions, detailed below.

			{\|style="text-align: left;"
			! Feature !! Minimum Firmware
			\|-
			\|Supermode
			\|1.23
			\|-
			\|Asymmetric (Lilly) pulses
			\|1.7
			\|}

	~~==Installation==~~		To use the dongle with BCI2000, you need to download the Sentinel LDK HASP driver. To make sure this is downloaded, when you plug in the gEstim USB, check Device Manager, and '''Sentinel HASP Key''' should appear under Universal Serial Bus controllers.
	~~The gEstimPro drivers must be installed~~. ~~Contact gTec to obtain access~~.

	==Integration into BCI2000==		==Integration into BCI2000==

Wengelhardt at 21:23, 6 May 2025

2025-05-06T21:23:50Z

← Older revision		Revision as of 21:23, 6 May 2025
Line 47:		Line 47:
	Only some gEstim devices, with an updated firmware, can quickly change stimulation configurations with the use of SUPERMODE. If you enabled ''UseMultipleConfigurations'' and your device cannot enable SUPERMODE, BCI2000 will warn you. It will still work to switch stimulation parameters, but it will take longer than 200ms.		Only some gEstim devices, with an updated firmware, can quickly change stimulation configurations with the use of SUPERMODE. If you enabled ''UseMultipleConfigurations'' and your device cannot enable SUPERMODE, BCI2000 will warn you. It will still work to switch stimulation parameters, but it will take longer than 200ms.

	[[File:Dynamic_gEstim.png\|frame]]		[[File:Dynamic_gEstim.png\|frame\|An example of using DynamicStimulation, where the States will specify the stimulation settings.]]
	====DynamicStimulation====		====DynamicStimulation====
	Enable to use States as Parameters in the StimulationConfiguration table. This allows for having stimulation settings on the fly. However, this bypasses any stimulation preflight checks, as the stimulation values won't be known until the moment of stimulation. Use with caution.		Enable to use States as Parameters in the StimulationConfiguration table. This allows for having stimulation settings on the fly. However, this bypasses any stimulation preflight checks, as the stimulation values won't be known until the moment of stimulation. The states are evaluated at the sample in which the StimulationConfigurations Expression is true. Use with caution.

	====DoSelfTest====		====DoSelfTest====
Line 62:		Line 62:
	===<u>Stimulation Parameters</u>===		===<u>Stimulation Parameters</u>===
	====StimulationConfigurations====		====StimulationConfigurations====
			An adaptable way to set any valid stimulation configuration for gEstim. This table is recommended for use instead of the individual parameters. Using this table, you can specify biphasic, monophasic, or asymmetric pulses. You can upload before you start the stimulation, or start immediately after switching the configuration. Details are below.

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

Wengelhardt at 21:07, 6 May 2025

2025-05-06T21:07:34Z

← Older revision		Revision as of 21:07, 6 May 2025
Line 7:		Line 7:

	Alexander Belsten (belsten@neurotechcenter.org)		Alexander Belsten (belsten@neurotechcenter.org)

			Will Engelhardt (engelhardt@neurotechcenter.org)

	===Source Code Revisions===		===Source Code Revisions===
Line 28:		Line 30:

	===<u>Set-up Preferences</u>===		===<u>Set-up Preferences</u>===
			[[File:GEstimCheckmarkOptions.png\|frame\|right\|upright=3\|The on/off or enumeration options for gEstim]]

	====ActivateEstim====		====ActivateEstim====
Line 39:		Line 42:
	Device mode, with available options of Default, Basic, Handheld, Advanced, and FES. Changing the mode affects the default configuration settings and the maximum and minimum limitations of the device.		Device mode, with available options of Default, Basic, Handheld, Advanced, and FES. Changing the mode affects the default configuration settings and the maximum and minimum limitations of the device.

	~~[[File:GEstimCheckmarkOptions.png\|frame\|right\|upright=3\|The on/off or enumeration options for gEstim]]~~
	====UseMultipleConfigurations====		====UseMultipleConfigurations====
	Enables the use of StimulationConfigurations table. This allows for multiple stimulation configurations during a run. Whenever stimulation is triggered through the <code>EstimOn</code> row or through <code>StimulationExpression</code>, it will trigger the most recently uploaded configuration.		Enables the use of StimulationConfigurations table. This allows for multiple stimulation configurations during a run. Whenever stimulation is triggered through the <code>EstimOn</code> row or through <code>StimulationExpression</code>, it will trigger the most recently uploaded configuration.

	Only some gEstim devices, with an updated firmware, can quickly change stimulation configurations with the use of SUPERMODE. If you enabled ''UseMultipleConfigurations'' and your device cannot enable SUPERMODE, BCI2000 will warn you. It will still work to switch stimulation parameters, but it will take longer than 200ms.		Only some gEstim devices, with an updated firmware, can quickly change stimulation configurations with the use of SUPERMODE. If you enabled ''UseMultipleConfigurations'' and your device cannot enable SUPERMODE, BCI2000 will warn you. It will still work to switch stimulation parameters, but it will take longer than 200ms.

			[[File:Dynamic_gEstim.png\|frame]]
			====DynamicStimulation====
			Enable to use States as Parameters in the StimulationConfiguration table. This allows for having stimulation settings on the fly. However, this bypasses any stimulation preflight checks, as the stimulation values won't be known until the moment of stimulation. Use with caution.

	====DoSelfTest====		====DoSelfTest====
Line 53:		Line 59:
	====EnableExternalTrigger====		====EnableExternalTrigger====
	Enable to use the digital input 1 (DIN1) as the external trigger for stimulation. This parameter mimics the same behavior as the native Matlab app for gEstim, allowing for DIN1 to be used as both for Start/Abort or just for Start. Using the external trigger lowers the stimulation latency.		Enable to use the digital input 1 (DIN1) as the external trigger for stimulation. This parameter mimics the same behavior as the native Matlab app for gEstim, allowing for DIN1 to be used as both for Start/Abort or just for Start. Using the external trigger lowers the stimulation latency.

	~~====EnableLillyPulses====~~
	Enable to specify different amplitudes and durations of the first and second pulses. However, their charges must be balanced. This mode uses a different configuration in the StimulationConfigurations table, see the image below.

	===<u>Stimulation Parameters</u>===		===<u>Stimulation Parameters</u>===
Line 62:		Line 65:
	<gallery mode="packed" heights=400>		<gallery mode="packed" heights=400>
	File:GEstimConfigTable.png\|Option 1: a default StimulationConfigurations table		File:GEstimConfigTable.png\|Option 1: a default StimulationConfigurations table
	File:GEstimConfigTableLillyPulses.png\|Option 2: to use ~~Lilly Pulses~~, have this configuration		File:GEstimConfigTableLillyPulses.png\|Option 2: to use asymmetric pulses, have this configuration
	</gallery>		</gallery>
	Table that allows for multiple configurations. The parameters in the table are the same as below. The first row, <code>Expression</code>, can either correlate to uploading the stimulation or uploading ''and'' starting the stimulation. '''To start immediately after upload, leave <code>StimulationExpression</code> empty and turn <code>UseStimulusPresentation</code> off'''. Otherwise, <code>StimulationExpression</code> or the <code>EstimOn</code> row will start the stimulation that was uploaded. The <code>AbortExpression</code> will still abort any active stimulation.		Table that allows for multiple configurations. The parameters in the table are the same as below. The first row, <code>Expression</code>, can either correlate to uploading the stimulation or uploading ''and'' starting the stimulation. '''To start immediately after upload, leave <code>StimulationExpression</code> empty and turn <code>UseStimulusPresentation</code> off'''. Otherwise, <code>StimulationExpression</code> or the <code>EstimOn</code> row will start the stimulation that was uploaded. The <code>AbortExpression</code> will still abort any active stimulation.
Line 74:		Line 77:
	Modularity of pulses; Biphasic or Monophasic		Modularity of pulses; Biphasic or Monophasic

	''~~Not used in Lilly pulse mode~~.''		''Must be biphasic when specifying asymmetric pulses.''
	====Polarity====		====Polarity====
	Polarity of pulses; Alternating or Steady		Polarity of pulses; Alternating or Steady

	''~~Is always Steady in Lilly pulse mode~~''~~, due to the gEstim constraint that the first pulse needs to be positive~~		''Must be steady when specifying asymmetric pulses.''
	====PhaseDuration====		====PhaseDuration====
	Duration of time of each +/- phase.		Duration of time of each +/- phase.
Line 86:		Line 89:
	Magnitude of the pulse in milliamps. This quantity is peak-to-zero.		Magnitude of the pulse in milliamps. This quantity is peak-to-zero.

	''Both magnitudes must be greater than 0'' ~~in Lilly mode~~. The 2nd pulse will automatically be negative.		''Both magnitudes must be greater than 0'' when specifying asymmetric pulses. The 2nd pulse will automatically be negative.
	====NumberOfPulses====		====NumberOfPulses====
	Number of pulses per train.		Number of pulses per train.

Wengelhardt: /* Electrode Settings */

2025-04-28T20:01:33Z

Electrode Settings

← Older revision		Revision as of 20:01, 28 April 2025
Line 100:		Line 100:
	===<u>Electrode Settings</u>===		===<u>Electrode Settings</u>===

			[[File:GEstimElectrodeParameters.png\|frame\|Parameters for electrode type]]
	====ElectrodeType====		====ElectrodeType====
	Type of electrode being used: 1 Circle, 2 Depth, 3 Other.		Type of electrode being used: 1 Circle, 2 Depth, 3 Other.

Wengelhardt: /* Set-up Preferences */

2025-04-28T19:55:02Z

Set-up Preferences

← Older revision		Revision as of 19:55, 28 April 2025
Line 53:		Line 53:
	====EnableExternalTrigger====		====EnableExternalTrigger====
	Enable to use the digital input 1 (DIN1) as the external trigger for stimulation. This parameter mimics the same behavior as the native Matlab app for gEstim, allowing for DIN1 to be used as both for Start/Abort or just for Start. Using the external trigger lowers the stimulation latency.		Enable to use the digital input 1 (DIN1) as the external trigger for stimulation. This parameter mimics the same behavior as the native Matlab app for gEstim, allowing for DIN1 to be used as both for Start/Abort or just for Start. Using the external trigger lowers the stimulation latency.

			====EnableLillyPulses====
			Enable to specify different amplitudes and durations of the first and second pulses. However, their charges must be balanced. This mode uses a different configuration in the StimulationConfigurations table, see the image below.

	===<u>Stimulation Parameters</u>===		===<u>Stimulation Parameters</u>===

Wengelhardt: /* Stimulation Parameters */

2025-04-28T19:51:17Z

Stimulation Parameters

← Older revision		Revision as of 19:51, 28 April 2025
Line 56:		Line 56:
	===<u>Stimulation Parameters</u>===		===<u>Stimulation Parameters</u>===
	====StimulationConfigurations====		====StimulationConfigurations====
	[[File:GEstimConfigTable.png\|~~frame\|center\|upright=3\|~~StimulationConfigurations table]]
			<gallery mode="packed" heights=400>
			File:GEstimConfigTable.png\|Option 1: a default StimulationConfigurations table
			File:GEstimConfigTableLillyPulses.png\|Option 2: to use Lilly Pulses, have this configuration
			</gallery>
	Table that allows for multiple configurations. The parameters in the table are the same as below. The first row, <code>Expression</code>, can either correlate to uploading the stimulation or uploading ''and'' starting the stimulation. '''To start immediately after upload, leave <code>StimulationExpression</code> empty and turn <code>UseStimulusPresentation</code> off'''. Otherwise, <code>StimulationExpression</code> or the <code>EstimOn</code> row will start the stimulation that was uploaded. The <code>AbortExpression</code> will still abort any active stimulation.		Table that allows for multiple configurations. The parameters in the table are the same as below. The first row, <code>Expression</code>, can either correlate to uploading the stimulation or uploading ''and'' starting the stimulation. '''To start immediately after upload, leave <code>StimulationExpression</code> empty and turn <code>UseStimulusPresentation</code> off'''. Otherwise, <code>StimulationExpression</code> or the <code>EstimOn</code> row will start the stimulation that was uploaded. The <code>AbortExpression</code> will still abort any active stimulation.

Line 66:		Line 70:
	[[File:gEstim_pulse_parameters.png\|600px\|thumb\|right\|upright=2.5\|Configurable parameters of stimulation profile]]		[[File:gEstim_pulse_parameters.png\|600px\|thumb\|right\|upright=2.5\|Configurable parameters of stimulation profile]]
	Modularity of pulses; Biphasic or Monophasic		Modularity of pulses; Biphasic or Monophasic

			''Not used in Lilly pulse mode.''
	====Polarity====		====Polarity====
	Polarity of pulses; Alternating or Steady		Polarity of pulses; Alternating or Steady

			''Is always Steady in Lilly pulse mode'', due to the gEstim constraint that the first pulse needs to be positive
	====PhaseDuration====		====PhaseDuration====
	Duration of time of each +/- phase.		Duration of time of each +/- phase.
Line 74:		Line 82:
	====Magnitude====		====Magnitude====
	Magnitude of the pulse in milliamps. This quantity is peak-to-zero.		Magnitude of the pulse in milliamps. This quantity is peak-to-zero.

			''Both magnitudes must be greater than 0'' in Lilly mode. The 2nd pulse will automatically be negative.
	====NumberOfPulses====		====NumberOfPulses====
	Number of pulses per train.		Number of pulses per train.

Wengelhardt at 21:48, 8 April 2025

2025-04-08T21:48:39Z

← Older revision		Revision as of 21:48, 8 April 2025
Line 17:		Line 17:
	This extension resides in the Application module and allows for electrical stimulation.		This extension resides in the Application module and allows for electrical stimulation.
	Note: As of rev.6131, this extension does not work the the gEstim FES Research. The extension has only been tested with the g.Estim PRO.		Note: As of rev.6131, this extension does not work the the gEstim FES Research. The extension has only been tested with the g.Estim PRO.

			==Installation==
			The gEstimPro drivers must be installed. Contact gTec to obtain access.

	==Integration into BCI2000==		==Integration into BCI2000==
	This extension resides in the private directory of BCI2000. It must be enabled in CMake by selecting <code>BUILD_GESTIMFILTER</code>. Then recompile the <code>BCI2000FrameworkAppModule</code>, and the application module you are using. Lastly, append the enable flag to your batch file (ex: <code>Start executable StimulusPresentation --local --ActivateEstim=1</code>).		This extension resides in the private directory of BCI2000. It must be enabled in CMake by selecting <code>BUILD_GESTIMFILTER</code>. Then recompile the <code>BCI2000FrameworkAppModule</code>, and the application module you are using. Lastly, append the enable flag to your batch file (ex: <code>Start executable StimulusPresentation --local --ActivateEstim=1</code>).

	~~==Usage==~~
	==Parameters==		==Parameters==
	The gEstim device is configured in the gEstim tab. The configurable parameters are:		The gEstim device is configured in the gEstim tab. The configurable parameters are:

Wengelhardt at 17:59, 28 January 2025

2025-01-28T17:59:06Z

← Older revision		Revision as of 17:59, 28 January 2025
Line 37:		Line 37:
	Device mode, with available options of Default, Basic, Handheld, Advanced, and FES. Changing the mode affects the default configuration settings and the maximum and minimum limitations of the device.		Device mode, with available options of Default, Basic, Handheld, Advanced, and FES. Changing the mode affects the default configuration settings and the maximum and minimum limitations of the device.

	[[File:GEstimCheckmarkOptions.png\|frame\|right\|upright=3\|The on/off options for gEstim]]		[[File:GEstimCheckmarkOptions.png\|frame\|right\|upright=3\|The on/off or enumeration options for gEstim]]
	====UseMultipleConfigurations====		====UseMultipleConfigurations====
	Enables the use of StimulationConfigurations table. This allows for multiple stimulation configurations during a run. Whenever stimulation is triggered through the <code>EstimOn</code> row or through <code>StimulationExpression</code>, it will trigger the most recently uploaded configuration.		Enables the use of StimulationConfigurations table. This allows for multiple stimulation configurations during a run. Whenever stimulation is triggered through the <code>EstimOn</code> row or through <code>StimulationExpression</code>, it will trigger the most recently uploaded configuration.

			Only some gEstim devices, with an updated firmware, can quickly change stimulation configurations with the use of SUPERMODE. If you enabled ''UseMultipleConfigurations'' and your device cannot enable SUPERMODE, BCI2000 will warn you. It will still work to switch stimulation parameters, but it will take longer than 200ms.

	====DoSelfTest====		====DoSelfTest====

Wengelhardt at 17:48, 28 January 2025

2025-01-28T17:48:36Z

← Older revision		Revision as of 17:48, 28 January 2025
Line 33:		Line 33:
	[[File:Estim_with_StimulusPresentation.png\|600px\|thumb\|center\|upright=2.5\|Figure 1: Adding an additional row labeled <code>EstimOn</code> to stimuli to trigger stimulation]]		[[File:Estim_with_StimulusPresentation.png\|600px\|thumb\|center\|upright=2.5\|Figure 1: Adding an additional row labeled <code>EstimOn</code> to stimuli to trigger stimulation]]
	This parameter can be enabled when using the Stimulus Presentation application module, and it is desired to stimulate on a particular stimulus, as defined in Stimulus Presentation's Stimuli parameter. To configure this functionality, enable this parameter and then navigate to the Application tab in BCI2000 and scroll down to the Stimuli matrix, as shown in Fig. 1. After opening the Stimuli matrix, add another row and name it <code>EstimOn</code>. Now, stimulation will be triggered on all stimuli defined in this matrix has its <code>EstimOn</code> row set to <code>1</code>. Stimulation will not occur on stimuli that have this row set to <code>0</code>.		This parameter can be enabled when using the Stimulus Presentation application module, and it is desired to stimulate on a particular stimulus, as defined in Stimulus Presentation's Stimuli parameter. To configure this functionality, enable this parameter and then navigate to the Application tab in BCI2000 and scroll down to the Stimuli matrix, as shown in Fig. 1. After opening the Stimuli matrix, add another row and name it <code>EstimOn</code>. Now, stimulation will be triggered on all stimuli defined in this matrix has its <code>EstimOn</code> row set to <code>1</code>. Stimulation will not occur on stimuli that have this row set to <code>0</code>.

			====DeviceMode====
			Device mode, with available options of Default, Basic, Handheld, Advanced, and FES. Changing the mode affects the default configuration settings and the maximum and minimum limitations of the device.

	[[File:GEstimCheckmarkOptions.png\|frame\|right\|upright=3\|The on/off options for gEstim]]		[[File:GEstimCheckmarkOptions.png\|frame\|right\|upright=3\|The on/off options for gEstim]]
Line 43:		Line 46:
	====QuietStimulation====		====QuietStimulation====
	Enable to silent the stimulation.		Enable to silent the stimulation.

			====EnableExternalTrigger====
			Enable to use the digital input 1 (DIN1) as the external trigger for stimulation. This parameter mimics the same behavior as the native Matlab app for gEstim, allowing for DIN1 to be used as both for Start/Abort or just for Start. Using the external trigger lowers the stimulation latency.

	===<u>Stimulation Parameters</u>===		===<u>Stimulation Parameters</u>===

Wengelhardt: /* StimulationConfigurations */

2023-10-03T19:39:21Z

StimulationConfigurations

← Older revision		Revision as of 19:39, 3 October 2023
Line 47:		Line 47:
	====StimulationConfigurations====		====StimulationConfigurations====
	[[File:GEstimConfigTable.png\|frame\|center\|upright=3\|StimulationConfigurations table]]		[[File:GEstimConfigTable.png\|frame\|center\|upright=3\|StimulationConfigurations table]]
	Table that allows for multiple configurations. The parameters in the table are the same as below. The first row, <code>Expression</code>, can either correlate to uploading the stimulation or uploading ''and'' starting the stimulation. '''To start immediately after upload, leave <code>StimulationExpression</code> empty and turn <code>UseStimulusPresentation</code> off'''. Otherwise, <code>StimulationExpression</code> will start the stimulation that was uploaded. The <code>AbortExpression</code> will still abort any active stimulation.		Table that allows for multiple configurations. The parameters in the table are the same as below. The first row, <code>Expression</code>, can either correlate to uploading the stimulation or uploading ''and'' starting the stimulation. '''To start immediately after upload, leave <code>StimulationExpression</code> empty and turn <code>UseStimulusPresentation</code> off'''. Otherwise, <code>StimulationExpression</code> or the <code>EstimOn</code> row will start the stimulation that was uploaded. The <code>AbortExpression</code> will still abort any active stimulation.

	====StimulationExpression====		====StimulationExpression====