Contributions:LSLSource - Revision history

Mellinger: /* ChannelNames */

2023-10-14T11:53:13Z

ChannelNames

← Older revision		Revision as of 11:53, 14 October 2023
Line 51:		Line 51:
	===ChannelNames===		===ChannelNames===
	Names of each channel.		Names of each channel.

			===StreamSelectionProperty===
			The property used for stream selection, e.g. 'type', 'name', or 'source_id'.

			===StreamSelectionPropertyValue===
			The desired value of the ''StreamSelectionProperty'', e.g. 'EEG'.

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

Abelsten: /* SourceChGain */

2021-03-10T21:08:20Z

SourceChGain

← Older revision		Revision as of 21:08, 10 March 2021
Line 44:		Line 44:

	===SourceChGain===		===SourceChGain===
	The gain for each channel. If set to "auto", this parameter is 1μV.		The gain for each channel. If set to "auto", this parameter is 1μV. Usually EEG is on the scale of 100's of μV, while EKG is on the order of 1mV.

	===SourceChOffset===		===SourceChOffset===

Abelsten: /* SourceChGain */

2021-03-10T20:57:34Z

SourceChGain

← Older revision		Revision as of 20:57, 10 March 2021
Line 44:		Line 44:

	===SourceChGain===		===SourceChGain===
	The gain for each channel.		The gain for each channel. If set to "auto", this parameter is 1μV.

	===SourceChOffset===		===SourceChOffset===

Abelsten: /* Steps to use LSLSource */

2021-03-10T20:56:28Z

Steps to use LSLSource

← Older revision		Revision as of 20:56, 10 March 2021
Line 22:		Line 22:
	2.Connect your hardware to the PC with BCI2000, and the LSL Application installed. Launch the LSL Application.		2.Connect your hardware to the PC with BCI2000, and the LSL Application installed. Launch the LSL Application.

	3.In the LSL Application, configure the sampling rate, ~~sample block size~~, and ~~channels if necessary~~ and open the connection to hardware. You can now start the LSL stream.		3.In the LSL Application, configure the appropriate hardware parameters, such as sampling rate, number of channels, and filters, and open the connection to hardware. You can now start the LSL stream.

	4.Now launch BCI2000 with LSLSource as the signal acquisition module. Click "Config" and navigate to the "Source" tab. Enter your desired sample block size and other parameters you wish to specify. Note that the "SourceCh" and "SamplingRate" parameters should be set to "auto", as these are configured in the LSL Application.		4.Now launch BCI2000 with LSLSource as the signal acquisition module. Click "Config" and navigate to the "Source" tab. Enter your desired sample block size and other parameters you wish to specify. Note that the "SourceCh" and "SamplingRate" parameters should be set to "auto", as these are configured in the LSL Application.

Abelsten: /* LSLSource */

2021-03-10T17:13:10Z

LSLSource

← Older revision		Revision as of 17:13, 10 March 2021
Line 13:		Line 13:
	===LSLSource===		===LSLSource===

	The "LSLSource" source module uses Labstreaminglayer to acquire data from different hardware, such as OpenBCI, gUSBAmp, and ~~eyes tracker~~. This source module can automatically detect the sampling rate and the number of channels of the input signal and configure the output signal.		The "LSLSource" source module uses Labstreaminglayer to acquire data from different hardware, such as OpenBCI, gUSBAmp, and eye trackers. This source module can automatically detect the sampling rate and the number of channels of the input signal and configure the output signal.

	==Steps to use LSLSource==		==Steps to use LSLSource==

Abelsten: /* Introduction */

2021-03-10T16:51:50Z

Introduction

← Older revision		Revision as of 16:51, 10 March 2021
Line 4:		Line 4:
	==Introduction==		==Introduction==

	===~~LSLSource~~===		===Labstreaminglayer===

	~~"LSLSource" is a source module that uses~~ Labstreaminglayer (LSL) ~~to acquire data from different hardware~~, ~~such as OpenBCI~~, ~~gUSBAmp~~, and ~~eyes tracker. This source module can automatically detect~~ the ~~sampling rate~~ and ~~the number of channels~~ of the ~~input signal~~ and ~~configure the output signal~~.		The Labstreaminglayer (LSL) is a system for the unified collection of measurement time series in research experiments that handles both the networking, time-synchronization, (near-) real-time access, and optionally the centralized collection, viewing and disk recording of the data.
			More information can be found at [https://github.com/sccn/labstreaminglayer/ GitHub README] and [https://labstreaminglayer.readthedocs.io/info/getting_started.html online documentation].

	~~===Labstreaminglayer===~~		A list of LSL supported devices can also be found at this [https://labstreaminglayer.readthedocs.io/info/supported_devices.html link].

	The Labstreaminglayer is a system for the unified collection of measurement time series in research experiments that handles both the networking, time-synchronization, (near-) real-time access, and optionally the centralized collection, viewing and disk recording of the data.		===LSLSource===
	~~More information can be found at [https://github.com/sccn/labstreaminglayer/ GitHub README] and [https://labstreaminglayer.readthedocs.io/info/getting_started.html online documentation].~~

	~~A list~~ of ~~LSL supported devices can also be found at this [https://labstreaminglayer.readthedocs.io/info/supported_devices.html link]~~.		The "LSLSource" source module uses Labstreaminglayer to acquire data from different hardware, such as OpenBCI, gUSBAmp, and eyes tracker. This source module can automatically detect the sampling rate and the number of channels of the input signal and configure the output signal.

	==Steps to use LSLSource==		==Steps to use LSLSource==

Abelsten: /* Steps to use LSLSource */

2021-03-10T16:49:30Z

Steps to use LSLSource

← Older revision		Revision as of 16:49, 10 March 2021
Line 18:		Line 18:
	Using LSL requires that you have both the LSL Application for your hardware installed and BCI2000, as the LSL Application streams data to the LSLSource BCI2000 source module.		Using LSL requires that you have both the LSL Application for your hardware installed and BCI2000, as the LSL Application streams data to the LSLSource BCI2000 source module.

	1.~~Aquire~~ the appropriate LSL Application for your hardware. Information on how to do this can be found on the LSL [https://github.com/sccn/labstreaminglayer/ GitHub].		1.Acquire the appropriate LSL Application for your hardware. Information on how to do this can be found on the LSL [https://github.com/sccn/labstreaminglayer/ GitHub].

	2.Connect your hardware to the PC with BCI2000, and the LSL Application installed. Launch the LSL Application.		2.Connect your hardware to the PC with BCI2000, and the LSL Application installed. Launch the LSL Application.

Abelsten: /* Steps to use LSLSource */

2021-03-10T16:28:17Z

Steps to use LSLSource

← Older revision		Revision as of 16:28, 10 March 2021
Line 26:		Line 26:
	4.Now launch BCI2000 with LSLSource as the signal acquisition module. Click "Config" and navigate to the "Source" tab. Enter your desired sample block size and other parameters you wish to specify. Note that the "SourceCh" and "SamplingRate" parameters should be set to "auto", as these are configured in the LSL Application.		4.Now launch BCI2000 with LSLSource as the signal acquisition module. Click "Config" and navigate to the "Source" tab. Enter your desired sample block size and other parameters you wish to specify. Note that the "SourceCh" and "SamplingRate" parameters should be set to "auto", as these are configured in the LSL Application.

	5.Click "Set Config and start your experiment!		5.Click "Set Config" and start your experiment!

	==Parameters:LSLSource==		==Parameters:LSLSource==

Abelsten at 16:28, 10 March 2021

2021-03-10T16:28:01Z

← Older revision		Revision as of 16:28, 10 March 2021
Line 6:		Line 6:
	===LSLSource===		===LSLSource===

	"LSLSource" is a source module that ~~can use~~ Labstreaminglayer to ~~aquire~~ data from different hardware, such as OpenBCI, ~~USBAmp~~, and eyes tracker. This source module can automatically detect the sampling rate and number of channels of the input signal and configure the output signal.		"LSLSource" is a source module that uses Labstreaminglayer (LSL) to acquire data from different hardware, such as OpenBCI, gUSBAmp, and eyes tracker. This source module can automatically detect the sampling rate and the number of channels of the input signal and configure the output signal.

	===Labstreaminglayer===		===Labstreaminglayer===

	The ~~lab streaming layer (LSL)~~ is a system for the unified collection of measurement time series in research experiments that handles both the networking, time-synchronization, (near-) real-time access ~~as well as~~ optionally the centralized collection, viewing and disk recording of the data.		The Labstreaminglayer is a system for the unified collection of measurement time series in research experiments that handles both the networking, time-synchronization, (near-) real-time access, and optionally the centralized collection, viewing and disk recording of the data.
	More information can be found at [https://github.com/sccn/labstreaminglayer/~~wiki~~/~~ExampleCode~~.~~wiki~~]		More information can be found at [https://github.com/sccn/labstreaminglayer/ GitHub README] and [https://labstreaminglayer.readthedocs.io/info/getting_started.html online documentation].
	~~The Documentation for Labstreaminglayer~~ can be found at [https://~~github~~.~~com/sccn/labstreaminglayer/blob/master/LSL/liblsl~~/~~include~~/~~lsl_c~~.h].
			A list of LSL supported devices can also be found at this [https://labstreaminglayer.readthedocs.io/info/supported_devices.html link].

	==Steps to use LSLSource==		==Steps to use LSLSource==
			Using LSL requires that you have both the LSL Application for your hardware installed and BCI2000, as the LSL Application streams data to the LSLSource BCI2000 source module.

	1.~~Download~~ the ~~merge branch 'master'~~ for ~~the~~ hardware ~~(Applications~~ can be found at [https://github.com/sccn/labstreaminglayer].)		1.Aquire the appropriate LSL Application for your hardware. Information on how to do this can be found on the LSL [https://github.com/sccn/labstreaminglayer/ GitHub].

	2.Connect hardware to ~~your compute~~ and ~~open~~ the ~~application~~.		2.Connect your hardware to the PC with BCI2000, and the LSL Application installed. Launch the LSL Application.

	3.~~Set up~~ sampling rate, sample block size and channels if necessary and open the connection to hardware.		3.In the LSL Application, configure the sampling rate, sample block size, and channels if necessary and open the connection to hardware. You can now start the LSL stream.

	4.~~Open~~ LSLSource and ~~configure~~ the sample block size.		4.Now launch BCI2000 with LSLSource as the signal acquisition module. Click "Config" and navigate to the "Source" tab. Enter your desired sample block size and other parameters you wish to specify. Note that the "SourceCh" and "SamplingRate" parameters should be set to "auto", as these are configured in the LSL Application.

	5.Set ~~configuration~~ and ~~click~~ start.		5.Click "Set Config and start your experiment!

	==Parameters:LSLSource==		==Parameters:LSLSource==
Line 31:		Line 33:

	===SourceCh===		===SourceCh===
	The number of channels ~~will be automatically detected by the source module~~. ~~User doesn't need~~ to ~~set it~~.		The source module will automatically detect the number of channels. Set this parameter to "auto".

	===SampleBlockSize===		===SampleBlockSize===
	Samples per channel per digitized block.		Samples per channel per digitized block.
	~~Together with the sampling rate, this~~ parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 500 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) will be updated 25 times per second.		This parameter determines how often per second data are collected, processed, and feedback is updated with the sampling rate. For example, at 500 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) will be updated 25 times per second.
	~~This variable will change as using different device. User can find the best sampling block size on the hardware spec sheet~~.

	===SamplingRate===		===SamplingRate===
	The sample rate of the system. ~~Different hardware has different sampling rate. This~~ source module can automatically detect the sampling rate ~~for different hardware~~.		The sample rate of the system. Set this parameter to "auto" as the source module can automatically detect the sampling rate.
	The sampling rate should be compatible with sample block size. ~~In case you are experiencing problems by higher~~ sampling ~~rates (e.g.~~, data loss, jerky display, etc.), increase the SampleBlockSize ~~so that you are updating~~ the system less frequently (usually, updating the system 20-30 times per second is sufficient for most applications), and increase Visualize->VisualizeSourceDecimation. This ~~parameter~~ will decrease the number of samples per second that are actually drawn in the Source display.		The sampling rate should be compatible with the sample block size and the computational capabilities of your computer. If your sampling rate is too high and your sample block size is too small, your PC may not be able to keep up with the data acquisition stream, causing data loss, jerky display, etc. If you are experiencing problems like this, increase the SampleBlockSize to update the system less frequently (usually, updating the system 20-30 times per second is sufficient for most applications) and increase Visualize->VisualizeSourceDecimation parameter. This will decrease the number of samples per second that are actually drawn in the Source display.

	===SourceChGain===		===SourceChGain===
	~~Gain~~ for each channel.		The gain for each channel.

	===SourceChOffset===		===SourceChOffset===

Mellinger at 14:14, 29 August 2019

2019-08-29T14:14:12Z

← Older revision		Revision as of 14:14, 29 August 2019
Line 1:		Line 1:
	LSLSource		==Location==
			<tt>/src/contrib/SignalSource/LSLSource</tt>

	==Introduction==		==Introduction==