Contributions:BCI2000PresentationLink - Revision history

Mellinger: /* See also */

2025-06-19T20:39:56Z

Mellinger: /* Source Code Revisions */

2023-04-11T18:20:01Z

Source Code Revisions

← Older revision		Revision as of 18:20, 11 April 2023
Line 15:		Line 15:
	===Source Code Revisions===		===Source Code Revisions===
	*Initial development: BCI2000 r3918; Presentation Version 15 Build 11.15.11		*Initial development: BCI2000 r3918; Presentation Version 15 Build 11.15.11
	*Tested under: BCI2000 ~~37306~~; Presentation Version 23.1 Build 09.29.22		*Tested under: BCI2000 r7306; Presentation Version 23.1 Build 09.29.22

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

Mellinger: /* Source Code Revisions */

2023-04-11T18:19:43Z

Source Code Revisions

← Older revision		Revision as of 18:19, 11 April 2023
Line 15:		Line 15:
	===Source Code Revisions===		===Source Code Revisions===
	*Initial development: BCI2000 r3918; Presentation Version 15 Build 11.15.11		*Initial development: BCI2000 r3918; Presentation Version 15 Build 11.15.11
	*Tested under: BCI2000 ~~r3967~~; Presentation Version 15 Build 11.15.11		*Tested under: BCI2000 37306; Presentation Version 23.1 Build 09.29.22

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

Mellinger: /* State variable access */

2023-04-11T18:12:09Z

State variable access

@@ Line 168: / Line 168: @@
 ====set_state_variable( string name, double value )====
 Sets the value of a BCI2000 state variable.
 ====double get_control_signal( int channel, int element )====
 Returns the value of an element in the control signal. Indices are 1-based.

Swiftj: /* PCL Extension */

2021-09-14T20:45:48Z

PCL Extension

← Older revision		Revision as of 20:45, 14 September 2021
Line 43:		Line 43:
	Alternatively, you may specify the path to a BCI2000 batch file in the BCI2000/batch directory as an argument to the bci2000::controller operator. The path will be interpreted relative to Presentation's working directory:		Alternatively, you may specify the path to a BCI2000 batch file in the BCI2000/batch directory as an argument to the bci2000::controller operator. The path will be interpreted relative to Presentation's working directory:
	bci2000::controller bci = new bci2000::controller( "path\to\bci2000\batch\CursorTask_SignalGenerator.bat" );		bci2000::controller bci = new bci2000::controller( "path\to\bci2000\batch\CursorTask_SignalGenerator.bat" );
	An appropriate batch file should start up Operator and core modules, and needs to forward its command line arguments to the Operator module. All batch files coming with BCI2000 ~~fulfil~~ this condition. When a batch file is specified, there is no need to call the startup_modules() method.		An appropriate batch file should start up Operator and core modules, and needs to forward its command line arguments to the Operator module. All batch files coming with BCI2000 fulfill this condition. When a batch file is specified, there is no need to call the startup_modules() method.

	As yet another option, you may connect to an Operator module that is already running, e.g., on a remote machine on the network. In this case, call the controller's constructor with an appropriate network address and port, i.e. the telnet address the remote Operator module is listening on, i.e. the remote machine's IP address, followed with a colon, and the port specified when starting up the remote Operator module:		As yet another option, you may connect to an Operator module that is already running, e.g., on a remote machine on the network. In this case, call the controller's constructor with an appropriate network address and port, i.e. the telnet address the remote Operator module is listening on, i.e. the remote machine's IP address, followed with a colon, and the port specified when starting up the remote Operator module:

Swiftj: /* Timing Precision */

2021-09-14T20:41:31Z

Timing Precision

← Older revision		Revision as of 20:41, 14 September 2021
Line 27:		Line 27:
	Presentation achieves millisecond-accuracy when measuring the time at which an event has occurred. Unfortunately, this precision does not carry over to BCI2000 because, as stated in the Presentation documentation, the time when Presentation actually reports an event may be delayed by up to 50ms with regard to the time when it occurred. Although a Data Port object is provided with the time stamp of the event's occurrence, this information can not be utilized by BCI2000 because events cannot be dated back in time due to the way they are recorded in BCI2000. Thus, event information in a BCI2000 data file reflects the time when that event was reported to the Data Port object, not the time when its occurrence was detected. Presentation guarantees that the difference between these two time points, i.e. the delay, is below 50ms. Beyond that, they do not make any statement about how delay varies between events (timing jitter). However, in practice, one may assume that timing jitter is low, and that the delay is significantly less than the guaranteed value of 50ms.		Presentation achieves millisecond-accuracy when measuring the time at which an event has occurred. Unfortunately, this precision does not carry over to BCI2000 because, as stated in the Presentation documentation, the time when Presentation actually reports an event may be delayed by up to 50ms with regard to the time when it occurred. Although a Data Port object is provided with the time stamp of the event's occurrence, this information can not be utilized by BCI2000 because events cannot be dated back in time due to the way they are recorded in BCI2000. Thus, event information in a BCI2000 data file reflects the time when that event was reported to the Data Port object, not the time when its occurrence was detected. Presentation guarantees that the difference between these two time points, i.e. the delay, is below 50ms. Beyond that, they do not make any statement about how delay varies between events (timing jitter). However, in practice, one may assume that timing jitter is low, and that the delay is significantly less than the guaranteed value of 50ms.

	On a typical LCD display, frame duration is 1/(60Hz) = 16.7ms. When presenting stimuli on such a display, the delay jitter between Presentation's detection of the stimulus, and BCI2000's recording of the associated event, will be less than the duration of a single display frame, and the absolute value of the delay will correspond to about a single frame. This may be a problem when you need to measure ~~detect~~ features in evoked activity on a time scale below 1/60s, or a frequency scale above 60Hz, which is not the case in most experiments. Also note that the temporal resolution of evoked activity is only affected by jitter, not by the absolute value of the delay. When doing exact latency measurements, you should perform measurements with a light or audio sensor in order to establish an estimate for the delay, so you can correct latency measurements for the delay, as well as for its jitter, to obtain an upper limit for temporal resolution.		On a typical LCD display, frame duration is 1/(60Hz) = 16.7ms. When presenting stimuli on such a display, the delay jitter between Presentation's detection of the stimulus, and BCI2000's recording of the associated event, will be less than the duration of a single display frame, and the absolute value of the delay will correspond to about a single frame. This may be a problem when you need to measure features in evoked activity on a time scale below 1/60s, or a frequency scale above 60Hz, which is not the case in most experiments. Also note that the temporal resolution of evoked activity is only affected by jitter, not by the absolute value of the delay. When doing exact latency measurements, you should perform measurements with a light or audio sensor in order to establish an estimate for the delay, so you can correct latency measurements for the delay, as well as for its jitter, to obtain an upper limit for temporal resolution.

	====Controlling BCI2000====		====Controlling BCI2000====

Nluczak: /* Synopsis */

2021-09-14T19:59:57Z

Synopsis

← Older revision		Revision as of 19:59, 14 September 2021
Line 1:		Line 1:
	==Synopsis==		==Synopsis==
	BCI2000PresentationLink contains two plug-ins for the [~~http~~://www.~~nbs~~.com/ NBS Presentation] stimulus delivery software, a so-called ''DataPort Extension'' which allows to record Presentation events into BCI2000 state variables, and a ''PCL Language Extension'' that allows to control BCI2000 from Presentation scripts written in the PCL language.		BCI2000PresentationLink contains two plug-ins for the [https://www.neurobs.com NBS Presentation] stimulus delivery software, a so-called ''DataPort Extension'' which allows to record Presentation events into BCI2000 state variables, and a ''PCL Language Extension'' that allows to control BCI2000 from Presentation scripts written in the PCL language.

	Before you can use it, BCI2000PresentationLink must be installed on your system, and must be registered with the Presentation software. This is possible even if your user account has no administrative privileges. For details, see the [[#Installation\|Installation]] section below.		Before you can use it, BCI2000PresentationLink must be installed on your system, and must be registered with the Presentation software. This is possible even if your user account has no administrative privileges. For details, see the [[#Installation\|Installation]] section below.

Mellinger: /* Windows installation options */

2021-08-24T15:51:05Z

Windows installation options

@@ Line 105: / Line 105: @@
   regsvr32 /n /u /s /i:both BCI2000PresentationLink.dll
 under all user accounts that may have executed the installation script, and make sure that at least one of those accounts has administrative privileges.
 ==BCI2000PCLLibrary Reference==

Mellinger: /* Windows installation options */

2021-08-24T15:43:11Z

Windows installation options

← Older revision		Revision as of 15:43, 24 August 2021
Line 103:		Line 103:
	*''both'' to install both for all users, and the current user (this option only makes sense for deinstallation).		*''both'' to install both for all users, and the current user (this option only makes sense for deinstallation).
	Note that per-user installation overrides system-wide installation. This may lead to confusing behavior of BCI2000PresentationLink when switching between multiple users, and executing the installation program for those users, or when granting a certain user administrative privileges at one time, and later removing those privileges. To completely remove all references to BCI2000PresentationLink from your machine under such circumstances, execute		Note that per-user installation overrides system-wide installation. This may lead to confusing behavior of BCI2000PresentationLink when switching between multiple users, and executing the installation program for those users, or when granting a certain user administrative privileges at one time, and later removing those privileges. To completely remove all references to BCI2000PresentationLink from your machine under such circumstances, execute
	~~rgsvr32~~ /n /u /s /i:both BCI2000PresentationLink.dll		regsvr32 /n /u /s /i:both BCI2000PresentationLink.dll
	under all user accounts that may have executed the installation script, and make sure that at least one of those accounts has administrative privileges.		under all user accounts that may have executed the installation script, and make sure that at least one of those accounts has administrative privileges.

Mellinger: /* int execute( string command, string byRef output ) */

2013-03-10T13:42:01Z

int execute( string command, string byRef output )

← Older revision		Revision as of 13:42, 10 March 2013
Line 163:		Line 163:
	===Operator scripting===		===Operator scripting===
	====int execute( string command, string byRef output )====		====int execute( string command, string byRef output )====
	Execute an arbitrary BCI2000 scripting command. The meaning of the return value depends on which command has been executed, and is the ''exit code'' of the command, as defined in the ��[[Programming_Reference:BCI2000Remote_Class#bool_Execute.28_string_command.2C_int.2A_exitCode_.3D_0_.29\|BCI2000Remote Class Document]].		Execute an arbitrary BCI2000 scripting command. The meaning of the return value depends on which command has been executed, and is the ''exit code'' of the command, as defined in the [[Programming_Reference:BCI2000Remote_Class#bool_Execute.28_string_command.2C_int.2A_exitCode_.3D_0_.29\|BCI2000Remote Class Document]].

	A full documentation of BCI2000 Operator scripting commands is available under [[User Reference:Operator Module Scripting]].		A full documentation of BCI2000 Operator scripting commands is available under [[User Reference:Operator Module Scripting]].

← Older revision		Revision as of 20:39, 19 June 2025
Line 233:		Line 233:

	==See also==		==See also==
	[[Programming Reference:BCI2000Remote Class]], [[Contributions:BCI2000Automation]], [[Contributions:BCI2000Command]], [[Contributions:BCI2000PythonBindings]],		[[Programming Reference:BCI2000Remote Class]],<!--[[Contributions:BCI2000Automation]],--> [[Contributions:BCI2000Command]], [[Contributions:BCI2000PythonBindings]],
	[[Contributions:Applications]]		[[Contributions:Applications]]

	[[Category:Contributions]][[Category:User Application]][[Category:External Interfaces]]		[[Category:Contributions]][[Category:User Application]][[Category:External Interfaces]]