Contributions:CortecADC - Revision history

Nluczak at 22:15, 14 May 2026

2026-05-14T22:15:06Z

← Older revision		Revision as of 22:15, 14 May 2026
Line 74:		Line 74:
	\|-		\|-
	!04/13/2026		!04/13/2026
	\|style="border-left: solid 1px grey; border-right: solid 1px grey;"\|~~R9xxx~~		\|style="border-left: solid 1px grey; border-right: solid 1px grey;"\|R9351
	\|Refactored stimulation to be more in line with Cortec and BCI2000 standards.		\|Refactored stimulation to be more in line with Cortec and BCI2000 standards.
	\|Nicholas Luczak		\|Nicholas Luczak

Nluczak at 22:06, 14 May 2026

2026-05-14T22:06:45Z

← Older revision		Revision as of 22:06, 14 May 2026
Line 192:		Line 192:
	File:CortecADC_stimulationtriggers_parm1.PNG		File:CortecADC_stimulationtriggers_parm1.PNG
	</gallery>		</gallery>
			<!-- TODO (Nick): replace the three stimulation parameter screenshots above with refreshed images per docx item 3a. -->
	===EnableStimulation===		===EnableStimulation===
	This parameter enables/disables stimulation.		This parameter enables/disables stimulation.
Line 202:		Line 202:
	#Persistent Functions: This preloading mode enables uploading up to 16 stimulation functions to the device and executing them individually by calling the stimulation function ID. The device executes only one stimulation function (the indexed one) without repetition. This mode is best suited for rapidly iterating over subsets of stimulation pulses in single-pulse stimulation settings.		#Persistent Functions: This preloading mode enables uploading up to 16 stimulation functions to the device and executing them individually by calling the stimulation function ID. The device executes only one stimulation function (the indexed one) without repetition. This mode is best suited for rapidly iterating over subsets of stimulation pulses in single-pulse stimulation settings.
	[[File:PersistantFunction.png\|1000px\|thumb\|center\|upright=2.5\|Figure 4. Figure demonstrating Persistant Function functionality]]		[[File:PersistantFunction.png\|1000px\|thumb\|center\|upright=2.5\|Figure 4. Figure demonstrating Persistant Function functionality]]
			<!-- TODO (Nick): per docx item 3e, edit PersistantFunction.png internally so the orange axis label currently reading "Source code" reads "StimulusCode". -->
	There cannot be any train settings (Train frequency and Train repetitions), so the StimulationTriggers must not have those rows. Also, StimulationTriggers must not have more than 16 columns, as that is the highest number of configurations that can be stored on the device.		There cannot be any train settings (Train frequency and Train repetitions), so the StimulationTriggers must not have those rows. Also, StimulationTriggers must not have more than 16 columns, as that is the highest number of configurations that can be stored on the device.
	Persistent Command and Functions modes have a lower latency because the stimulation is pre-uploaded. All modes are available to give you the highest amount of flexiblity with the BIC. [[#Stimulation Latency\|See below for more details on latency.]]		Persistent Command and Functions modes have a lower latency because the stimulation is pre-uploaded. All modes are available to give you the highest amount of flexiblity with the BIC. [[#Stimulation Latency\|See below for more details on latency.]]
Line 339:		Line 339:
	As explained above, volatile commands are uploaded right before stimulation, which leads to the increased latency and jitter.		As explained above, volatile commands are uploaded right before stimulation, which leads to the increased latency and jitter.
	==Template Parameter Files==		==Template Parameter Files==
	<~~!-- TODO (Nick): per docx item 3g, attach reviewed template~~ .prm files ~~for each~~ stimulation ~~mode~~ (~~Volatile~~, ~~Persistent Command~~, ~~Persistent Functions~~) ~~and link them here once paths~~/~~save locations are adjusted~~. -->		The following <code>.prm</code> files are '''stimulation parameter fragments''' — they contain only the Stimulation section (<code>EnableStimulation</code>, <code>StimulationMode</code>, <code>MeasureImpedance</code>, <code>LogStimulationEvents=1</code>, <code>StimulationPulses</code>, <code>StimulationTriggers</code>). Load one on top of an existing CortecADC configuration in the BCI2000 config window to swap in a stimulation paradigm without overwriting your source/storage/visualization settings.
	~~Template parameter files are provided~~ for ~~each stimulation~~ mode ~~to make it easier to get started:~~		===Volatile Commands (StimulationMode = 0)===
	* '''~~Volatile Commands~~''' — ''~~(link pending)~~''		* [https://bci2000.org/downloads/doc/complex_stim.prm complex_stim.prm] — '''Complex multi-function stimulation paradigm.''' 20-function StimulationPulses matrix mixing pause and stim functions, monopolar (cathode=0/ground) and multi-electrode anode/cathode lists, amplitudes 50–300µA, durations 50–500µs, and reps up to 255 × 100. Two triggers: <code>StimulusCode==1</code> runs functions [1, 2] with CommandRepetition=5; <code>StimulusCode==2</code> runs functions [3…20] once. Useful for exercising the volatile-mode flexibility on a long, structured command.
	* '''Persistent Command''' — ''(~~link pending~~)''		* [https://bci2000.org/downloads/doc/stim_100Hz_1min.prm stim_100Hz_1min.prm] — '''1-minute 100 Hz volatile stim train, three electrode targets.''' Three "100Hz" stimulation functions (FunctionID 1/2/3) all 250–150µA, 200µs, 100 pulses × 60 bursts (≈1 min at 100 Hz each). Triggers labeled '''ANT''', '''HPC''', and '''Cortical1''' map <code>StimulusCode==1/2/3</code> to those functions, so the same 100 Hz / 1 min train can be steered to anterior thalamus, hippocampus, or cortical electrodes.
	* '''Persistent Functions''' — ''(~~link pending~~)''		===Persistent Command (StimulationMode = 1)===
			* [https://bci2000.org/downloads/doc/persistant_100Hz_1function.prm persistant_100Hz_1function.prm] — '''Single-function 100 Hz preloaded persistent command.''' One stimulation function "100Hz" (250µA, 200µs, anode 1 / cathode 2, 200 pulses × 30 bursts ≈ 1 min of 100 Hz). One trigger "Sequence1" on <code>StimulusCode==1</code>, CommandRepetition=1. Demonstrates the simplest persistent-command setup: preload once, fire on cue.
			* [https://bci2000.org/downloads/doc/stim_1Hz_1min.prm stim_1Hz_1min.prm] — '''1 Hz × 1 min persistent-command train.''' Two functions, "1Hz" and "pause": a 250µA / 250µs single pulse (anode 1 / cathode 2) and a ~990 ms pause (IsPause=1, duration 990,000µs). One trigger "1Hz" on <code>StimulusCode==1</code> runs [1Hz, pause] with CommandRepetition=60 → 60 pulses spaced ~1 s apart = 1 Hz for 1 minute.
			* [https://bci2000.org/downloads/doc/stim_5Hz_1min.prm stim_5Hz_1min.prm] — '''5 Hz × 1 min persistent-command train.''' Same structure as the 1 Hz file but with a ~190 ms pause (190,000µs); trigger on <code>StimulusCode==1</code> with CommandRepetition=300 → 300 pulses at ~200 ms spacing = 5 Hz for 1 minute.
			===Persistent Functions (StimulationMode = 2)===
			* [https://bci2000.org/downloads/doc/persistant_function_single_pulse.prm persistant_function_single_pulse.prm] — '''Four indexed single-pulse persistent functions.''' Functions SinglePulse1–4 vary independently in amplitude (250 / 375 / 250 / 125 µA), pulse duration (250 / 250 / 200 / 500 µs), and electrode pair (10/11, 1/2, 3/5, 7/8). Triggers map <code>StimulusCode==1…4</code> directly to FunctionID 1…4 so each StimulusCode value fires a different preloaded single pulse — ideal for rapid iteration over a small set of distinct pulses.
			* [https://bci2000.org/downloads/doc/singlePulse.prm singlePulse.prm] — '''16 indexed single-pulse persistent functions, one per bipolar pair.''' 16-function StimulationPulses matrix of 250µA / 250µs single pulses across electrode pairs 1/2 … 15/16, plus an 8-vs-8 final function. Triggers map <code>StimulusCode==1…16</code> 1:1 onto FunctionID 1…16 (CommandRepetition=1) so each StimulusCode value fires a single pulse on its corresponding pair.
			===Matrix Parameter Files (.bmt)===
			<code>.bmt</code> files are BCI2000 matrix parameter exports. Load one into a matrix parameter (e.g., <code>StimulationPulses</code>). These templates only populate the corresponding matrix; everything else in the configuration (StimulationMode, triggers, ReferenceCh, etc.) is unaffected, so they can be reused across any stimulation mode.
			* [https://bci2000.org/downloads/doc/SinglePulse_withPause.bmt SinglePulse_withPause.bmt] — StimulationPulses matrix with four functions in sequence: a 1 s leading pause, a 250µA / 250µs single pulse on anode 1 / cathode 2, a 250µA / 250µs single pulse on anode 3 / cathode 5, and a 2.5 s inter-stimulation pause. Demonstrates how to interleave pause functions with stimulation in a single command.
			* [https://bci2000.org/downloads/doc/100Hz.bmt 100Hz.bmt] — StimulationPulses matrix with three functions: a 250µA / 200µs 100 Hz train (anode 1 / cathode 2, 100 pulses × 60 bursts), a 1 s pause (amplitude 0, dead zone 1 = 1,000,000µs), and a second 150µA / 200µs 100 Hz train (anodes 3,4 / cathodes 5,6, 100 pulses × 60 bursts). Use for two-train protocols separated by a fixed pause.
	==µZeus==		==µZeus==
	In order to use the new µZeus headpiece simply change the BICVERSION number on line 12 of the CMakeList.txt located in the project folder to use version 274 of the API. ie.,		In order to use the new µZeus headpiece simply change the BICVERSION number on line 12 of the CMakeList.txt located in the project folder to use version 274 of the API. ie.,

Nluczak at 21:05, 14 May 2026

2026-05-14T21:05:01Z

Show changes

Nluczak at 19:08, 13 April 2026

2026-04-13T19:08:57Z

Show changes

Nluczak at 13:54, 25 February 2026

2026-02-25T13:54:35Z

← Older revision		Revision as of 13:54, 25 February 2026
Line 16:		Line 16:
	===Source Code Revisions===		===Source Code Revisions===
	*Initial development: 6266		*Initial development: 6266
	*Tested under: ~~8709~~		*Tested under: 9282
	*Known to compile under: ~~8915~~		*Known to compile under: 9282
	*Broken since: --		*Broken since: --

Line 205:		Line 205:
	===StimulationMode===		===StimulationMode===
	The BIC has 3 stimulation modes. Each one has limitations. Here is a brief summary of how to use each one:		The BIC has 3 stimulation modes. Each one has limitations. Here is a brief summary of how to use each one:
	#Volatile Commands: The most flexible mode. The limitation is that the stimulation configuration is uploaded right before starting the stimulation, which increases the latency of the stimulation.		#Volatile Commands: The most flexible mode. The limitation is that the stimulation configuration is uploaded right before starting the stimulation, which increases the latency of the stimulation. This mode is best used in single pulse stimulation or stimulation burst applications. Can cause issues in longer stimulation trains due to the latency introduced by uploading commands repeatedly.
	#Persistent Command: There can only be one stimulation configuration (one column in StimulationPulses), which includes burst settings. ~~There can still be multiple trigger expressions~~ and ~~electrodes~~.		[[File:VolatileCommand.png\|1000px\|thumb\|center\|upright=2.5\|Figure 1. Figure demonstrating volatile command functionality]]
	#Persistent Functions: There cannot be any train settings (Train frequency and Train repetitions), so the StimulationTriggers must not have those rows. Also, StimulationTriggers must not have more than 16 columns, as that is the highest number of configurations that can be stored on the device.		#Persistent Command: There can only be one stimulation configuration (one column in StimulationPulses), which includes burst settings. You cannot change the source and destination channels without uploading a new command. This mode is useful for implementing stimulation trains, otherwise similar but less flexible when compared to volatile commands.
			[[File:PersistantCommand.png\|1000px\|thumb\|center\|upright=2.5\|Figure 2. Figure demonstrating Persistant Command functionality]]

			#Persistent Functions: This function allows you to preload multiple stimulation configurations allowing for the user to define different source and destination channels. The device executes only one of the stim configrations, and without repetition. This is best used for rapidly iterating over subsets of stimulation pulses in single-pulse stimulation settings.
			[[File:PersistantFunction.png\|1000px\|thumb\|center\|upright=2.5\|Figure 3. Figure demonstrating Persistant Function functionality]]
			There cannot be any train settings (Train frequency and Train repetitions), so the StimulationTriggers must not have those rows. Also, StimulationTriggers must not have more than 16 columns, as that is the highest number of configurations that can be stored on the device.

	Persistent Command and Functions modes have a lower latency because the stimulation is pre-uploaded. All modes are available to give you the highest amount of flexiblity with the BIC. [[#Stimulation Latency\|See below for more details on latency.]]		Persistent Command and Functions modes have a lower latency because the stimulation is pre-uploaded. All modes are available to give you the highest amount of flexiblity with the BIC. [[#Stimulation Latency\|See below for more details on latency.]]

Nluczak: /* µZeus */

2025-10-14T21:57:15Z

µZeus

← Older revision		Revision as of 21:57, 14 October 2025
Line 383:		Line 383:
	In order to use the new µZeus headpiece simply change the BICVERSION number on line 12 of the CMakeList.txt located in the project folder to use version 274 of the API. ie.,		In order to use the new µZeus headpiece simply change the BICVERSION number on line 12 of the CMakeList.txt located in the project folder to use version 274 of the API. ie.,

	<code>set(BICAPI_VERSION 274)<code/>		<code>set(BICAPI_VERSION 274)</code>

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

Nluczak: /* µZeus */

2025-10-14T21:56:53Z

µZeus

← Older revision		Revision as of 21:56, 14 October 2025
Line 382:		Line 382:
	==µZeus==		==µZeus==
	In order to use the new µZeus headpiece simply change the BICVERSION number on line 12 of the CMakeList.txt located in the project folder to use version 274 of the API. ie.,		In order to use the new µZeus headpiece simply change the BICVERSION number on line 12 of the CMakeList.txt located in the project folder to use version 274 of the API. ie.,
	set(BICAPI_VERSION 274)
			<code>set(BICAPI_VERSION 274)<code/>

	==See also==		==See also==
	[[User Reference:Filters]], [[Contributions:ADCs]]		[[User Reference:Filters]], [[Contributions:ADCs]]

	[[Category:Contributions]][[Category:Data Acquisition]]		[[Category:Contributions]][[Category:Data Acquisition]]

Nluczak: Updated to support the µZeus

2025-10-14T21:54:59Z

Updated to support the µZeus

← Older revision		Revision as of 21:54, 14 October 2025
Line 380:		Line 380:

	As explained above, volatile commands are uploaded right before stimulation, which leads to the increased latency and jitter.		As explained above, volatile commands are uploaded right before stimulation, which leads to the increased latency and jitter.
			==µZeus==
			In order to use the new µZeus headpiece simply change the BICVERSION number on line 12 of the CMakeList.txt located in the project folder to use version 274 of the API. ie.,
			set(BICAPI_VERSION 274)
	==See also==		==See also==
	[[User Reference:Filters]], [[Contributions:ADCs]]		[[User Reference:Filters]], [[Contributions:ADCs]]

	[[Category:Contributions]][[Category:Data Acquisition]]		[[Category:Contributions]][[Category:Data Acquisition]]

Wengelhardt: /* StimulationMode */

2025-07-30T18:48:11Z

StimulationMode

← Older revision		Revision as of 18:48, 30 July 2025
Line 206:		Line 206:
	The BIC has 3 stimulation modes. Each one has limitations. Here is a brief summary of how to use each one:		The BIC has 3 stimulation modes. Each one has limitations. Here is a brief summary of how to use each one:
	#Volatile Commands: The most flexible mode. The limitation is that the stimulation configuration is uploaded right before starting the stimulation, which increases the latency of the stimulation.		#Volatile Commands: The most flexible mode. The limitation is that the stimulation configuration is uploaded right before starting the stimulation, which increases the latency of the stimulation.
	#Persistent Command: There can only be one stimulation configuration, which includes burst settings. There can still be multiple trigger expressions and electrodes.		#Persistent Command: There can only be one stimulation configuration (one column in StimulationPulses), which includes burst settings. There can still be multiple trigger expressions and electrodes.
	#Persistent Functions: There cannot be any train settings (Train frequency and Train repetitions), so the StimulationTriggers must not have those rows.		#Persistent Functions: There cannot be any train settings (Train frequency and Train repetitions), so the StimulationTriggers must not have those rows. Also, StimulationTriggers must not have more than 16 columns, as that is the highest number of configurations that can be stored on the device.

	Persistent Command and Functions modes have a lower latency because the stimulation is pre-uploaded. All modes are available to give you the highest amount of flexiblity with the BIC. [[#Stimulation Latency\|See below for more details on latency.]]		Persistent Command and Functions modes have a lower latency because the stimulation is pre-uploaded. All modes are available to give you the highest amount of flexiblity with the BIC. [[#Stimulation Latency\|See below for more details on latency.]]

Wengelhardt at 21:23, 16 July 2025

2025-07-16T21:23:03Z

← Older revision		Revision as of 21:23, 16 July 2025
Line 116:		Line 116:
	\|style="color:green"\|✔		\|style="color:green"\|✔
	\|-		\|-
	!GND ~~stimulation without destination channel~~		!Monopolar stimulation (Ch → GND)
	\|style="color:red"\|✘		\|style="color:red"\|✘
	\|style="color:green"\|✔		\|style="color:green"\|✔