BCI2000 Wiki - User contributions [en]

User Reference:gNautilus

2015-07-31T19:04:15Z

Kgoering: /* Source Code Revisions */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/g.NautilusSource

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com) University of Kansas

===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: 4928
*Tested under: 4942
*Known to compile under: 4942
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 with 32 bit and newer. g.Nautiulus can only be built using Visual Studio on Windows.

Install g.NEEDaccess_Sever on a 32bit machine. Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilusSource module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving has not been tested. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each device. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation

<math>\lfloor((acceleration + 6) / 12) * 65535\rfloor</math>

Thus if the acceleration was 0 then the state would have the value 32767.

===Counter===
Counter is a value that is constantly increasing in value and then repeats starting at 0. It is stored in Counter1.

===Link Quality===
Link quality is a value between 0 and 100. It is stored in LinkQuality1. When link quality falls bellow 10% the first time, BCI2000 will give a warning.

===Battery Level===
Battery level is a value between 0 and 100. It is stored in Battery1. When battery falls bellow 10%, BCI2000 will give a warning and again when it falls below 5%.

===Digital Input===
Digital input port is on the Base Station. The value is between 0 and 255 and then separated into to a binary number which is then saved in a state with the corresponding number of the bit, i.e. bit 5 is stored in DigitalInput5.

[[File:gNautilusDigitalInput.jpg]]

===Validation Indicator===
Validation indicator is a value of 0 or 1. It is stored in Validation1. If it is 0, then the data may not be valid. If it is 1, the data is valid.

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

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

User Reference:gNautilus

2015-07-31T19:02:51Z

Kgoering: /* Functional Description */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/g.NautilusSource

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com) University of Kansas

===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 with 32 bit and newer. g.Nautiulus can only be built using Visual Studio on Windows.

Install g.NEEDaccess_Sever on a 32bit machine. Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilusSource module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving has not been tested. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each device. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation

<math>\lfloor((acceleration + 6) / 12) * 65535\rfloor</math>

Thus if the acceleration was 0 then the state would have the value 32767.

===Counter===
Counter is a value that is constantly increasing in value and then repeats starting at 0. It is stored in Counter1.

===Link Quality===
Link quality is a value between 0 and 100. It is stored in LinkQuality1. When link quality falls bellow 10% the first time, BCI2000 will give a warning.

===Battery Level===
Battery level is a value between 0 and 100. It is stored in Battery1. When battery falls bellow 10%, BCI2000 will give a warning and again when it falls below 5%.

===Digital Input===
Digital input port is on the Base Station. The value is between 0 and 255 and then separated into to a binary number which is then saved in a state with the corresponding number of the bit, i.e. bit 5 is stored in DigitalInput5.

[[File:gNautilusDigitalInput.jpg]]

===Validation Indicator===
Validation indicator is a value of 0 or 1. It is stored in Validation1. If it is 0, then the data may not be valid. If it is 1, the data is valid.

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

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

User Reference:gNautilus

2015-07-31T16:03:24Z

Kgoering: /* Location */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/g.NautilusSource

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com) University of Kansas

===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 and newer versions. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilusSource module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving has not been tested. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each device. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation

<math>\lfloor((acceleration + 6) / 12) * 65535\rfloor</math>

Thus if the acceleration was 0 then the state would have the value 32767.

===Counter===
Counter is a value that is constantly increasing in value and then repeats starting at 0. It is stored in Counter1.

===Link Quality===
Link quality is a value between 0 and 100. It is stored in LinkQuality1. When link quality falls bellow 10% the first time, BCI2000 will give a warning.

===Battery Level===
Battery level is a value between 0 and 100. It is stored in Battery1. When battery falls bellow 10%, BCI2000 will give a warning and again when it falls below 5%.

===Digital Input===
Digital input port is on the Base Station. The value is between 0 and 255 and then separated into to a binary number which is then saved in a state with the corresponding number of the bit, i.e. bit 5 is stored in DigitalInput5.

[[File:gNautilusDigitalInput.jpg]]

===Validation Indicator===
Validation indicator is a value of 0 or 1. It is stored in Validation1. If it is 0, then the data may not be valid. If it is 1, the data is valid.

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

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

User Reference:gNautilus

2015-07-31T15:48:52Z

Kgoering: /* Author */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/gNautilus

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com) University of Kansas

===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 and newer versions. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilusSource module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving has not been tested. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each device. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation

<math>\lfloor((acceleration + 6) / 12) * 65535\rfloor</math>

Thus if the acceleration was 0 then the state would have the value 32767.

===Counter===
Counter is a value that is constantly increasing in value and then repeats starting at 0. It is stored in Counter1.

===Link Quality===
Link quality is a value between 0 and 100. It is stored in LinkQuality1. When link quality falls bellow 10% the first time, BCI2000 will give a warning.

===Battery Level===
Battery level is a value between 0 and 100. It is stored in Battery1. When battery falls bellow 10%, BCI2000 will give a warning and again when it falls below 5%.

===Digital Input===
Digital input port is on the Base Station. The value is between 0 and 255 and then separated into to a binary number which is then saved in a state with the corresponding number of the bit, i.e. bit 5 is stored in DigitalInput5.

[[File:gNautilusDigitalInput.jpg]]

===Validation Indicator===
Validation indicator is a value of 0 or 1. It is stored in Validation1. If it is 0, then the data may not be valid. If it is 1, the data is valid.

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

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

Contributions:ADCs

2015-07-31T15:48:21Z

Kgoering:

The following data acquisition filters are available in the [[Contributions:Contents|Contributions]] section of BCI2000:

*[[Contributions:AmpServerProADC]]: Interface to the EGI AmpServerPro.
*[[Contributions:BioRadioADC]]: Interface to the BioRadio amplifer.
*[[Contributions:Biosemi2ADC]]: Interface to the Biosemi amplifier.
*[[Contributions:Blackrock]]: Interface Blackrock devices through CereLink.
*[[Contributions:B-Alert]]: Interface to B-Alert brain monitoring systems.
*[[Contributions:DAS_ADC]]: Interface to MeasurementComputing AD cards.
*[[Contributions:DTADC]]: Interface to Data Translation boards.
*[[Contributions:Emotiv]]: Interface to the Emotiv EPOC.
*[[Contributions:FieldTripBufferSource]]: Interface to the FieldTrip buffer.
*[[Contributions:FilePlayback]]: A source module that replays sessions from recorded data files.
*[[Contributions:gHIamp]]: Interface to the gHIamp.
*[[Contributions:gNautilus]]: Interface to the gNautilus bypassing the server
*[[Contributions:gNautilusNEEDAccess]]: Interface to the gNautilus via g.NEEDAccess.
*[[Contributions:MicromedADC]]: Interface to the Micromed EEG system.
*[[Contributions:ModularEEG]]: Interface to the ModularEEG system.
*[[Contributions:Neuralynx]]: Interface to Neuralynx systems
*[[Contributions:NIADC]]: Interface to National Instruments boards.
*[[Contributions:NIDAQ-MX]]: Interface to National Instruments boards using the MX driver.
*[[Contributions:NIDAQLogger]]: Interface to multiple National Instruments DAQ boards using MX driver (INPUT ONLY).
*[[Contributions:NIDAQFilter]]: Interface to multiple National Instruments DAQ boards using MX driver (OUTPUT ONLY).
*[[Contributions:NeuroscanADC]]: Neuroscan Acquire socket protocol client.
*[[Contributions:NeuroscanAccessSDK]]: Interface to Neuroscan Direct Access SDK.
*[[Contributions:NeuroSky]]: Interface to Neurosky MindSet.
*[[Contributions:NicoletOne]]: Interface to NicoletOne nEEG series amplifiers.
*[[Contributions:ctfneurod]]: CTF RealTime to Neuroscan Acquire relay.
*[[Contributions:RDAClientADC]]: Brain Vision RDA socket protocol client.
*[[Contributions:TDTADC]]: Interface to Tucker-Davis Pentusa systems.
*[[Contributions:TMSiADC]]: Interface to TMSi Refa and Porti systems.
*[[Contributions:vAmpADC]]: Interface to Brain Products V-amp systems.
*[[Contributions:EnobioADC]]: Interface to Enobio sensor.
*[[Contributions:DSISerial]]: Interface to Dry Sensor Interface (DSI) EEG systems by Wearable Sensing.
*[[Contributions:MicRecorderFilter]]: Interface to the system soundcard, logging audio input.

==See also==
[[User Reference:Filters]], [[Contributions:How to use a Contributed Source Module]]

[[Category:Contents]][[Category:Data Acquisition]]

User Reference:gNautilus

2015-07-31T15:46:57Z

Kgoering: /* Functional Description */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/gNautilus

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 and newer versions. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilusSource module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving has not been tested. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each device. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation

<math>\lfloor((acceleration + 6) / 12) * 65535\rfloor</math>

Thus if the acceleration was 0 then the state would have the value 32767.

===Counter===
Counter is a value that is constantly increasing in value and then repeats starting at 0. It is stored in Counter1.

===Link Quality===
Link quality is a value between 0 and 100. It is stored in LinkQuality1. When link quality falls bellow 10% the first time, BCI2000 will give a warning.

===Battery Level===
Battery level is a value between 0 and 100. It is stored in Battery1. When battery falls bellow 10%, BCI2000 will give a warning and again when it falls below 5%.

===Digital Input===
Digital input port is on the Base Station. The value is between 0 and 255 and then separated into to a binary number which is then saved in a state with the corresponding number of the bit, i.e. bit 5 is stored in DigitalInput5.

[[File:gNautilusDigitalInput.jpg]]

===Validation Indicator===
Validation indicator is a value of 0 or 1. It is stored in Validation1. If it is 0, then the data may not be valid. If it is 1, the data is valid.

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

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

User Reference:gNautilus

2015-07-31T15:36:51Z

Kgoering: /* Digital Input */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/gNautilus

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 and newer versions. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilus source module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving has not been tested. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each device. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation

<math>\lfloor((acceleration + 6) / 12) * 65535\rfloor</math>

Thus if the acceleration was 0 then the state would have the value 32767.

===Counter===
Counter is a value that is constantly increasing in value and then repeats starting at 0. It is stored in Counter1.

===Link Quality===
Link quality is a value between 0 and 100. It is stored in LinkQuality1. When link quality falls bellow 10% the first time, BCI2000 will give a warning.

===Battery Level===
Battery level is a value between 0 and 100. It is stored in Battery1. When battery falls bellow 10%, BCI2000 will give a warning and again when it falls below 5%.

===Digital Input===
Digital input port is on the Base Station. The value is between 0 and 255 and then separated into to a binary number which is then saved in a state with the corresponding number of the bit, i.e. bit 5 is stored in DigitalInput5.

[[File:gNautilusDigitalInput.jpg]]

===Validation Indicator===
Validation indicator is a value of 0 or 1. It is stored in Validation1. If it is 0, then the data may not be valid. If it is 1, the data is valid.

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

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

User Reference:gNautilus

2015-07-31T15:36:41Z

Kgoering: /* Digital Input */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/gNautilus

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 and newer versions. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilus source module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving has not been tested. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each device. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation

<math>\lfloor((acceleration + 6) / 12) * 65535\rfloor</math>

Thus if the acceleration was 0 then the state would have the value 32767.

===Counter===
Counter is a value that is constantly increasing in value and then repeats starting at 0. It is stored in Counter1.

===Link Quality===
Link quality is a value between 0 and 100. It is stored in LinkQuality1. When link quality falls bellow 10% the first time, BCI2000 will give a warning.

===Battery Level===
Battery level is a value between 0 and 100. It is stored in Battery1. When battery falls bellow 10%, BCI2000 will give a warning and again when it falls below 5%.

===Digital Input===
Digital input port is on the Base Station. The value is between 0 and 255 and then separated into to a binary number which is then saved in a state with the corresponding number of the bit, i.e. bit 5 is stored in DigitalInput5.
[[File:gNautilusDigitalInput.jpg]]

===Validation Indicator===
Validation indicator is a value of 0 or 1. It is stored in Validation1. If it is 0, then the data may not be valid. If it is 1, the data is valid.

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

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

File:GNautilusDigitalInput.jpg

2015-07-31T15:35:55Z

Kgoering: The pin assignment of the digital input for the g.Nautilus device.

The pin assignment of the digital input for the g.Nautilus device.

User Reference:gNautilus

2015-07-31T15:24:54Z

Kgoering: /* Parameters */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/gNautilus

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 and newer versions. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilus source module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving has not been tested. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each device. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation

<math>\lfloor((acceleration + 6) / 12) * 65535\rfloor</math>

Thus if the acceleration was 0 then the state would have the value 32767.

===Counter===
Counter is a value that is constantly increasing in value and then repeats starting at 0. It is stored in Counter1.

===Link Quality===
Link quality is a value between 0 and 100. It is stored in LinkQuality1. When link quality falls bellow 10% the first time, BCI2000 will give a warning.

===Battery Level===
Battery level is a value between 0 and 100. It is stored in Battery1. When battery falls bellow 10%, BCI2000 will give a warning and again when it falls below 5%.

===Digital Input===
Digital input port is on the Base Station. The value is between 0 and 255 and then separated into to a binary number which is then saved in a state with the corresponding number of the bit, i.e. bit 5 is stored in DigitalInput5.

===Validation Indicator===
Validation indicator is a value of 0 or 1. It is stored in Validation1. If it is 0, then the data may not be valid. If it is 1, the data is valid.

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

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

User Reference:gNautilus

2015-07-31T15:24:25Z

Kgoering: /* Parameters */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/gNautilus

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 and newer versions. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilus source module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving has not been tested. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each amp. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation

<math>\lfloor((acceleration + 6) / 12) * 65535\rfloor</math>

Thus if the acceleration was 0 then the state would have the value 32767.

===Counter===
Counter is a value that is constantly increasing in value and then repeats starting at 0. It is stored in Counter1.

===Link Quality===
Link quality is a value between 0 and 100. It is stored in LinkQuality1. When link quality falls bellow 10% the first time, BCI2000 will give a warning.

===Battery Level===
Battery level is a value between 0 and 100. It is stored in Battery1. When battery falls bellow 10%, BCI2000 will give a warning and again when it falls below 5%.

===Digital Input===
Digital input port is on the Base Station. The value is between 0 and 255 and then separated into to a binary number which is then saved in a state with the corresponding number of the bit, i.e. bit 5 is stored in DigitalInput5.

===Validation Indicator===
Validation indicator is a value of 0 or 1. It is stored in Validation1. If it is 0, then the data may not be valid. If it is 1, the data is valid.

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

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

User Reference:gNautilus

2015-07-31T15:23:33Z

Kgoering: /* Digital Input */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/gNautilus

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 and newer versions. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilus source module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving is not yet supported by the module OR the g.HIamp C API. -- This parameter only exists for future compatibility. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each amp. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation

<math>\lfloor((acceleration + 6) / 12) * 65535\rfloor</math>

Thus if the acceleration was 0 then the state would have the value 32767.

===Counter===
Counter is a value that is constantly increasing in value and then repeats starting at 0. It is stored in Counter1.

===Link Quality===
Link quality is a value between 0 and 100. It is stored in LinkQuality1. When link quality falls bellow 10% the first time, BCI2000 will give a warning.

===Battery Level===
Battery level is a value between 0 and 100. It is stored in Battery1. When battery falls bellow 10%, BCI2000 will give a warning and again when it falls below 5%.

===Digital Input===
Digital input port is on the Base Station. The value is between 0 and 255 and then separated into to a binary number which is then saved in a state with the corresponding number of the bit, i.e. bit 5 is stored in DigitalInput5.

===Validation Indicator===
Validation indicator is a value of 0 or 1. It is stored in Validation1. If it is 0, then the data may not be valid. If it is 1, the data is valid.

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

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

User Reference:gNautilus

2015-07-31T15:21:30Z

Kgoering: /* Trigger Channels */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/gNautilus

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 and newer versions. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilus source module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving is not yet supported by the module OR the g.HIamp C API. -- This parameter only exists for future compatibility. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each amp. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation

<math>\lfloor((acceleration + 6) / 12) * 65535\rfloor</math>

Thus if the acceleration was 0 then the state would have the value 32767.

===Counter===
Counter is a value that is constantly increasing in value and then repeats starting at 0. It is stored in Counter1.

===Link Quality===
Link quality is a value between 0 and 100. It is stored in LinkQuality1. When link quality falls bellow 10% the first time, BCI2000 will give a warning.

===Battery Level===
Battery level is a value between 0 and 100. It is stored in Battery1. When battery falls bellow 10%, BCI2000 will give a warning and again when it falls below 5%.

===Digital Input===

===Validation Indicator===
Validation indicator is a value of 0 or 1. It is stored in Validation1. If it is 0, then the data may not be valid. If it is 1, the data is valid.

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

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

User Reference:gNautilus

2015-07-31T15:15:46Z

Kgoering: /* Acceleration */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/gNautilus

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 and newer versions. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilus source module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving is not yet supported by the module OR the g.HIamp C API. -- This parameter only exists for future compatibility. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each amp. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation

<math>\lfloor((acceleration + 6) / 12) * 65535\rfloor</math>

Thus if the acceleration was 0 then the state would have the value

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

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

User Reference:gNautilus

2015-07-31T15:13:58Z

Kgoering: /* Acceleration */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/gNautilus

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 and newer versions. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilus source module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving is not yet supported by the module OR the g.HIamp C API. -- This parameter only exists for future compatibility. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each amp. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation
<math>acceleration + 6 / 12 * 65535</math>

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

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

User Reference:gNautilus

2015-07-31T15:13:42Z

Kgoering: /* Trigger Channels */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/gNautilus

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 and newer versions. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilus source module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving is not yet supported by the module OR the g.HIamp C API. -- This parameter only exists for future compatibility. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each amp. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation
<math>acceleration + 6 / 12 * 65535<\math>

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

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

User Reference:gNautilus

2015-07-31T15:12:57Z

Kgoering: /* Future Work */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/gNautilus

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 and newer versions. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilus source module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving is not yet supported by the module OR the g.HIamp C API. -- This parameter only exists for future compatibility. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each amp. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Trigger Channels==
===Acceleration===
Acceleration is stored in three separate states with the axis labeled, i.e. the acceleration on the x-axis is stored in AccelerationX1.
The g.Nautilus records the acceleration between -6g and 6g. It is then translated into a value between 0 and 65535 with the equation
math{acceleration + 6 / 12 * 65535}

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

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

User Reference:gNautilus

2015-07-31T15:09:16Z

Kgoering: /* Parameters */

==Synopsis==
The g.Nautilus is a biopotential amplifier with wireless transmission technology with either wet or dry electrodes. It reads in up to 32 signal channels and 8 trigger channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/core/SignalSource/gNautilus

==Versioning==
===Author===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
Version 1.0: July 2015
*Supports a single g.Nautilus
*Referencing by any channel
*Supports filters
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of right now, g.Nautilus is only supported by Windows 7 and newer versions. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilus source module.

==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. 
** '''NOTE:''' 25 and up found to work best during testing for 250Hz
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only the following sample rates are currently supported by the API: 250Hz and 500Hz.
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDMaster''' is the serial number identifier of the master g.Nautilus device. This serial can be found on the physical device and is typically in a "'''NB-20XX.XX.XX'''" format. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine.
* '''DeviceIDs''' is a list of device serials (typically in "'''NB-20XX.XX.XX'''" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "'''auto'''" if there is only one g.Nautilus device connected to the machine. 
** '''NOTE:''' Device slaving is not yet supported by the module OR the g.HIamp C API. -- This parameter only exists for future compatibility. 
* '''RefChList''' is a list of channels which can act as "Reference" channels for each amp. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output. 
** '''NOTE:''' If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. 
* '''SourceChList'''
* '''FilterEnabled'''
* '''FilterHighPass'''
* '''FilterLowPass'''
* '''FilterModelOrder'''
* '''FilterType'''
* '''NotchEnabled'''
* '''NotchHighPass'''
* '''NotchLowPass'''
* '''NotchModelOrder'''
* '''NotchType'''
* '''SourceBufferSize'''
* '''EnableAccelerationData''' is a toggle button to enable acceleration data and store them in synchronous states AccelerationX1, AcceleratioY1, and AccelerationZ1.
** '''NOTE''' To record acceleration data, at least one analog channel must also be recorded. 
* '''EnableCounterInput''' is a toggle button to enable the counter data and store it in the synchronous state Counter1.
** '''NOTE''' To record counter data, at least one analog channel must also be recorded. 
* '''EnableLinkQuality''' is a toggle button to enable the link quality data and store it in the synchronous state LinkQuality1.
** '''NOTE''' To record link quality data, at least one analog channel must also be recorded. 
* '''EnableBatteryLevel''' is a toggle button to enable the battery level data and store it in the synchronous state Battery1.
** '''NOTE''' To record battery level data, at least one analog channel must also be recorded. 
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports and store them in synchronous states DigitalInput1 - DigitalInput8.
** '''NOTE''' To record digital input, at least one analog channel must also be recorded. 
* '''EnableValidationIndicator''' is a toggle button to enable validation data and store it in the synchronous state Validation1.
** '''NOTE''' To record validation data, at least one analog channel must also be recorded. 

==Future Work==
*Autoconfiguration!
*Parametrization of Sensitivity
*Selective Channel Acquisition
*Digital Input as States
*Head Mounted Accelerometer input as States
*Signal quality indicator states
*Battery life check
*BCI2000 Integrated impedance check mode
==See also==
[[User Reference:Filters]], [[Contributions:ADCs]]

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

User Reference:gNautilus

2015-07-31T14:58:56Z

Kgoering: /* Functional Description */

User Reference:gNautilus

2015-07-31T14:58:39Z

Kgoering: /* Functional Description */

User Reference:gNautilus

2015-07-31T14:56:44Z

Kgoering: /* Versioning */

User Reference:gNautilus

2015-07-31T14:54:54Z

Kgoering: /* Location */

User Reference:gNautilus

2015-07-31T14:54:40Z

Kgoering: /* Synopsis */

Contributions:gNautilusNEEDAccess

2015-07-31T14:50:47Z

Kgoering: Created page with "==Synopsis== The g.Nautilus acquisition module enables signal acquisition from the g.Nautilus device via the g.NEEDaccess API. ==Location== http://{{SERVERNAME}}/svn/trunk/sr..."

==Synopsis==
The g.Nautilus acquisition module enables signal acquisition from the g.Nautilus device via the g.NEEDaccess API.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/gNautilus

==Versioning==
===Author===
Griffin Milsap (griffin.milsap@gmail.com)
===Version History===
*V0.5 -- Analog Signal Acquisition
===Source Code Revisions===
*Initial development: 4727
*Tested under: 4727
*Known to compile under: 4727
*Broken since: N/A

==Functional Description==
The g.Nautilus is a wireless headset by g.tec, and is the first in their product line to use g.NEEDaccess exclusively for realtime access. This documentation explains the parameterization and specifics on how to set up the system.

'''NOTE:''' As of the time of writing, this module is at release V0.5. As such, it is not necessarily feature complete. The current g.NEEDAccess API BETA 7XX has not implemented all functionality that will eventually be supported in this module. Also, timing is pretty awful. As of right now, the acquisition module is not recommended for real-time closed-loop use with BCI2000.

===Configuration===
Install g.NEEDAccess on your machine, along with necessary g.tec drivers. Ensure the GDSDataServer is running by checking in services.msc. You'll need your HASP dongle in order to to access g.NEEDAccess[http://www.reactiongifs.com/r/fgwtf.gif .]

'''NOTE:''' As of right now, g.NEEDAccess BETA 7XX appears to only support Windows 7+ 64 bit operating systems. As such, a 64 bit build of BCI2000 is required to make the g.Nautilus binary. g.Nautiulus can only be built using Visual Studio on Windows.

Ensure the device is charged and connected to the base station (refer to the included documentation for help with this). Start BCI2000 with the gNautilus source module.

==Parameters==
The following parameters are available for configuring the Blackrock source module. You will find these parameters in the Source -- Signal Properties section.

===SourceCh===
The g.Nautilus claims to support 64 channels via its API. The module has only been tested up to 32 channels.

'''NOTE:''' If less than 32 channels are acquired, only the first SourceCh channels will be acquired from.

===SamplingRate===
Only the following sample rates are currently supported by the API: 250 Hz and 500 Hz.

===SampleBlockSize===
Sample block size must be set to an integer multiple of the minimum sample block size corresponding to the current SamplingRate.

'''NOTE:''' As of V0.5, and g.NEEDAccess BETA 7XX, a SampleBlockSize set to the minimum block size results in non-realtime operation. Please specify a multiple of at least 2 * minimum block size.

*250 Hz -- 8 samples per block (block length of 32 ms, system clocked at 31.25 Hz)
*500 Hz -- 15 samples per block (block length of 30 ms, system clocked at 33.33 Hz)

===ChannelNames===
Leave this blank and channels are numbered. See Operator Log for information about correct channel names.

===HostIP, HostPort, LocalIP, LocalPort===
This defines the UDP connection to the GDSDataServer. If the service is running on your machine (see services.msc), the GDSDataServer will be listening to UDP packets on port 50223 (Default) at localhost (127.0.0.1). By default, the server will send messages to the listening process (localhost -- 127.0.0.1) on port 50224. The defaults here will be used in most circumstances. Consult your network administrator if your acquisition system is different.

'''NOTE:''' Ensure UDP communications on port 50223 and 50224 are unblocked and uninterrupted by any firewalls between the server and the client.

===NautilusSN===
This is the "name" of the device to acquire from. The serial number on the base-station is used here (Format: NB-20XX.YY.ZZ). Check the operator log for discovered devices and troubleshooting hints.

===NetworkChannel===
Channels 11-18 are available for communicating with several g.Nautilus devices in the same room. In order to ensure uninterrupted connections, use different NetworkChannel settings for each g.Nautilus in the room.

==Future Work==
*Autoconfiguration!
*Parametrization of Sensitivity
*Selective Channel Acquisition
*Digital Input as States
*Head Mounted Accelerometer input as States
*Signal quality indicator states
*Battery life check
*BCI2000 Integrated impedance check mode
==See also==
[[User Reference:Filters]], [[Contributions:ADCs]]

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

Contributions:ADCs

2015-07-31T14:50:33Z

Kgoering:

The following data acquisition filters are available in the [[Contributions:Contents|Contributions]] section of BCI2000:

*[[Contributions:AmpServerProADC]]: Interface to the EGI AmpServerPro.
*[[Contributions:BioRadioADC]]: Interface to the BioRadio amplifer.
*[[Contributions:Biosemi2ADC]]: Interface to the Biosemi amplifier.
*[[Contributions:Blackrock]]: Interface Blackrock devices through CereLink.
*[[Contributions:B-Alert]]: Interface to B-Alert brain monitoring systems.
*[[Contributions:DAS_ADC]]: Interface to MeasurementComputing AD cards.
*[[Contributions:DTADC]]: Interface to Data Translation boards.
*[[Contributions:Emotiv]]: Interface to the Emotiv EPOC.
*[[Contributions:FieldTripBufferSource]]: Interface to the FieldTrip buffer.
*[[Contributions:FilePlayback]]: A source module that replays sessions from recorded data files.
*[[Contributions:gHIamp]]: Interface to the gHIamp.
*[[Contributions:gNautilusNEEDAccess]]: Interface to the gNautilus via g.NEEDAccess.
*[[Contributions:MicromedADC]]: Interface to the Micromed EEG system.
*[[Contributions:ModularEEG]]: Interface to the ModularEEG system.
*[[Contributions:Neuralynx]]: Interface to Neuralynx systems
*[[Contributions:NIADC]]: Interface to National Instruments boards.
*[[Contributions:NIDAQ-MX]]: Interface to National Instruments boards using the MX driver.
*[[Contributions:NIDAQLogger]]: Interface to multiple National Instruments DAQ boards using MX driver (INPUT ONLY).
*[[Contributions:NIDAQFilter]]: Interface to multiple National Instruments DAQ boards using MX driver (OUTPUT ONLY).
*[[Contributions:NeuroscanADC]]: Neuroscan Acquire socket protocol client.
*[[Contributions:NeuroscanAccessSDK]]: Interface to Neuroscan Direct Access SDK.
*[[Contributions:NeuroSky]]: Interface to Neurosky MindSet.
*[[Contributions:NicoletOne]]: Interface to NicoletOne nEEG series amplifiers.
*[[Contributions:ctfneurod]]: CTF RealTime to Neuroscan Acquire relay.
*[[Contributions:RDAClientADC]]: Brain Vision RDA socket protocol client.
*[[Contributions:TDTADC]]: Interface to Tucker-Davis Pentusa systems.
*[[Contributions:TMSiADC]]: Interface to TMSi Refa and Porti systems.
*[[Contributions:vAmpADC]]: Interface to Brain Products V-amp systems.
*[[Contributions:EnobioADC]]: Interface to Enobio sensor.
*[[Contributions:DSISerial]]: Interface to Dry Sensor Interface (DSI) EEG systems by Wearable Sensing.
*[[Contributions:MicRecorderFilter]]: Interface to the system soundcard, logging audio input.

==See also==
[[User Reference:Filters]], [[Contributions:How to use a Contributed Source Module]]

[[Category:Contents]][[Category:Data Acquisition]]

Contributions:ParallelPortFilter

2015-07-01T15:41:36Z

Kgoering: /* Example Configurations */

==Location==
http://{{SERVERNAME}}/svn/trunk/src/contrib/Extensions/ParallelPortFilter

==Versioning==

===Authors===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)

===Version History===
* 2015/06/30: Initial public release

===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Functional Description==
This simple filter extension resides in the Application module and makes input and output with the parallel port easy. The inputs are stored as states ParallelPortInput1 - ParallelPortInput24 based off the number of ports connected. For more information, see [[:Contributions:ParallelPortFilter#States|States]].

==Integration into BCI2000==
Compile the extension into your source module by enabling contributed extensions in your CMake configuration. You can do this by going into your root build folder and deleting <code>CMakeCache.txt</code> and re-running the project batch file, or by running <code>cmake -i</code> and enabling '''BUILD_PARALLELPORTFILTER'''. Once the extension is built into the source module, it can be used.

==Configuring ParallelPortFiler==
If using the filter, SourcePorts must have a number greater than 0. Then list the names for the ports separated by spaces in SourcePortsList. The list must be the same length as the value in SourcePorts. You can then set the LPTMapping with column one in using the names as in SourcePortsList and column 2 using the corresponding hardware address. This step is optional. If not configured, LPT1 maps to 0x378 and LPT2 maps to 0x278 which should work for most users. DigitalOutputEx is only necessary if user wants to write output through the parallel port.

If the default settings for LPTMapping did not produce results, the hardware address might be different for the user's computer. To find the hardware address for the parallel ports for your machine, press '''WIN''' + '''R''' and enter ''devmgmt.msc''. In Device Manager, expand the section labeled '''Ports (Com & LPT)'''. If this section does not exist, you probably do not have LPT ports or the driver is not installed properly. Find the one labeled with (LPT1) or whatever port you are looking for. Right click and select Properties. In the Resources tab, there is a field called I/O Range and take the first value of the range which is in hexadecimal. If multiple I/O Range, read the first one; if that does not work, try the other one. Take that value as the hardware address for Parameter LPTMapping. These instructions for finding the address has been tested on Windows XP, 7, and 8.

[[File:ParallelPortAddress.JPG]]

For some examples on configurations, see [[:Contributions:ParallelPortFilter#Example Configurations|Example Configurations]].

For better explanation of the parameters, see [[:Contributions:ParallelPortFilter#Parameters|Parameters]].

==Parameters==
The ParallelPortFilter is configured in the ParallelPort tab. The configurable parameters are:

===SourcePorts===
This parameter is used to initialize the filter and to keep track of the number of ports being used. This number should be the total number of parallel ports that should be used to communicate. It should be an integer value greater than 0 if being used else 0. Most computers do not have more than 3 parallel ports but some have 4. In good practice this value should not be greater than 3 unless you are sure you have that many ports.

===SourcePortsList===
This parameter lists the ports to be used and the order to communicate through them. It should be a list of the port names LPT1 - LPT3. You can not use the same port twice in on list. This list must be the same length as the value in Parameter SourcePorts.

===LPTMapping===
This parameter is to manually enter the hardware address of the ports incase that the computer being used does not conform to general use hardware addresses. Column one should have the names of the ports such as LPT1 or LPT2, same as the values in Parameter SourcePortsList, and column two should have the hexadecimal value of the port such as 0x378. The number of rows in the matrix should be equal to the value in Parameter SourcePorts, while it must have two columns if being used, no more, no less.

===DigitalOutputEx===
This matrix of expressions that controls the outputs on the parallel ports. Each port has 8 bits which correspond to 8 rows on the matrix. If the expression evaluates to True, the bit will be set to 1 else to 0. Boolean expression work quite well here. For more information on digital output and expressions usage for ParallelPortFilter see [[::Contributions:ParallelPortFilter#Digital Output|Digital Output]].

==Digital Output==
Each port has 8 bits that can be written to. These bits can be accessed through the Parameter DigitalOutputEx. The user must write expressions for each individual bit on each port. The row label corresponds to which bit it will be written to. If multiple ports are enabled, row 1 - 8 correspond to the bits 1 - 8 on the first port and row 9 - 16 correspond to the bits 1 - 8 on the second port and so on. Expressions that evaluate to True set the corresponding bit to 1 and those that evaluate to False set the corresponding bit to 0.

In the case that the user wishes to send an signal or a value through the port, the user must convert the number into binary and write the corresponding zeroes and ones to the respective bits. To do that, the formula:

<code>mod((floor(x / 2 ^(bitnumber - 1))), 2)</code>

The x is the signal the user wishes to send through the port. For example if the State MousePosX was to be sent through the port, the Parameter DigitalOutputEx would be:

[[File:ParallelPortFilterDigitalOutExBinary.jpg]]

<code>State("MousePosX") / State("MousePosX") * 255</code> normalizes the coordinates to fit into eight bits which is all parallel ports can handle.

Not all rows have to be created. Any row not named just writes the bit as 0. The rows also can be written in whatever order if you just change the row label in the parameter. The example below just sets bit 1 and 5 to 1. All other rows are zeroes.

[[File:ParallelPortFilterRowLabelChange.jpg]]

For more on expressions, see [[:User Reference:Expression Syntax|Expressions]].

==States==
For each port there is 8 input bits which correspond to 8 ParallelPortInput states. Each state is either a 0 or a 1. If multiple ports are enabled, ParallelPortInput1 - ParallelPortInput8 correspond to the bits 1 - 8 on the first port and ParallelPortInput9 - ParallelPortInput16 correspond to the bits 1 - 8 on the second port and so on. Currently only 3 ports may be enabled, which should be more than enough for most computers do not have more than port LPT1 - LPT3.

==Example Configurations==
This example enables port LPT1 with a new hardware address.

[[File:ParallelPortFilterNewAddress.jpg|1000px]]

This example enables ports with names MRIScanner and StimulusDevice with hardware addresses. Note that the address for the ports are the same as the default values for LPT1 and LPT2. This shows that LPT names can be renamed in the Parameter Configuration to make it easier to read. This does not change the names of the addresses given by the computer itself.

[[File:ParallelPortFilterNewNames.jpg|1000px]]

==See also==
[[User Reference:Logging Input]], [[Contributions:Extensions]]

[[Category:Contributions]][[Category:Extension]]

Contributions:EyetrackerLoggerTobiiX

2015-07-01T15:29:51Z

Kgoering: Created page with "==Synopsis== A filter that records state information from ''Tobii Eyetrackers Eye X'' into state variables. ==Location== http://{{SERVERNAME}}/svn/trunk/src/contrib/Extension..."

==Synopsis==
A filter that records state information from ''Tobii Eyetrackers Eye X'' into state variables.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/contrib/Extensions/EyetrackerLoggerTobiiX

==Versioning==
===Authors===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
: Initial public release;
2015/07/01
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Functional Description==
In many cases, an experiment may require data about where the participant is looking. In these experiments, an eyetracker is the only way to gather data relating to gaze position and eye location. There are many eyetracking methods currently on the market, but many of these require the subject to hold their head steady -- often while strapped to a structure of some sort. The Tobii eyetrackers require no such restriction so they were a natural choice when it came to interfacing with BCI2000.

==Integration into BCI2000==
Compile the extension into your source module by enabling contributed extensions in your CMake configuration. You can do this by going into your root build folder and deleting <code>CMakeCache.txt</code> and re-running the project batch file, or by running <code>cmake -i</code> and enabling '''BUILD_EYETRACKERLOGGERTOBIIX'''. Once the extension is built into the source module, enable it by starting the source module with the <code>--LogEyetrackerTobiiX=1</code> command line argument.

==Usage and Calibration==
Set up the eyetracker as detailed in the documentation that came with your device. The device will connect to your machine and communicate through the ethernet port. As such, it'd be wise to disconnect and turn off any other networking devices while using the eyetracker. It is possible that your network request could go out over a different network interface if you're not careful which makes for a troubleshooting nightmare. When you start the source module, ensure that the <code>--LogEyetrackerTobiiX=1</code> command line parameter is set. Run the Eyetracker Browser utility which came with your eyetracker drivers and use it to locate the device on your local network.

Calibration can now occur. Calibration should be done per subject per sitting. Re-calibration is not necessary between runs, but any time that the subject changes eyewear, makeup, or position, or if the lighting conditions change it should be re-calibrated. A good rule of thumb would be to recalibrate at the start of every session. Once a calibration is performed, it is saved in the Tobii device until the next calibration (even if there's a power loss).

BCI2000 does not provide any way to calibrate the eyetracker. Upon connecting the eyetracker to the computer via USB port, it should ask for calibrations. '''Note''' - the Tobii Eyetracker Eye X requires SS USB 3.0 port to communicate through. It cannot use USB 2.0 ports.

Once the device is calibrated, it can be used reliably in BCI2000. The logger will report information about eye validity in a text visualization window and feed states into the system.

==Parameters==
The eyetracker is configured in the Source tab within the EyetrackerLogger section. The configurable parameters are:

*<code>LogEyetrackerTobiiX</code> - Enables/Disables logging of Eyetracker states
*<code>LogGazeData</code> - Enables/Disables logging of gaze data
*<code>LogEyePos</code> - Enables/Disables logging of eye position (as seen from the camera)
*<code>LogPupilSize</code> - Enables/Disables logging of pupil size (very rough)
*<code>LogEyeDist</code> - Enables/Disables logging of the distance from the screen to the eyes (again, rough)
*<code>GazeScale</code> - Scales the incoming gaze data first
*<code>GazeOffset</code> - Offsets the incoming gaze data after scaling

Note: GazeScale and GazeOffset are quick hacks to address an issue with gaze data being clamped around the edges of the screen. The eyetracker gives back values which are between 0.0 and 1.0 for onscreen gaze but supports looking slightly offscreen by allowing gaze data returned to go above 1.0 and below 0.0. BCI2000 needs this scaled between 0.0 and 1.0 before the gaze data is multiplied by 65535 for storage in the 16 bit state. These two parameters account for this scaling and offset and prevents the clamping from happening as often as it would otherwise. These parameters will be removed once BCI2000 supports typed states. Brought from EyetrackerLogger

The following code retreives the actual ~(0.0-1.0) range that the eyetracker outputs directly (assuming you've scaled and offset the signal to avoid clipping) from each eye and averages it to find a gaze position.
<pre>
float x = State( "EyetrackerLeftEyeGazeX" ) + State( "EyetrackerRightEyeGazeX" ); x /= ( 2.0f * 65535.0f );
float y = State( "EyetrackerLeftEyeGazeY" ) + State( "EyetrackerRightEyeGazeY" ); y /= ( 2.0f * 65535.0f );
x -= ( float )Parameter( "GazeOffset" ); x /= ( float )Parameter( "GazeScale" );
y -= ( float )Parameter( "GazeOffset" ); y /= ( float )Parameter( "GazeScale" );
</pre>

==State Variables==
Unless otherwise specified, all states are prefixed with <code>Eyetracker<Left/Right>Eye</code> which corresponds with each individual eye. The EyetrackerLogger extension does not support subjects with more than two eyes at the moment.

===GazeX, GazeY===
The eye gaze position (where - on the screen - the subject is looking) is returned from the Tobii SDK as 32 bit floating point numbers which (roughly) range from 0.0 to 1.0. They are multiplied by 65535 and stored as 16 bit integers in these states if the <code>LogGazeData</code> parameter is enabled. (0,0) corresponds to the top left of the screen, (65535,65535) corresponds to the right bottom of the screen. -- See [[Contributions:EyetrackerLogger#EyetrackerStatesOK|EyetrackerStatesOK]].

===EyetrackerStatesOK===
Early versions of the extension didn't take into account that the library may return a number greater than 1.0 or less than 0.0. This resulted in "pac-man" style wrap around of gaze coordinates in 2.0 and crashes in 3.0. If the output from the library is out of bounds, it is clamped to the boundaries and the "EyetrackerStatesOK" parameter is changed. A value of "1" corresponds to valid gaze data, a value of "0" corresponds to invalid "clamped" gaze data. Those parameters scale and offset the data so that when it does go out of range, it can still be fit into the 16 bit state.

==See also==
[[User Reference:Logging Input]], [[Contributions:Extensions]], [[Contributions:EyetrackerLogger]]

[[Category:Contributions]][[Category:Extension]]

Contributions:EyetrackerLoggerTobii3

2015-07-01T15:23:58Z

Kgoering:

==Synopsis==
A filter that records state information from ''Tobii Eyetrackers'' using the Tobii SDK 3.0 into state variables.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/contrib/Extensions/EyetrackerLoggerTobii3

==Versioning==
===Authors===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
06/23/2015: Initial public release;

===Source Code Revisions===
*Initial development: 3318
*Tested under: 3318
*Known to compile under: 3318
*Broken since: --

==Functional Description==
In many cases, an experiment may require data about where the participant is looking. In these experiments, an eyetracker is the only way to gather data relating to gaze position and eye location. There are many eyetracking methods currently on the market, but many of these require the subject to hold their head steady -- often while strapped to a structure of some sort. The Tobii eyetrackers require no such restriction so they were a natural choice when it came to interfacing with BCI2000.

==Integration into BCI2000==
Compile the extension into your source module by enabling contributed extensions in your CMake configuration. You can do this by going into your root build folder and deleting <code>CMakeCache.txt</code> and re-running the project batch file, or by running <code>cmake -i</code> and enabling '''BUILD_EYETRACKERLOGGERTOBII3'''. Once the extension is built into the source module, enable it by starting the source module with the <code>--LogEyetrackerTobii3=1</code> command line argument.

==Usage and Calibration==
Set up the eyetracker as detailed in the documentation that came with your device. The device will connect to your machine and communicate through the ethernet port. As such, it'd be wise to disconnect and turn off any other networking devices while using the eyetracker. It is possible that your network request could go out over a different network interface if you're not careful which makes for a troubleshooting nightmare. When you start the source module, ensure that the <code>--LogEyetrackerTobii3=1</code> command line parameter is set. Run the Eyetracker Browser utility which came with your eyetracker drivers and use it to locate the device on your local network.

Calibration can now occur. Calibration should be done per subject per sitting. Re-calibration is not necessary between runs, but any time that the subject changes eyewear, makeup, or position, or if the lighting conditions change it should be re-calibrated. A good rule of thumb would be to recalibrate at the start of every session. Once a calibration is performed, it is saved in the Tobii device until the next calibration (even if there's a power loss).

BCI2000 does not provide any way to calibrate the eyetracker. This should be done using the Tobii.Calibration.exe program which came on the thumb drive with the eyetracker. It can be found in <code>Setup/InstallationGuide</code>. Run the executable and follow the onscreen instructions to calibrate.

Once the device is calibrated, it can be used reliably in BCI2000. The logger will report information about eye validity in a text visualization window and feed states into the system.

==Parameters==
The eyetracker is configured in the Source tab within the EyetrackerLogger section. The configurable parameters are:

*<code>LogEyetrackerTobii3</code> - Enables/Disables logging of Eyetracker states
*<code>LogGazeData</code> - Enables/Disables logging of gaze data
*<code>LogEyePos</code> - Enables/Disables logging of eye position (as seen from the camera)
*<code>LogPupilSize</code> - Enables/Disables logging of pupil size (very rough)
*<code>LogEyeDist</code> - Enables/Disables logging of the distance from the screen to the eyes (again, rough)
*<code>GazeScale</code> - Scales the incoming gaze data first
*<code>GazeOffset</code> - Offsets the incoming gaze data after scaling

Note: GazeScale and GazeOffset are quick hacks to address an issue with gaze data being clamped around the edges of the screen. The eyetracker gives back values which are between 0.0 and 1.0 for onscreen gaze but supports looking slightly offscreen by allowing gaze data returned to go above 1.0 and below 0.0. BCI2000 needs this scaled between 0.0 and 1.0 before the gaze data is multiplied by 65535 for storage in the 16 bit state. These two parameters account for this scaling and offset and prevents the clamping from happening as often as it would otherwise. These parameters will be removed once BCI2000 supports typed states. Brought from EyetrackerLogger

The following code retreives the actual ~(0.0-1.0) range that the eyetracker outputs directly (assuming you've scaled and offset the signal to avoid clipping) from each eye and averages it to find a gaze position.
<pre>
float x = State( "EyetrackerLeftEyeGazeX" ) + State( "EyetrackerRightEyeGazeX" ); x /= ( 2.0f * 65535.0f );
float y = State( "EyetrackerLeftEyeGazeY" ) + State( "EyetrackerRightEyeGazeY" ); y /= ( 2.0f * 65535.0f );
x -= ( float )Parameter( "GazeOffset" ); x /= ( float )Parameter( "GazeScale" );
y -= ( float )Parameter( "GazeOffset" ); y /= ( float )Parameter( "GazeScale" );
</pre>

==State Variables==
Unless otherwise specified, all states are prefixed with <code>Eyetracker<Left/Right>Eye</code> which corresponds with each individual eye. The EyetrackerLogger extension does not support subjects with more than two eyes at the moment.

===GazeX, GazeY===
The eye gaze position (where - on the screen - the subject is looking) is returned from the Tobii SDK as 32 bit floating point numbers which (roughly) range from 0.0 to 1.0. They are multiplied by 65535 and stored as 16 bit integers in these states if the <code>LogGazeData</code> parameter is enabled. (0,0) corresponds to the top left of the screen, (65535,65535) corresponds to the right bottom of the screen. -- See [[Contributions:EyetrackerLogger#EyetrackerStatesOK|EyetrackerStatesOK]].

===PosX, PosY===
The eye position relative to the camera in 2D space is returned if <code>LogEyePos</code> is enabled. Again, these are returned from the library as floating point numbers from 0.0 to 1.0 and are scaled to 16 bit integer values from 0 to 65535. (0,0) corresponds to the top left of the camera's view, and (65535,65535) corresponds to the bottom right of the camera's view.

===PupilSize===
The pupil size in mm is saved in this state if <code>LogPupilSize</code> is enabled. It corresponds to the length of the longest chord drawn from one side of the pupil to the other. The size will change depending on the eye position and distance from the screen. Although it is given in mm, it would be best to use this as a relative measurement.

===EyeDist===
The distance between the screen and the eyes in mm is saved in this state if <code>LogEyeDist</code> is enabled. This measurement is an approximation. The actual measurement will depend on whether or not the test subject is wearing glasses or not.

===EyeValidity===
This state is a number from 0 to 4 and is documented in the Tobii SDK manual. It is repeated here for convenience.
* 0 - The eye tracker is certain that the data for this eye is right. There is no risk of confusing data from the other eye.
* 1 - The eye tracker has only recorded one eye and made some assumptions and estimations regarding which is the left and which is the right eye. However, it is still very likely that the assumption made is correct. The validity code for the other eye is in this case always set to 3.
* 2 - The eye tracker has only recorded one eye, and has no way of determining which one is the left eye and which one is the right eye. The validity code for both eyes is set to 2.
* 3 - The eye tracker is fairly confident that the actual gaze data belongs to the other eye. The other eye will always have validity code 1.
* 4 - The actual gaze data is missing or definitely belonging to the other eye.

{| class="wikitable"
|-
! Code (Right - Left)
! Description
|-
| 0 - 0
| Both eyes found. Data is valid for both eyes.
|-
| 0 - 4 or 4 - 0
| One eye found. Gaze data is the same for both eyes.
|-
| 1 - 3 or 3 - 1
| One eye found. Gaze data is the same for both eyes.
|-
| 2 - 2
| One eye found. Gaze data is the same for both eyes.
|-
| 4 - 4
| No eye found. Gaze data for both eyes are invalid.
|}

It'd probably be wise to remove all data points with a validity state of 2 or higher while running your analysis.

===EyetrackerTimeStamp===
With the update to the 3.0 SDK, the added functionality of a time stamp on the frame of data is gathered from the eye tracker. It is then normalized to match the BCI2000 SourceTime. With this added state, you can check the input signals with the gaze direction of the subject or any other state. It is stored in ms like SourceTime.

===EyetrackerStatesOK===
Early versions of the extension didn't take into account that the library may return a number greater than 1.0 or less than 0.0. This resulted in "pac-man" style wrap around of gaze coordinates in 2.0 and crashes in 3.0. If the output from the library is out of bounds, it is clamped to the boundaries and the "EyetrackerStatesOK" parameter is changed. A value of "1" corresponds to valid gaze data, a value of "0" corresponds to invalid "clamped" gaze data. Use the "GazeOffset" and "GazeScale" parameters to avoid clamping. Those parameters scale and offset the data so that when it does go out of range, it can still be fit into the 16 bit state.

==See also==
[[User Reference:Logging Input]], [[Contributions:Extensions]], [[Contributions:EyetrackerLogger]]

[[Category:Contributions]][[Category:Extension]]

Contributions:EyetrackerLoggerTobii3

2015-07-01T15:22:20Z

Kgoering: /* Usage and Calibration */

==Synopsis==
A filter that records state information from ''Tobii Eyetrackers'' using the Tobii SDK 3.0 into state variables.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/contrib/Extensions/EyetrackerLoggerTobii3

==Versioning==
===Authors===
Kaleb Goering (kaleb.goering@gmail.com)
===Version History===
06/23/2015: Initial public release;

===Source Code Revisions===
*Initial development: 3318
*Tested under: 3318
*Known to compile under: 3318
*Broken since: --

==Functional Description==
In many cases, an experiment may require data about where the participant is looking. In these experiments, an eyetracker is the only way to gather data relating to gaze position and eye location. There are many eyetracking methods currently on the market, but many of these require the subject to hold their head steady -- often while strapped to a structure of some sort. The Tobii eyetrackers require no such restriction so they were a natural choice when it came to interfacing with BCI2000.

==Integration into BCI2000==
Compile the extension into your source module by enabling contributed extensions in your CMake configuration. You can do this by going into your root build folder and deleting <code>CMakeCache.txt</code> and re-running the project batch file, or by running <code>cmake -i</code> and enabling '''BUILD_EYETRACKERLOGGERTOBII3'''. Once the extension is built into the source module, enable it by starting the source module with the <code>--LogEyetrackerTobii3=1</code> command line argument.

==Usage and Calibration==
Set up the eyetracker as detailed in the documentation that came with your device. The device will connect to your machine and communicate through the ethernet port. As such, it'd be wise to disconnect and turn off any other networking devices while using the eyetracker. It is possible that your network request could go out over a different network interface if you're not careful which makes for a troubleshooting nightmare. When you start the source module, ensure that the <code>--LogEyetrackerTobii3=1</code> command line parameter is set. Run the Eyetracker Browser utility which came with your eyetracker drivers and use it to locate the device on your local network.

Calibration can now occur. Calibration should be done per subject per sitting. Re-calibration is not necessary between runs, but any time that the subject changes eyewear, makeup, or position, or if the lighting conditions change it should be re-calibrated. A good rule of thumb would be to recalibrate at the start of every session. Once a calibration is performed, it is saved in the Tobii device until the next calibration (even if there's a power loss).

BCI2000 does not provide any way to calibrate the eyetracker. This should be done using the Tobii.Calibration.exe program which came on the thumb drive with the eyetracker. It can be found in <code>Setup/InstallationGuide</code>. Run the executable and follow the onscreen instructions to calibrate.

Once the device is calibrated, it can be used reliably in BCI2000. The logger will report information about eye validity in a text visualization window and feed states into the system.

==Parameters==
The eyetracker is configured in the Source tab within the EyetrackerLogger section. The configurable parameters are:

*<code>LogEyetrackerTobii3</code> - Enables/Disables logging of Eyetracker states
*<code>LogGazeData</code> - Enables/Disables logging of gaze data
*<code>LogEyePos</code> - Enables/Disables logging of eye position (as seen from the camera)
*<code>LogPupilSize</code> - Enables/Disables logging of pupil size (very rough)
*<code>LogEyeDist</code> - Enables/Disables logging of the distance from the screen to the eyes (again, rough)
*<code>GazeScale</code> - Scales the incoming gaze data first
*<code>GazeOffset</code> - Offsets the incoming gaze data after scaling

Note: GazeScale and GazeOffset are quick hacks to address an issue with gaze data being clamped around the edges of the screen. The eyetracker gives back values which are between 0.0 and 1.0 for onscreen gaze but supports looking slightly offscreen by allowing gaze data returned to go above 1.0 and below 0.0. BCI2000 needs this scaled between 0.0 and 1.0 before the gaze data is multiplied by 65535 for storage in the 16 bit state. These two parameters account for this scaling and offset and prevents the clamping from happening as often as it would otherwise. These parameters will be removed once BCI2000 supports typed states. Brought from EyetrackerLogger

The following code retreives the actual ~(0.0-1.0) range that the eyetracker outputs directly (assuming you've scaled and offset the signal to avoid clipping) from each eye and averages it to find a gaze position.
<pre>
float x = State( "EyetrackerLeftEyeGazeX" ) + State( "EyetrackerRightEyeGazeX" ); x /= ( 2.0f * 65535.0f );
float y = State( "EyetrackerLeftEyeGazeY" ) + State( "EyetrackerRightEyeGazeY" ); y /= ( 2.0f * 65535.0f );
x -= ( float )Parameter( "GazeOffset" ); x /= ( float )Parameter( "GazeScale" );
y -= ( float )Parameter( "GazeOffset" ); y /= ( float )Parameter( "GazeScale" );
</pre>

==State Variables==
Unless otherwise specified, all states are prefixed with <code>Eyetracker<Left/Right>Eye</code> which corresponds with each individual eye. The EyetrackerLogger extension does not support subjects with more than two eyes at the moment.

===GazeX, GazeY===
The eye gaze position (where - on the screen - the subject is looking) is returned from the Tobii SDK as 32 bit floating point numbers which (roughly) range from 0.0 to 1.0. They are multiplied by 65535 and stored as 16 bit integers in these states if the <code>LogGazeData</code> parameter is enabled. (0,0) corresponds to the top left of the screen, (65535,65535) corresponds to the right bottom of the screen. -- See [[Contributions:EyetrackerLogger#EyetrackerStatesOK|EyetrackerStatesOK]].

===PosX, PosY===
The eye position relative to the camera in 2D space is returned if <code>LogEyePos</code> is enabled. Again, these are returned from the library as floating point numbers from 0.0 to 1.0 and are scaled to 16 bit integer values from 0 to 65535. (0,0) corresponds to the top left of the camera's view, and (65535,65535) corresponds to the bottom right of the camera's view.

===PupilSize===
The pupil size in mm is saved in this state if <code>LogPupilSize</code> is enabled. It corresponds to the length of the longest chord drawn from one side of the pupil to the other. The size will change depending on the eye position and distance from the screen. Although it is given in mm, it would be best to use this as a relative measurement.

===EyeDist===
The distance between the screen and the eyes in mm is saved in this state if <code>LogEyeDist</code> is enabled. This measurement is an approximation. The actual measurement will depend on whether or not the test subject is wearing glasses or not.

===EyeValidity===
This state is a number from 0 to 4 and is documented in the Tobii SDK manual. It is repeated here for convenience.
* 0 - The eye tracker is certain that the data for this eye is right. There is no risk of confusing data from the other eye.
* 1 - The eye tracker has only recorded one eye and made some assumptions and estimations regarding which is the left and which is the right eye. However, it is still very likely that the assumption made is correct. The validity code for the other eye is in this case always set to 3.
* 2 - The eye tracker has only recorded one eye, and has no way of determining which one is the left eye and which one is the right eye. The validity code for both eyes is set to 2.
* 3 - The eye tracker is fairly confident that the actual gaze data belongs to the other eye. The other eye will always have validity code 1.
* 4 - The actual gaze data is missing or definitely belonging to the other eye.

{| class="wikitable"
|-
! Code (Right - Left)
! Description
|-
| 0 - 0
| Both eyes found. Data is valid for both eyes.
|-
| 0 - 4 or 4 - 0
| One eye found. Gaze data is the same for both eyes.
|-
| 1 - 3 or 3 - 1
| One eye found. Gaze data is the same for both eyes.
|-
| 2 - 2
| One eye found. Gaze data is the same for both eyes.
|-
| 4 - 4
| No eye found. Gaze data for both eyes are invalid.
|}

It'd probably be wise to remove all data points with a validity state of 2 or higher while running your analysis.

===EyetrackerTimeStamp===
With the update to the 3.0 SDK, the added functionality of a time stamp on the frame of data is gathered from the eye tracker. It is then normalized to match the BCI2000 SourceTime. With this added state, you can check the input signals with the gaze direction of the subject or any other state. It is stored in ms like SourceTime.

===EyetrackerStatesOK===
Early versions of the extension didn't take into account that the library may return a number greater than 1.0 or less than 0.0. This resulted in "pac-man" style wrap around of gaze coordinates in 2.0 and crashes in 3.0. If the output from the library is out of bounds, it is clamped to the boundaries and the "EyetrackerStatesOK" parameter is changed. A value of "1" corresponds to valid gaze data, a value of "0" corresponds to invalid "clamped" gaze data. Use the "GazeOffset" and "GazeScale" parameters to avoid clamping. Those parameters scale and offset the data so that when it does go out of range, it can still be fit into the 16 bit state.

==See also==
[[User Reference:Logging Input]], [[Contributions:Extensions]], [[Contributions:EyetrackerLogger]]

[[Category:Contributions]][[Category:Extension]]

Contributions:ParallelPortFilter

2015-07-01T15:18:05Z

Kgoering: /* Digital Output */

Contributions:Extensions

2015-07-01T14:55:17Z

Kgoering:

A framework ''Extension'' is an optional contributed plugin which can affect multiple modules. For example, various manufacturer-specific [[User Reference:Logging Input|input-device loggers]] are provided in the <code>src/contrib/Extensions</code> folder, and these can be optionally added to the BCI2000 framework for SignalSource modules, thereby giving all source modules the ability to log input from the corresponding devices. Selecting a custom Extension, and re-building your modules to include it, requires the use of CMake and a supported C++ compiler: see the [[Programming Howto:Quickstart Guide]] for a walkthrough that shows you how to recompile BCI2000 modules.

The following user extensions are available in the [[Contributions:Contents|Contributions]] section of BCI2000:

*[[Contributions:CyberGloveLogger]]: A logger extension which acquires data from CGI, CGII and CGIII Cybergloves.
*[[Contributions:DataGloveLogger]]: A logger extension which acquires data from the 5DT Data Glove Ultra.
*[[Contributions:EyetrackerLogger]]: A logger extension which acquires data from Tobii eyetrackers.
*[[Contributions:EyetrackerLoggerTobii3]]: A logger extension which acquires data from Tobii eyetrackers using SDK version 3
*[[Contributions:EyetrackerLoggerTobiiX]]: A logger extension which acquires data from Tobii Eye X eyetrackers.
*[[Contributions:GazeMonitorFilter]]: An application module filter extension which supports the EyetrackerLogger.
*[[Contributions:WiimoteLogger]]: A logger extension which acquires data from Nintendo Wii Remotes.
*[[Contributions:WebcamLogger]]: A logger extension which allows for synchronizing webcam video.
*[[Contributions:AudioExtension]]: An all purpose audio toolkit which allows for realtime multichannel audio I/O.
*[[Contributions:StimBoxFilter]]: A logger and controller for the gtec g.STIMbox.
*[[Contributions:ParallelPortFilter]]: A logger and controller for communication through parallel ports.

==See also==
[[Programming Reference:EnvironmentExtension Class]]

[[Programming Tutorial:Implementing an Input Logger]][[Category:Contents]]

File:ParallelPortFilterNewNames.jpg

2015-07-01T14:52:49Z

Kgoering: Kgoering uploaded a new version of "File:ParallelPortFilterNewNames.jpg"

Example of how to rename LPT for use in ParallelPortFilter.

File:ParallelPortFilterRowLabelChange.jpg

2015-07-01T14:52:05Z

Kgoering: Kgoering uploaded a new version of "File:ParallelPortFilterRowLabelChange.jpg": This is an example of set up setting the address of LPT1 to the address for the current machine.

Example of how to only write 1 to two bits without saying 0 to the others

File:ParallelPortFilterNewAddress.jpg

2015-07-01T14:51:28Z

Kgoering: Kgoering uploaded a new version of "File:ParallelPortFilterNewAddress.jpg": This is an example of set up setting the address of LPT1 to the address for the current machine.

This is an example of set up setting the address of LPT1 to the address for the current machine.

File:ParallelPortFilterDigitalOutExBinary.jpg

2015-07-01T14:50:20Z

Kgoering: Kgoering uploaded a new version of "File:ParallelPortFilterDigitalOutExBinary.jpg": How to send the MousePosX through a parallel port

How to send the value 193 through a parallel port

Contributions:ParallelPortFilter

2015-06-30T20:36:34Z

Kgoering: /* Digital Output */

==Location==
http://{{SERVERNAME}}/svn/trunk/src/contrib/Extensions/ParallelPortFilter

==Versioning==

===Authors===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)

===Version History===
* 2015/06/30: Initial public release

===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Functional Description==
This simple filter extension resides in the Application module and makes input and output with the parallel port easy. The inputs are stored as states ParallelPortInput1 - ParallelPortInput24 based off the number of ports connected. For more information, see [[:Contributions:ParallelPortFilter#States|States]].

==Integration into BCI2000==
Compile the extension into your source module by enabling contributed extensions in your CMake configuration. You can do this by going into your root build folder and deleting <code>CMakeCache.txt</code> and re-running the project batch file, or by running <code>cmake -i</code> and enabling '''BUILD_PARALLELPORTFILTER'''. Once the extension is built into the source module, it can be used.

==Configuring ParallelPortFiler==
If using the filter, SourcePorts must have a number greater than 0. Then list the names for the ports separated by spaces in SourcePortsList. The list must be the same length as the value in SourcePorts. You can then set the LPTMapping with column one in using the names as in SourcePortsList and column 2 using the corresponding hardware address. This step is optional. If not configured, LPT1 maps to 0x378 and LPT2 maps to 0x278 which should work for most users. DigitalOutputEx is only necessary if user wants to write output through the parallel port.

If the default settings for LPTMapping did not produce results, the hardware address might be different for the user's computer. To find the hardware address for the parallel ports for your machine, press '''WIN''' + '''R''' and enter ''devmgmt.msc''. In Device Manager, expand the section labeled '''Ports (Com & LPT)'''. If this section does not exist, you probably do not have LPT ports or the driver is not installed properly. Find the one labeled with (LPT1) or whatever port you are looking for. Right click and select Properties. In the Resources tab, there is a field called I/O Range and take the first value of the range which is in hexadecimal. If multiple I/O Range, read the first one; if that does not work, try the other one. Take that value as the hardware address for Parameter LPTMapping. These instructions for finding the address has been tested on Windows XP, 7, and 8.

[[File:ParallelPortAddress.JPG]]

For some examples on configurations, see [[:Contributions:ParallelPortFilter#Example Configurations|Example Configurations]].

For better explanation of the parameters, see [[:Contributions:ParallelPortFilter#Parameters|Parameters]].

==Parameters==
The ParallelPortFilter is configured in the ParallelPort tab. The configurable parameters are:

===SourcePorts===
This parameter is used to initialize the filter and to keep track of the number of ports being used. This number should be the total number of parallel ports that should be used to communicate. It should be an integer value greater than 0 if being used else 0. Most computers do not have more than 3 parallel ports but some have 4. In good practice this value should not be greater than 3 unless you are sure you have that many ports.

===SourcePortsList===
This parameter lists the ports to be used and the order to communicate through them. It should be a list of the port names LPT1 - LPT3. You can not use the same port twice in on list. This list must be the same length as the value in Parameter SourcePorts.

===LPTMapping===
This parameter is to manually enter the hardware address of the ports incase that the computer being used does not conform to general use hardware addresses. Column one should have the names of the ports such as LPT1 or LPT2, same as the values in Parameter SourcePortsList, and column two should have the hexadecimal value of the port such as 0x378. The number of rows in the matrix should be equal to the value in Parameter SourcePorts, while it must have two columns if being used, no more, no less.

===DigitalOutputEx===
This matrix of expressions that controls the outputs on the parallel ports. Each port has 8 bits which correspond to 8 rows on the matrix. If the expression evaluates to True, the bit will be set to 1 else to 0. Boolean expression work quite well here. For more information on digital output and expressions usage for ParallelPortFilter see [[::Contributions:ParallelPortFilter#Digital Output|Digital Output]].

==Digital Output==
Each port has 8 bits that can be written to. These bits can be accessed through the Parameter DigitalOutputEx. The user must write expressions for each individual bit on each port. The row label corresponds to which bit it will be written to. If multiple ports are enabled, row 1 - 8 correspond to the bits 1 - 8 on the first port and row 9 - 16 correspond to the bits 1 - 8 on the second port and so on. Expressions that evaluate to True set the corresponding bit to 1 and those that evaluate to False set the corresponding bit to 0.

In the case that the user wishes to send an signal or a value through the port, the user must convert the number into binary and write the corresponding zeroes and ones to the respective bits. To do that, the formula:

<code>mod((floor(x / 2 ^(bitnumber - 1))), 2)</code>

The x is the number or the signal the user wishes to send through the port. For example if the number 193 was to be sent through the port, the Parameter DigitalOutputEx would be:

[[File:ParallelPortFilterDigitalOutExBinary.jpg]]

Not all rows have to be created. Any row not named just writes the bit as 0. The rows also can be written in whatever order if you just change the row label in the parameter. The example below just sets bit 1 and 5 to 1. All other rows are zeroes.

[[File:ParallelPortFilterRowLabelChange.jpg]]

For more on expressions, see [[:User Reference:Expression Syntax|Expressions]].

==States==
For each port there is 8 input bits which correspond to 8 ParallelPortInput states. Each state is either a 0 or a 1. If multiple ports are enabled, ParallelPortInput1 - ParallelPortInput8 correspond to the bits 1 - 8 on the first port and ParallelPortInput9 - ParallelPortInput16 correspond to the bits 1 - 8 on the second port and so on. Currently only 3 ports may be enabled, which should be more than enough for most computers do not have more than port LPT1 - LPT3.

==Example Configurations==
This example enables port LPT1 with a new hardware address.

[[File:ParallelPortFilterNewAddress.jpg|1000px]]

This example enables ports with names MRIScanner and StimulusDevice with hardware addresses. Note that the address for the ports are the same as the default values for LPT1 and LPT2. This shows that LPT names can be renamed in the Parameter Configuration to make it easier to read. This does not change the names of the addresses given by the computer itself.

[[File:ParallelPortFilterNewNames.jpg|1000px]]

Contributions:ParallelPortFilter

2015-06-30T20:35:55Z

Kgoering: /* Digital Output */

==Location==
http://{{SERVERNAME}}/svn/trunk/src/contrib/Extensions/ParallelPortFilter

==Versioning==

===Authors===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)

===Version History===
* 2015/06/30: Initial public release

===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Functional Description==
This simple filter extension resides in the Application module and makes input and output with the parallel port easy. The inputs are stored as states ParallelPortInput1 - ParallelPortInput24 based off the number of ports connected. For more information, see [[:Contributions:ParallelPortFilter#States|States]].

==Integration into BCI2000==
Compile the extension into your source module by enabling contributed extensions in your CMake configuration. You can do this by going into your root build folder and deleting <code>CMakeCache.txt</code> and re-running the project batch file, or by running <code>cmake -i</code> and enabling '''BUILD_PARALLELPORTFILTER'''. Once the extension is built into the source module, it can be used.

==Configuring ParallelPortFiler==
If using the filter, SourcePorts must have a number greater than 0. Then list the names for the ports separated by spaces in SourcePortsList. The list must be the same length as the value in SourcePorts. You can then set the LPTMapping with column one in using the names as in SourcePortsList and column 2 using the corresponding hardware address. This step is optional. If not configured, LPT1 maps to 0x378 and LPT2 maps to 0x278 which should work for most users. DigitalOutputEx is only necessary if user wants to write output through the parallel port.

If the default settings for LPTMapping did not produce results, the hardware address might be different for the user's computer. To find the hardware address for the parallel ports for your machine, press '''WIN''' + '''R''' and enter ''devmgmt.msc''. In Device Manager, expand the section labeled '''Ports (Com & LPT)'''. If this section does not exist, you probably do not have LPT ports or the driver is not installed properly. Find the one labeled with (LPT1) or whatever port you are looking for. Right click and select Properties. In the Resources tab, there is a field called I/O Range and take the first value of the range which is in hexadecimal. If multiple I/O Range, read the first one; if that does not work, try the other one. Take that value as the hardware address for Parameter LPTMapping. These instructions for finding the address has been tested on Windows XP, 7, and 8.

[[File:ParallelPortAddress.JPG]]

For some examples on configurations, see [[:Contributions:ParallelPortFilter#Example Configurations|Example Configurations]].

For better explanation of the parameters, see [[:Contributions:ParallelPortFilter#Parameters|Parameters]].

==Parameters==
The ParallelPortFilter is configured in the ParallelPort tab. The configurable parameters are:

===SourcePorts===
This parameter is used to initialize the filter and to keep track of the number of ports being used. This number should be the total number of parallel ports that should be used to communicate. It should be an integer value greater than 0 if being used else 0. Most computers do not have more than 3 parallel ports but some have 4. In good practice this value should not be greater than 3 unless you are sure you have that many ports.

===SourcePortsList===
This parameter lists the ports to be used and the order to communicate through them. It should be a list of the port names LPT1 - LPT3. You can not use the same port twice in on list. This list must be the same length as the value in Parameter SourcePorts.

===LPTMapping===
This parameter is to manually enter the hardware address of the ports incase that the computer being used does not conform to general use hardware addresses. Column one should have the names of the ports such as LPT1 or LPT2, same as the values in Parameter SourcePortsList, and column two should have the hexadecimal value of the port such as 0x378. The number of rows in the matrix should be equal to the value in Parameter SourcePorts, while it must have two columns if being used, no more, no less.

===DigitalOutputEx===
This matrix of expressions that controls the outputs on the parallel ports. Each port has 8 bits which correspond to 8 rows on the matrix. If the expression evaluates to True, the bit will be set to 1 else to 0. Boolean expression work quite well here. For more information on digital output and expressions usage for ParallelPortFilter see [[::Contributions:ParallelPortFilter#Digital Output|Digital Output]].

==Digital Output==
Each port has 8 bits that can be written to. These bits can be accessed through the Parameter DigitalOutputEx. The user must write expressions for each individual bit on each port. The row label corresponds to which bit it will be written to. If multiple ports are enabled, row 1 - 8 correspond to the bits 1 - 8 on the first port and row 9 - 16 correspond to the bits 1 - 8 on the second port and so on. Expressions that evaluate to True set the corresponding bit to 1 and those that evaluate to False set the corresponding bit to 0.

In the case that the user wishes to send an signal or a value through the port, the user must convert the number into binary and write the corresponding zeroes and ones to the respective bits. To do that, the formula:

<code>mod((floor(x / 2 ^(bitnumber - 1))), 2)</code>

The x is the number or the signal the user wishes to send through the port. For example if the number 193 was to be sent through the port, the Parameter DigitalOutputEx would be:

[[File:ParallelPortFilterDigitalOutExBinary.jpg]]

Not all rows have to be created. Any row not named just writes the bit as 0. The rows also can be written in whatever order if you just change the row label in the parameter. The example below just sets bit 1 and 5 to 1. All other rows are zeroes.

[[File:ParallelPortFilterRowLabelChange.jpg]]

For more on expressions, see [[:User Reference:Expression Syntax|Expressions]].

==States==
For each port there is 8 input bits which correspond to 8 ParallelPortInput states. Each state is either a 0 or a 1. If multiple ports are enabled, ParallelPortInput1 - ParallelPortInput8 correspond to the bits 1 - 8 on the first port and ParallelPortInput9 - ParallelPortInput16 correspond to the bits 1 - 8 on the second port and so on. Currently only 3 ports may be enabled, which should be more than enough for most computers do not have more than port LPT1 - LPT3.

==Example Configurations==
This example enables port LPT1 with a new hardware address.

[[File:ParallelPortFilterNewAddress.jpg|1000px]]

This example enables ports with names MRIScanner and StimulusDevice with hardware addresses. Note that the address for the ports are the same as the default values for LPT1 and LPT2. This shows that LPT names can be renamed in the Parameter Configuration to make it easier to read. This does not change the names of the addresses given by the computer itself.

[[File:ParallelPortFilterNewNames.jpg|1000px]]

Contributions:ParallelPortFilter

2015-06-30T20:26:19Z

Kgoering:

==Location==
http://{{SERVERNAME}}/svn/trunk/src/contrib/Extensions/ParallelPortFilter

==Versioning==

===Authors===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)

===Version History===
* 2015/06/30: Initial public release

===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Functional Description==
This simple filter extension resides in the Application module and makes input and output with the parallel port easy. The inputs are stored as states ParallelPortInput1 - ParallelPortInput24 based off the number of ports connected. For more information, see [[:Contributions:ParallelPortFilter#States|States]].

==Integration into BCI2000==
Compile the extension into your source module by enabling contributed extensions in your CMake configuration. You can do this by going into your root build folder and deleting <code>CMakeCache.txt</code> and re-running the project batch file, or by running <code>cmake -i</code> and enabling '''BUILD_PARALLELPORTFILTER'''. Once the extension is built into the source module, it can be used.

==Configuring ParallelPortFiler==
If using the filter, SourcePorts must have a number greater than 0. Then list the names for the ports separated by spaces in SourcePortsList. The list must be the same length as the value in SourcePorts. You can then set the LPTMapping with column one in using the names as in SourcePortsList and column 2 using the corresponding hardware address. This step is optional. If not configured, LPT1 maps to 0x378 and LPT2 maps to 0x278 which should work for most users. DigitalOutputEx is only necessary if user wants to write output through the parallel port.

If the default settings for LPTMapping did not produce results, the hardware address might be different for the user's computer. To find the hardware address for the parallel ports for your machine, press '''WIN''' + '''R''' and enter ''devmgmt.msc''. In Device Manager, expand the section labeled '''Ports (Com & LPT)'''. If this section does not exist, you probably do not have LPT ports or the driver is not installed properly. Find the one labeled with (LPT1) or whatever port you are looking for. Right click and select Properties. In the Resources tab, there is a field called I/O Range and take the first value of the range which is in hexadecimal. If multiple I/O Range, read the first one; if that does not work, try the other one. Take that value as the hardware address for Parameter LPTMapping. These instructions for finding the address has been tested on Windows XP, 7, and 8.

[[File:ParallelPortAddress.JPG]]

For some examples on configurations, see [[:Contributions:ParallelPortFilter#Example Configurations|Example Configurations]].

For better explanation of the parameters, see [[:Contributions:ParallelPortFilter#Parameters|Parameters]].

==Parameters==
The ParallelPortFilter is configured in the ParallelPort tab. The configurable parameters are:

===SourcePorts===
This parameter is used to initialize the filter and to keep track of the number of ports being used. This number should be the total number of parallel ports that should be used to communicate. It should be an integer value greater than 0 if being used else 0. Most computers do not have more than 3 parallel ports but some have 4. In good practice this value should not be greater than 3 unless you are sure you have that many ports.

===SourcePortsList===
This parameter lists the ports to be used and the order to communicate through them. It should be a list of the port names LPT1 - LPT3. You can not use the same port twice in on list. This list must be the same length as the value in Parameter SourcePorts.

===LPTMapping===
This parameter is to manually enter the hardware address of the ports incase that the computer being used does not conform to general use hardware addresses. Column one should have the names of the ports such as LPT1 or LPT2, same as the values in Parameter SourcePortsList, and column two should have the hexadecimal value of the port such as 0x378. The number of rows in the matrix should be equal to the value in Parameter SourcePorts, while it must have two columns if being used, no more, no less.

===DigitalOutputEx===
This matrix of expressions that controls the outputs on the parallel ports. Each port has 8 bits which correspond to 8 rows on the matrix. If the expression evaluates to True, the bit will be set to 1 else to 0. Boolean expression work quite well here. For more information on digital output and expressions usage for ParallelPortFilter see [[::Contributions:ParallelPortFilter#Digital Output|Digital Output]].

==Digital Output==
Each port has 8 bits that can be written to. These bits can be accessed through the Parameter DigitalOutputEx. The user must write expressions for each individual bit on each port. The row label corresponds to which bit it will be written to. If multiple ports are enabled, row 1 - 8 correspond to the bits 1 - 8 on the first port and row 9 - 16 correspond to the bits 1 - 8 on the second port and so on. Expressions that evaluate to True set the corresponding bit to 1 and those that evaluate to False set the corresponding bit to 0.

In the case that the user wishes to send an signal or a value through the port, the user must convert the number into binary and write the corresponding zeroes and ones to the respective bits. To do that, the formula:
<code>mod((floor(x / 2 ^(bitnumber - 1))), 2)</code>. The x is the number or the signal the user wishes to send through the port. For example if the number 193 was to be sent through the port, the Parameter DigitalOutputEx would be:

[[File:ParallelPortFilterDigitalOutExBinary.jpg]]

Not all rows have to be created. Any row not named just writes the bit as 0. The rows also can be written in whatever order if you just change the row label in the parameter. The example below just sets bit 1 and 5 to 1. All other rows are zeroes.

[[File:ParallelPortFilterRowLabelChange.jpg]]

For more on expressions, see [[:User Reference:Expression Syntax|Expressions]].

==States==
For each port there is 8 input bits which correspond to 8 ParallelPortInput states. Each state is either a 0 or a 1. If multiple ports are enabled, ParallelPortInput1 - ParallelPortInput8 correspond to the bits 1 - 8 on the first port and ParallelPortInput9 - ParallelPortInput16 correspond to the bits 1 - 8 on the second port and so on. Currently only 3 ports may be enabled, which should be more than enough for most computers do not have more than port LPT1 - LPT3.

==Example Configurations==
This example enables port LPT1 with a new hardware address.

[[File:ParallelPortFilterNewAddress.jpg|1000px]]

This example enables ports with names MRIScanner and StimulusDevice with hardware addresses. Note that the address for the ports are the same as the default values for LPT1 and LPT2. This shows that LPT names can be renamed in the Parameter Configuration to make it easier to read. This does not change the names of the addresses given by the computer itself.

[[File:ParallelPortFilterNewNames.jpg|1000px]]

User Reference:gUSBampADC

2015-06-30T19:54:08Z

Kgoering: /* gUSBamps with UB serial numbers */

==Function==
The ''gUSBampADC'' filter acquires data from any number (tested up to four) ''g.USBamp'' EEG amplifiers.
''g.USBamp'' is an amplifier/digitizer combination from g.tec medical engineering GmbH/Guger Technologies OEG (http://www.gtec.at).
Support for this device in BCI2000 consists of two components: A BCI2000-compatible Source Module (''gUSBamp.exe'') and a
command-line tool (''USBampgetinfo'').

===g.USBamp Hardware===
The USBamp consists of 16 independent 24-bit A/D converters that can sample at
up to 38.4kHz per channel. Because there is one A/D converter for each channel,
one particular sample is digitized at the exact same time for each channel. This
is unlike with traditional A/D converter boards that only have one A/D
converter. BCI2000 has a feature that can align samples in time (parameter
[[User Reference:AlignmentFilter#AlignChannels|AlignChannels]]).
Because this feature is not needed in conjunction with the USBamp, it needs to be turned off (i.e., ''AlignChannels'' needs to be 0).

====Drivers====
With the release of the Version 3.0 g.USBamp, there is now a small problem with the gUSBamp.dll included in BCI2000. The DLL included with BCI2000 was intended to be used with g.USBamp Version 2.0 hardware. If Version 3.0 hardware is used with the current BCI2000 distribution, the gUSBampADC module will default to using the Version 2.0 DLL which will not function.

Drivers come with the g.USBamp hardware - the correct drivers to match the version of the hardware. If the installer is used to install the drivers for the g.USBamp, it will also place the g.USBamp DLL into your <tt>WINDOWS/system32</tt> folder. If the DLL in <tt>BCI2000/prog</tt> is deleted, the DLL appropriate for use with your g.USBamp hardware should be used.

In short, in order to make Version 3.0 amps work with the current BCI2000 distribution, simply delete the <tt>gUSBamp.dll</tt> file from your <tt>BCI2000/prog</tt> folder.

Here is a grid of what driver/amp/dll combinations work:

{|border="1"
|'''Version 2.0 amp'''
|2.0 DLL
|3.0 DLL
|-
|2.0 Driver
|Works
|Works
|-
|3.0 Driver
|Does Not Work
|Does Not Work
|}

{|border="1"
|'''Version 3.0 amp'''
|2.0 DLL
|3.0 DLL
|-
|2.0 Driver
|Does Not Work
|Does Not Work
|-
|3.0 Driver
|Does Not Work
|Works
|}

==Parameters==
Parameters common to all source modules are described under [[User Reference:DataIOFilter]].
In addition, the ''gUSBampADC'' provides the following parameters:

===DeviceIDMaster===
Serial number (e.g., UA-2007.01.01) of the master device.
If you only have one device, this parameter has to equal ''DeviceIDs''.
If you have more then one device, then this parameter represents the serial number of the device whose SYNC goes to the slaves, i.e., the only device that has a cable connected at SYNC OUT, but none connected to SYNC IN.
If only one device is connected, this parameter may be set to ''auto''.

===DeviceIDs===
List of serial numbers (e.g., UA-2007.01.01) of all devices.
If you have more than one device, this list determines the order of the channels in the data file.
If only one device is connected, this parameter may be set to ''auto''.

===FilterEnabled===
Choose 1 if you want a pass band filter, and 0 if you don't.
The gUSBamp is a DC amplifier and thus you most likely will want a pass band filter.
Please note that, because the g.USBamp internally has a 5kHz antialiasing filter and always samples with 38.4kHz, you DO NOT need to enable any filter if you do not want.
You will never experience aliasing.

===FilterHighPass===
High pass frequency for pass band.
You need to query the amp for possible values.
See description of the [[#The USBampgetinfo Command Line Tool|USBampgetinfo]] tool for more info.

===FilterLowPass===
Low pass frequency for pass band.
See description of the USBampgetinfo tool for more info.

===FilterModelOrder===
Model order for passband filter.
See description of the USBampgetinfo tool for more info.

===FilterType===
Type of passband filter:
* 1=CHEBYSHEV,
* 2=BUTTERWORTH.

===NotchEnabled===
Choose 1 if you want a notch filter, and 0 if you don't.

===NotchHighPass===
Similar to FilterHighPass.

===NotchLowPass===
Similar to FilterLowPass.

===NotchModelOrder===
Similar to FilterModelOrder.

===NotchType===
Similar to FilterType.

===SampleBlockSize===
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 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===
The sampling rate of all connected USBamps.
If one wants to use a bandpass or a notch filter, there needs to be a filter configuration for that particular sampling rate (see the section on the ''[USBampgetinfo]'' tool). (Guger Technologies can provide you with a new driver configuration file if you need a different filter.)

The USBamp supports the following sampling rates: 32, 64, 128, 256, 512, 600, 1200, 2400, 4800, 9600, 19200, and 38400 Hz. All sampling rates are supported for one or more amplifiers. If you are sampling at high rates and from multiple amplifiers, the CPU may be overloaded depending on the speed of your computer and the BCI2000 configuration. In case you are experiencing problems (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. For example, at 38400 Hz, 4 amplifiers (64 channels), and a system update of 30 Hz, the computer would have to draw more than 73 million lines per second in the Source display!

===SignalType===
Defines the data type of the stored signal samples (int16 or float32).
If the data type is int16, signal samples (which are produced by the amplifier in units of <math>\mu V</math>) are converted back into virtual A/D units (see Data Storage section below). If the data type is float32, the signals are stored in units of <math>\mu V</math>.
In this case, SourceChOffset should be 0, and SourceChGain should be
1 (since the conversion factor from <math>\mu V</math> into <math>\mu V</math> is 1).

===SourceCh===
The total number of channels across all USBamp devices.

===SourceChDevices===
The number of channels acquired from each device.
If there is only one device, this parameter has to equal ''SourceCh''.
For example, '16 8' will acquire channels from the first device listed under ''DeviceIDs'', and 8 channels from the second device listed under ''DeviceIDs''.
Data acquisition always starts at channel 1.
The sum of all channels (e.g., 24 in this example) has to
equal the value of ''SourceCh''.

===SourceChList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh''. For more than one device, ''SourceChDevices'' determines how the ''SourceChList'' values are mapped to each device. For example if ''SourceChDevices'' = '8 8' and ''SourceChList'' = '1 2 3 4 13 14 15 16 5 6 7 8 9 10 11 12', then channels 1-4 and 13-16 will be acquired on the first device, and channels 5-12 will be acquired on the second device. These channels will be saved in the data file as 16 contiguous channels.
The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'. The channels are always in ascending order on a single device.
Channels may not be listed twice on a single device; e.g., entering '1 2 3 4 5 6 7 1' if ''SourceChDevices'' = '8' will result in an error.
If this parameter is left blank (the default), then all channels are acquired on all devices.

===BipolarChList===
A list of channels used for a bipolar montage. Each entry is configured as the reference for a source channel, based on the channel order. The number of values should equal both ''SourceCh'' and the number of values in ''SourceChList'' (if ''SourceChList'' is not empty). If ''BipolarChList'' is empty, then the standard referential recording montage is used. If a value of '0' is entered, then the reference channel is used for that channel. Finally, channel labels may be used.

As an example, a sequential bipolar montage for 8 channels could be configured like:

<tt>2 3 4 5 6 7 8 1</tt>

meaning that channel 1 is referenced to channel 2, channel 2 is referenced to channel 3, and so on. For another example, 10 channels can be configured so that the first 6 are bipolar, and the last four are referential, e.g.:

<tt>C3 F3 C4 F4 Pz Oz 0 0 0 0</tt>

===EnableDigitalInput===
Enable digital input.
If enabled, the sampled values of the digital input from the digital I/O ports will be stored in to states DigitalInput1 - DigitalInput64 depending on the number of amps connected and hardware versions. See [[:User Reference:gUSBampADC#Digital Input|Digital Input]] for more information.

===EnableDigitalOutput===
Enable digital output. If enabled, the digital output is set to the values returned when the signals go through the expressions given by the Parameter DigitalOutputEx. See [[:User Reference:gUSBampADC#Digital Output|Digital Output]] for more information.

===DigitalOutputEx===
If digital output is turned on, the given expressions will be evaluated for the current input. If the expression evaluates true the bit is set to high, else set to low. Each expression represents a different bit and the number starts with the master and is continuous through all amps like digital input. Boolean expressions work well for this ( ex. <tt>( ( StimulusCode == 0 ) && Running )</tt> ). See [[:User Reference:Expression Syntax|Expressions]] for more information on how to write expressions.

===AcquisitionMode===
If set to ''analog signal acquisition'', the g.USBamp records analog signal voltages (default). If set to ''Calibration'', the signal output is a sine wave test signal generated by the g.USBamp (which can be used to verify correct system calibration).
If set to ''Impedance'', regular analog signal acquisition is preceded by an impedance test.
This impedance test reports input impedances for each channel in kOhms.
In impedance mode, if the ground and reference is connected in the amp internally (using the ''CommonGround'' and ''CommonReference'' parameters), then you need to connect the ground and reference to block 4.

===CommonGround===
This parameter determines whether the g.USBamp internally connects the GND inputs from all blocks together.
If enabled (default), then the signal ground only needs to be connected to one input block, e.g., block 1.
Otherwise, all GND inputs need to be externally connected.

===CommonReference===
The same as ''CommonGround'', except for the signal reference.

==Digital I/O==

===Digital Inputs===
Can be used with 1 - 8 gUSBamps.

====gUSBamps with UA serial numbers====
[[File:UADigIn.JPG]]

Each gUSBamp has only one digital I/O port and this is stored in only one state per an gUSBamp. If multiple UA gUSBamps are connected in sync then up to state DigitalInput8 will be used, with the master gUSBamp using DigitalInput1 and the last slave gUSBamp using DigitalInput8 if 8 gUSBamps are used, or DigitalInput6 if only 6 gUSBamps are used. To access the digital input from any gUSBamp, access the state DigitalInput for the number of that slave gUSBamp. For example if I wanted to access the 5th gUSBamp, I would access DigitalInput5.

====gUSBamps with UB serial numbers====
[[File:UBDigIn.JPG]]

Each gUSBamp has two digital I/O ports which are stored in eight states per gUSBamp. If multiple UB gUSBamp are connected in sync then up to state DigitalInput64 will be used with the master gUSBamp using DigitalInput1 - DigitalInput8 and the last gUSBamp using DigitalInput57 - DigitalInput64 if 8 gUSBamps are used, and DigitalInput41 - DigitalInput48 if only 6 gUSBamps are used. To access the digital input from any gUSBamp, take the number of gUSBamps preceding the intended gUSBamp multiplied by 8, then add the number of the bit you want to see. For example, if I wanted to access the 5th gUSBamp's 5th bit, I would look at DigitalInput37 (4 * 8 + 5).

====g.USBamps in sync with both UA and UB serial numbers====
The device specifications are the same as above and each gUSBamp only has the number of states designated to it as specified above, i.e. each UB gUSBamp has eight states and each UA gUSBamp has only one state. The numbering of the states are based on the order of the gUSBamps. For example, if we have the following setup: UB gUSBamp as master with slaves in the following order: UB UA UA UB UA UA, which gives a total of 7 gUSBamps using DigitalInput1 - DigitalInput24 (3 * 8 + 4 * 1).For example, to access the second UA gUSBamp (which has only one state), I would look at DigitalInput18, found by the number of UB gUSBamps preceding the second UA gUSBamp multiplied by 8 plus the number of UA gUSBamps preceding it plus one for the gUSBamp itself (2 * 8 + 1 + 1). To access the third UB gUSBamp's seventh bit, I would look at DigitalInput25. This was found in the same manner as above but because it is a UB gUSBamp the specific bit is added instead of just one (2 * 8 + 2 + 7).

To setup a link between gUSBamps UA and UB, the following images show how to connect them.

[[File:UAUBcombo.JPG]]

[[File:UAUBmultiple.JPG]]

===Digital Output===
Can be used with 1 - 8 gUSBamps.

====gUSBamps with UA serial numbers====
Each gUSBamp has one digital I/O port giving it two digital output bits. If multiple UA gUSBamps are connected there are a total of 16 digital output bits possible. To write to these bits, Parameter DigitalOutputEx must be filled. Each row correlates to a bit. The numbering of the bits start with 1 and 2 being the master gUSBamp and continues numbering until the eighth gUSBamp having bit 15 and 16. To determine which row to use, the bit is found by taking the number of amgUSBampsps preceding the intended gUSBamp in the chain multiplied by two and then add the number of the bit you want to write for. For example, the second bit of the fourth gUSBamp is row 8 (3 * 2 + 2).

====gUSBamps with UB serial numbers====
Each gUSBamp has two digital I/O ports giving it four digital output bits. If multiple UB gUSBamps are connected, that gives a total of 32 digital output bits possible. To write to these bits, Parameter DigitalOutputEx must be filled. Each row corresponds to a bit. The numbering of the bits start with 1 - 4 being the master gUSBamp and continues numbering until the eighth gUSBamp having bits 29 - 32. To figure out which row to use, the formula is the number of gUSBamps preceding the intended gUSBamp in the chain multiplied by four and then add the number of the bit you want to write for. For example the second bit of the fourth gUSBamp is row 14 (3 * 4 + 2).

====gUSBamps in sync with both UA and UB serial numbers====
The device specs are the same as above with each UA gUSBamp having two digital output bits and each UB gUSBamp having four digital output bits. To write the proper row, the order of the gUSBamps matter just like digital input. For example we have the setup of UB gUSBamp as master with the slaves in the following order: UB UA UA UB UA UA, which gives a total of 7 gUSBamps having a total of 20 digital output bits. To find the row that corresponds with the bit you want to write for, take the number of UB gUSBamps preceding the intended gUSBamp in the chain multiplied by 4 and add the number of UA gUSBamps preceding the intended gUSBamp in the chain multiplied by 2 and add the number of the bit you want. For example to write the expression for the second UA gUSBamp's first bit, I would write the expression in row 11 (2 * 4 + 1 * 2 + 1). For example to write the expression for the third UB gUSBamp's third bit, I would write the expression in row 15 (2 * 4 + 2 * 2 + 3).

==States==

===DigitalInput===
DigitalInput ranges from DigitalInput1 - DigitalInput64 (see [[:User Reference:gUSBampADC#Digital Input|Digital Input]] for explanation) and the values are either a 0 or a 1.

==Additional Information==

===Using 32bit Executables on 64bit Installations===
BCI2000 supports compilation of the gUSBamp source module for 64bit targets. The resulting executable will run on 64bit systems, and work with the 64bit version of the gUSBamp drivers. However, the binary distribution of BCI2000 contains 32bit executables. These run fine under 64bit systems, but you will need to perform these additional driver installation steps to install 32bit gUSBamp API DLLs on 64bit systems:
*Execute gtec's 32bit driver installer on your 64bit system.
*After successful installation, execute gtec's 64bit driver installer on your 64bit system.
*You will now have both the 32bit API DLL and the 64bit API DLL installed, such that both 32bit and 64bit executables will be able to connect to a gUSBamp attached to the system's USB ports.

===Data Storage===
Unlike other systems, the USBamp is a DC amplifier system that digitizes at 24 bit.
Bandpass and notch filtering is performed on the digitized samples, resulting in floating point signal samples in units of <math>\mu V</math>.
BCI2000 currently supports signed 16 bit integers and floating point numbers for its data storage.
If ''SignalType'' is set to int16, the floating point values have to be converted back into integers before they can be stored and transmitted to Signal Processing.
This is done by the following transformation:

<math>\mathrm{sample}_\mathrm{stored}\mathrm{(A/D\,units)}=\frac{\mathrm{sample}_\mathrm{acquired}(\mu V)}\mathrm{SourceChGain}</math>.

(''SourceChOffset'' is assumed (and required) to be zero for all channels.)
BCI2000 Signal Processing or any offline analysis routine can derive, as with
any other BCI2000 source module, sample values in <math>\mu V</math> by subtracting, from
each stored sample, ''SourceChOffset'' (i.e., zero), and multiplying it with
''SourceChGain'' for each channel. If ''SignalType'' is set to float32,
data samples are stored in units of <math>\mu V</math>. In this case, ''SourceChGain'' should be
a list of 1's (because the conversion factor between data samples into <math>\mu V</math> is
1.0 for each channel).

Still, when values other than 0 and 1 are specified, a consistent data file will be produced, i.e. values will be transformed before they are written to the file, such that applying SourceChOffset and SourceChGain will reproduce the original values in <math>\mu V</math>.

===The ''USBampgetinfo'' Command Line Tool===
This command line tool displays all connected USBamps, including their serial
number and the USB port that they connect to. Further, this tool reads, for the
first of the connected amplifiers, all supported bandpass and notch filter
configurations. Thus, this tool can be used to determine which filters can be
used for a particular sampling frequency within BCI2000. The following is an
example screen output:

<pre>
*******************************************
BCI2000 Information Tool for g.USBamp
*******************************************
(C)2004 Gerwin Schalk
Wadsworth Center
New York State Department of Health
Albany, NY, USA
*******************************************
Amp found at USB address 1 (S/N: UA-200X.XX.XX)
Printing info for first amp (USB address 1)

Available bandpass filters
===================================
num| hpfr | lpfreq | sfr | or | type
===================================
000| 0.10 | 0.0 | 32 | 8 | 1
001| 1.00 | 0.0 | 32 | 8 | 1
002| 2.00 | 0.0 | 32 | 8 | 1
003| 5.00 | 0.0 | 32 | 8 | 1
004| 0.00 | 15.0 | 32 | 8 | 1
005| 0.01 | 15.0 | 32 | 8 | 1
006| 0.10 | 15.0 | 32 | 8 | 1
007| 0.50 | 15.0 | 32 | 8 | 1
008| 2.00 | 15.0 | 32 | 8 | 1
009| 0.10 | 0.0 | 64 | 8 | 1
010| 1.00 | 0.0 | 64 | 8 | 1
011| 2.00 | 0.0 | 64 | 8 | 1
012| 5.00 | 0.0 | 64 | 8 | 1
013| 0.00 | 30.0 | 64 | 8 | 1
014| 0.01 | 30.0 | 64 | 8 | 1
015| 0.10 | 30.0 | 64 | 8 | 1
016| 0.50 | 30.0 | 64 | 8 | 1
017| 2.00 | 30.0 | 64 | 8 | 1
018| 0.10 | 0.0 | 128 | 8 | 1
019| 1.00 | 0.0 | 128 | 8 | 1
020| 2.00 | 0.0 | 128 | 8 | 1
021| 5.00 | 0.0 | 128 | 8 | 1
022| 0.00 | 30.0 | 128 | 8 | 1
023| 0.00 | 60.0 | 128 | 8 | 1
024| 0.01 | 30.0 | 128 | 8 | 1
025| 0.01 | 60.0 | 128 | 8 | 1
026| 0.10 | 30.0 | 128 | 8 | 1
027| 0.10 | 60.0 | 128 | 8 | 1
028| 0.50 | 30.0 | 128 | 8 | 1
029| 0.50 | 60.0 | 128 | 8 | 1
030| 2.00 | 30.0 | 128 | 8 | 1
031| 2.00 | 60.0 | 128 | 8 | 1
032| 0.10 | 0.0 | 256 | 8 | 1
033| 1.00 | 0.0 | 256 | 8 | 1
034| 2.00 | 0.0 | 256 | 8 | 1
035| 5.00 | 0.0 | 256 | 8 | 1
036| 0.00 | 30.0 | 256 | 8 | 1
037| 0.00 | 60.0 | 256 | 8 | 1
038| 0.00 | 100.0 | 256 | 8 | 1
039| 0.01 | 30.0 | 256 | 6 | 1
040| 0.01 | 60.0 | 256 | 8 | 1
041| 0.01 | 100.0 | 256 | 8 | 1
042| 0.10 | 30.0 | 256 | 8 | 1
043| 0.10 | 60.0 | 256 | 8 | 1
044| 0.10 | 100.0 | 256 | 8 | 1
045| 0.50 | 30.0 | 256 | 8 | 1
046| 0.50 | 60.0 | 256 | 8 | 1
047| 0.50 | 100.0 | 256 | 8 | 1
048| 2.00 | 30.0 | 256 | 8 | 1
049| 2.00 | 60.0 | 256 | 8 | 1
050| 2.00 | 100.0 | 256 | 8 | 1
051| 5.00 | 30.0 | 256 | 8 | 1
052| 5.00 | 60.0 | 256 | 8 | 1
053| 5.00 | 100.0 | 256 | 8 | 1
054| 0.10 | 0.0 | 512 | 8 | 1
055| 1.00 | 0.0 | 512 | 8 | 1
056| 2.00 | 0.0 | 512 | 8 | 1
057| 5.00 | 0.0 | 512 | 8 | 1
058| 0.00 | 30.0 | 512 | 8 | 1
059| 0.00 | 60.0 | 512 | 8 | 1
060| 0.00 | 100.0 | 512 | 8 | 1
061| 0.00 | 200.0 | 512 | 8 | 1
062| 0.01 | 30.0 | 512 | 6 | 1
063| 0.01 | 60.0 | 512 | 6 | 1
064| 0.01 | 100.0 | 512 | 6 | 1
065| 0.01 | 200.0 | 512 | 8 | 1
066| 0.10 | 30.0 | 512 | 8 | 1
067| 0.10 | 60.0 | 512 | 8 | 1
068| 0.10 | 100.0 | 512 | 8 | 1
069| 0.10 | 200.0 | 512 | 8 | 1
070| 0.50 | 30.0 | 512 | 8 | 1
071| 0.50 | 60.0 | 512 | 8 | 1
072| 0.50 | 100.0 | 512 | 8 | 1
073| 0.50 | 200.0 | 512 | 8 | 1
074| 2.00 | 30.0 | 512 | 8 | 1
075| 2.00 | 60.0 | 512 | 8 | 1
076| 2.00 | 100.0 | 512 | 8 | 1
077| 2.00 | 200.0 | 512 | 8 | 1
078| 5.00 | 30.0 | 512 | 8 | 1
079| 5.00 | 60.0 | 512 | 8 | 1
080| 5.00 | 100.0 | 512 | 8 | 1
081| 5.00 | 200.0 | 512 | 8 | 1
082| 0.10 | 0.0 | 600 | 8 | 1
083| 1.00 | 0.0 | 600 | 8 | 1
084| 2.00 | 0.0 | 600 | 8 | 1
085| 5.00 | 0.0 | 600 | 8 | 1
086| 0.00 | 30.0 | 600 | 8 | 1
087| 0.00 | 60.0 | 600 | 8 | 1
088| 0.00 | 100.0 | 600 | 8 | 1
089| 0.00 | 200.0 | 600 | 8 | 1
090| 0.00 | 250.0 | 600 | 8 | 1
091| 0.01 | 60.0 | 600 | 6 | 1
092| 0.01 | 100.0 | 600 | 6 | 1
093| 0.01 | 200.0 | 600 | 6 | 1
094| 0.01 | 250.0 | 600 | 8 | 1
095| 0.10 | 60.0 | 600 | 8 | 1
096| 0.10 | 100.0 | 600 | 8 | 1
097| 0.10 | 200.0 | 600 | 8 | 1
098| 0.10 | 250.0 | 600 | 8 | 1
099| 0.50 | 30.0 | 600 | 8 | 1
100| 0.50 | 60.0 | 600 | 8 | 1
101| 0.50 | 100.0 | 600 | 8 | 1
102| 0.50 | 200.0 | 600 | 8 | 1
103| 0.50 | 250.0 | 600 | 8 | 1
104| 2.00 | 30.0 | 600 | 8 | 1
105| 2.00 | 60.0 | 600 | 8 | 1
106| 2.00 | 100.0 | 600 | 8 | 1
107| 2.00 | 200.0 | 600 | 8 | 1
108| 2.00 | 250.0 | 600 | 8 | 1
109| 5.00 | 30.0 | 600 | 8 | 1
110| 5.00 | 60.0 | 600 | 8 | 1
111| 5.00 | 100.0 | 600 | 8 | 1
112| 5.00 | 200.0 | 600 | 8 | 1
113| 5.00 | 250.0 | 600 | 8 | 1
114| 0.10 | 0.0 | 1200 | 8 | 1
115| 1.00 | 0.0 | 1200 | 8 | 1
116| 2.00 | 0.0 | 1200 | 8 | 1
117| 5.00 | 0.0 | 1200 | 8 | 1
118| 0.00 | 30.0 | 1200 | 8 | 1
119| 0.00 | 60.0 | 1200 | 8 | 1
120| 0.00 | 100.0 | 1200 | 8 | 1
121| 0.00 | 200.0 | 1200 | 8 | 1
122| 0.00 | 250.0 | 1200 | 8 | 1
123| 0.00 | 500.0 | 1200 | 8 | 1
124| 0.01 | 100.0 | 1200 | 6 | 1
125| 0.01 | 200.0 | 1200 | 6 | 1
126| 0.01 | 250.0 | 1200 | 6 | 1
127| 0.01 | 500.0 | 1200 | 6 | 1
128| 0.10 | 100.0 | 1200 | 6 | 1
129| 0.10 | 200.0 | 1200 | 8 | 1
130| 0.10 | 250.0 | 1200 | 8 | 1
131| 0.10 | 500.0 | 1200 | 8 | 1
132| 0.50 | 100.0 | 1200 | 8 | 1
133| 0.50 | 200.0 | 1200 | 8 | 1
134| 0.50 | 250.0 | 1200 | 8 | 1
135| 0.50 | 500.0 | 1200 | 8 | 1
136| 2.00 | 100.0 | 1200 | 8 | 1
137| 2.00 | 200.0 | 1200 | 8 | 1
138| 2.00 | 250.0 | 1200 | 8 | 1
139| 2.00 | 500.0 | 1200 | 8 | 1
140| 5.00 | 100.0 | 1200 | 8 | 1
141| 5.00 | 200.0 | 1200 | 8 | 1
142| 5.00 | 250.0 | 1200 | 8 | 1
143| 5.00 | 500.0 | 1200 | 8 | 1
144| 0.10 | 0.0 | 2400 | 8 | 1
145| 1.00 | 0.0 | 2400 | 8 | 1
146| 2.00 | 0.0 | 2400 | 8 | 1
147| 5.00 | 0.0 | 2400 | 8 | 1
148| 0.00 | 30.0 | 2400 | 8 | 1
149| 0.00 | 60.0 | 2400 | 8 | 1
150| 0.00 | 100.0 | 2400 | 8 | 1
151| 0.00 | 200.0 | 2400 | 8 | 1
152| 0.00 | 250.0 | 2400 | 8 | 1
153| 0.00 | 500.0 | 2400 | 8 | 1
154| 0.00 | 1000.0 | 2400 | 8 | 1
155| 0.01 | 200.0 | 2400 | 4 | 1
156| 0.01 | 250.0 | 2400 | 6 | 1
157| 0.01 | 500.0 | 2400 | 6 | 1
158| 0.01 | 1000.0 | 2400 | 6 | 1
159| 0.10 | 200.0 | 2400 | 6 | 1
160| 0.10 | 250.0 | 2400 | 6 | 1
161| 0.10 | 500.0 | 2400 | 8 | 1
162| 0.10 | 1000.0 | 2400 | 8 | 1
163| 0.50 | 200.0 | 2400 | 8 | 1
164| 0.50 | 250.0 | 2400 | 8 | 1
165| 0.50 | 500.0 | 2400 | 8 | 1
166| 0.50 | 1000.0 | 2400 | 8 | 1
167| 2.00 | 200.0 | 2400 | 8 | 1
168| 2.00 | 250.0 | 2400 | 8 | 1
169| 2.00 | 500.0 | 2400 | 8 | 1
170| 2.00 | 1000.0 | 2400 | 8 | 1
171| 5.00 | 200.0 | 2400 | 8 | 1
172| 5.00 | 250.0 | 2400 | 8 | 1
173| 5.00 | 500.0 | 2400 | 8 | 1
174| 5.00 | 1000.0 | 2400 | 8 | 1
175| 0.10 | 0.0 | 4800 | 6 | 1
176| 1.00 | 0.0 | 4800 | 8 | 1
177| 2.00 | 0.0 | 4800 | 8 | 1
178| 5.00 | 0.0 | 4800 | 8 | 1
179| 0.00 | 30.0 | 4800 | 8 | 1
180| 0.00 | 60.0 | 4800 | 8 | 1
181| 0.00 | 100.0 | 4800 | 8 | 1
182| 0.00 | 200.0 | 4800 | 8 | 1
183| 0.00 | 250.0 | 4800 | 8 | 1
184| 0.00 | 500.0 | 4800 | 8 | 1
185| 0.00 | 1000.0 | 4800 | 8 | 1
186| 0.00 | 2000.0 | 4800 | 8 | 1
187| 0.01 | 500.0 | 4800 | 6 | 1
188| 0.01 | 1000.0 | 4800 | 6 | 1
189| 0.01 | 2000.0 | 4800 | 6 | 1
190| 0.10 | 500.0 | 4800 | 6 | 1
191| 0.10 | 1000.0 | 4800 | 6 | 1
192| 0.10 | 2000.0 | 4800 | 8 | 1
193| 0.50 | 500.0 | 4800 | 8 | 1
194| 0.50 | 1000.0 | 4800 | 8 | 1
195| 0.50 | 2000.0 | 4800 | 8 | 1
196| 2.00 | 500.0 | 4800 | 8 | 1
197| 2.00 | 1000.0 | 4800 | 8 | 1
198| 2.00 | 2000.0 | 4800 | 8 | 1
199| 5.00 | 500.0 | 4800 | 8 | 1
200| 5.00 | 1000.0 | 4800 | 8 | 1
201| 5.00 | 2000.0 | 4800 | 8 | 1

Available notch filters
===================================
num| hpfr | lpfreq | sfr | or | type
===================================
000| 48.00 | 52.0 | 128 | 4 | 1
001| 58.00 | 62.0 | 128 | 4 | 1
002| 48.00 | 52.0 | 256 | 4 | 1
003| 58.00 | 62.0 | 256 | 4 | 1
004| 48.00 | 52.0 | 512 | 4 | 1
005| 58.00 | 62.0 | 512 | 4 | 1
006| 48.00 | 52.0 | 600 | 4 | 1
007| 58.00 | 62.0 | 600 | 4 | 1
008| 48.00 | 52.0 | 1200 | 4 | 1
009| 58.00 | 62.0 | 1200 | 4 | 1
010| 48.00 | 52.0 | 2400 | 4 | 1
011| 58.00 | 62.0 | 2400 | 4 | 1
012| 48.00 | 52.0 | 4800 | 4 | 1
013| 58.00 | 62.0 | 4800 | 4 | 1

</pre>

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

File:UBDigIn.JPG

2015-06-30T19:53:50Z

Kgoering: Figure of the two Dig I/O ports on gUSBamps with serial numbers starting with UB.

Figure of the two Dig I/O ports on gUSBamps with serial numbers starting with UB.

User Reference:gUSBampADC

2015-06-30T19:53:02Z

Kgoering: /* gUSBamps with UA serial numbers */

==Function==
The ''gUSBampADC'' filter acquires data from any number (tested up to four) ''g.USBamp'' EEG amplifiers.
''g.USBamp'' is an amplifier/digitizer combination from g.tec medical engineering GmbH/Guger Technologies OEG (http://www.gtec.at).
Support for this device in BCI2000 consists of two components: A BCI2000-compatible Source Module (''gUSBamp.exe'') and a
command-line tool (''USBampgetinfo'').

===g.USBamp Hardware===
The USBamp consists of 16 independent 24-bit A/D converters that can sample at
up to 38.4kHz per channel. Because there is one A/D converter for each channel,
one particular sample is digitized at the exact same time for each channel. This
is unlike with traditional A/D converter boards that only have one A/D
converter. BCI2000 has a feature that can align samples in time (parameter
[[User Reference:AlignmentFilter#AlignChannels|AlignChannels]]).
Because this feature is not needed in conjunction with the USBamp, it needs to be turned off (i.e., ''AlignChannels'' needs to be 0).

====Drivers====
With the release of the Version 3.0 g.USBamp, there is now a small problem with the gUSBamp.dll included in BCI2000. The DLL included with BCI2000 was intended to be used with g.USBamp Version 2.0 hardware. If Version 3.0 hardware is used with the current BCI2000 distribution, the gUSBampADC module will default to using the Version 2.0 DLL which will not function.

Drivers come with the g.USBamp hardware - the correct drivers to match the version of the hardware. If the installer is used to install the drivers for the g.USBamp, it will also place the g.USBamp DLL into your <tt>WINDOWS/system32</tt> folder. If the DLL in <tt>BCI2000/prog</tt> is deleted, the DLL appropriate for use with your g.USBamp hardware should be used.

In short, in order to make Version 3.0 amps work with the current BCI2000 distribution, simply delete the <tt>gUSBamp.dll</tt> file from your <tt>BCI2000/prog</tt> folder.

Here is a grid of what driver/amp/dll combinations work:

{|border="1"
|'''Version 2.0 amp'''
|2.0 DLL
|3.0 DLL
|-
|2.0 Driver
|Works
|Works
|-
|3.0 Driver
|Does Not Work
|Does Not Work
|}

{|border="1"
|'''Version 3.0 amp'''
|2.0 DLL
|3.0 DLL
|-
|2.0 Driver
|Does Not Work
|Does Not Work
|-
|3.0 Driver
|Does Not Work
|Works
|}

==Parameters==
Parameters common to all source modules are described under [[User Reference:DataIOFilter]].
In addition, the ''gUSBampADC'' provides the following parameters:

===DeviceIDMaster===
Serial number (e.g., UA-2007.01.01) of the master device.
If you only have one device, this parameter has to equal ''DeviceIDs''.
If you have more then one device, then this parameter represents the serial number of the device whose SYNC goes to the slaves, i.e., the only device that has a cable connected at SYNC OUT, but none connected to SYNC IN.
If only one device is connected, this parameter may be set to ''auto''.

===DeviceIDs===
List of serial numbers (e.g., UA-2007.01.01) of all devices.
If you have more than one device, this list determines the order of the channels in the data file.
If only one device is connected, this parameter may be set to ''auto''.

===FilterEnabled===
Choose 1 if you want a pass band filter, and 0 if you don't.
The gUSBamp is a DC amplifier and thus you most likely will want a pass band filter.
Please note that, because the g.USBamp internally has a 5kHz antialiasing filter and always samples with 38.4kHz, you DO NOT need to enable any filter if you do not want.
You will never experience aliasing.

===FilterHighPass===
High pass frequency for pass band.
You need to query the amp for possible values.
See description of the [[#The USBampgetinfo Command Line Tool|USBampgetinfo]] tool for more info.

===FilterLowPass===
Low pass frequency for pass band.
See description of the USBampgetinfo tool for more info.

===FilterModelOrder===
Model order for passband filter.
See description of the USBampgetinfo tool for more info.

===FilterType===
Type of passband filter:
* 1=CHEBYSHEV,
* 2=BUTTERWORTH.

===NotchEnabled===
Choose 1 if you want a notch filter, and 0 if you don't.

===NotchHighPass===
Similar to FilterHighPass.

===NotchLowPass===
Similar to FilterLowPass.

===NotchModelOrder===
Similar to FilterModelOrder.

===NotchType===
Similar to FilterType.

===SampleBlockSize===
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 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===
The sampling rate of all connected USBamps.
If one wants to use a bandpass or a notch filter, there needs to be a filter configuration for that particular sampling rate (see the section on the ''[USBampgetinfo]'' tool). (Guger Technologies can provide you with a new driver configuration file if you need a different filter.)

The USBamp supports the following sampling rates: 32, 64, 128, 256, 512, 600, 1200, 2400, 4800, 9600, 19200, and 38400 Hz. All sampling rates are supported for one or more amplifiers. If you are sampling at high rates and from multiple amplifiers, the CPU may be overloaded depending on the speed of your computer and the BCI2000 configuration. In case you are experiencing problems (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. For example, at 38400 Hz, 4 amplifiers (64 channels), and a system update of 30 Hz, the computer would have to draw more than 73 million lines per second in the Source display!

===SignalType===
Defines the data type of the stored signal samples (int16 or float32).
If the data type is int16, signal samples (which are produced by the amplifier in units of <math>\mu V</math>) are converted back into virtual A/D units (see Data Storage section below). If the data type is float32, the signals are stored in units of <math>\mu V</math>.
In this case, SourceChOffset should be 0, and SourceChGain should be
1 (since the conversion factor from <math>\mu V</math> into <math>\mu V</math> is 1).

===SourceCh===
The total number of channels across all USBamp devices.

===SourceChDevices===
The number of channels acquired from each device.
If there is only one device, this parameter has to equal ''SourceCh''.
For example, '16 8' will acquire channels from the first device listed under ''DeviceIDs'', and 8 channels from the second device listed under ''DeviceIDs''.
Data acquisition always starts at channel 1.
The sum of all channels (e.g., 24 in this example) has to
equal the value of ''SourceCh''.

===SourceChList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh''. For more than one device, ''SourceChDevices'' determines how the ''SourceChList'' values are mapped to each device. For example if ''SourceChDevices'' = '8 8' and ''SourceChList'' = '1 2 3 4 13 14 15 16 5 6 7 8 9 10 11 12', then channels 1-4 and 13-16 will be acquired on the first device, and channels 5-12 will be acquired on the second device. These channels will be saved in the data file as 16 contiguous channels.
The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'. The channels are always in ascending order on a single device.
Channels may not be listed twice on a single device; e.g., entering '1 2 3 4 5 6 7 1' if ''SourceChDevices'' = '8' will result in an error.
If this parameter is left blank (the default), then all channels are acquired on all devices.

===BipolarChList===
A list of channels used for a bipolar montage. Each entry is configured as the reference for a source channel, based on the channel order. The number of values should equal both ''SourceCh'' and the number of values in ''SourceChList'' (if ''SourceChList'' is not empty). If ''BipolarChList'' is empty, then the standard referential recording montage is used. If a value of '0' is entered, then the reference channel is used for that channel. Finally, channel labels may be used.

As an example, a sequential bipolar montage for 8 channels could be configured like:

<tt>2 3 4 5 6 7 8 1</tt>

meaning that channel 1 is referenced to channel 2, channel 2 is referenced to channel 3, and so on. For another example, 10 channels can be configured so that the first 6 are bipolar, and the last four are referential, e.g.:

<tt>C3 F3 C4 F4 Pz Oz 0 0 0 0</tt>

===EnableDigitalInput===
Enable digital input.
If enabled, the sampled values of the digital input from the digital I/O ports will be stored in to states DigitalInput1 - DigitalInput64 depending on the number of amps connected and hardware versions. See [[:User Reference:gUSBampADC#Digital Input|Digital Input]] for more information.

===EnableDigitalOutput===
Enable digital output. If enabled, the digital output is set to the values returned when the signals go through the expressions given by the Parameter DigitalOutputEx. See [[:User Reference:gUSBampADC#Digital Output|Digital Output]] for more information.

===DigitalOutputEx===
If digital output is turned on, the given expressions will be evaluated for the current input. If the expression evaluates true the bit is set to high, else set to low. Each expression represents a different bit and the number starts with the master and is continuous through all amps like digital input. Boolean expressions work well for this ( ex. <tt>( ( StimulusCode == 0 ) && Running )</tt> ). See [[:User Reference:Expression Syntax|Expressions]] for more information on how to write expressions.

===AcquisitionMode===
If set to ''analog signal acquisition'', the g.USBamp records analog signal voltages (default). If set to ''Calibration'', the signal output is a sine wave test signal generated by the g.USBamp (which can be used to verify correct system calibration).
If set to ''Impedance'', regular analog signal acquisition is preceded by an impedance test.
This impedance test reports input impedances for each channel in kOhms.
In impedance mode, if the ground and reference is connected in the amp internally (using the ''CommonGround'' and ''CommonReference'' parameters), then you need to connect the ground and reference to block 4.

===CommonGround===
This parameter determines whether the g.USBamp internally connects the GND inputs from all blocks together.
If enabled (default), then the signal ground only needs to be connected to one input block, e.g., block 1.
Otherwise, all GND inputs need to be externally connected.

===CommonReference===
The same as ''CommonGround'', except for the signal reference.

==Digital I/O==

===Digital Inputs===
Can be used with 1 - 8 gUSBamps.

====gUSBamps with UA serial numbers====
[[File:UADigIn.JPG]]

Each gUSBamp has only one digital I/O port and this is stored in only one state per an gUSBamp. If multiple UA gUSBamps are connected in sync then up to state DigitalInput8 will be used, with the master gUSBamp using DigitalInput1 and the last slave gUSBamp using DigitalInput8 if 8 gUSBamps are used, or DigitalInput6 if only 6 gUSBamps are used. To access the digital input from any gUSBamp, access the state DigitalInput for the number of that slave gUSBamp. For example if I wanted to access the 5th gUSBamp, I would access DigitalInput5.

====gUSBamps with UB serial numbers====
Each gUSBamp has two digital I/O ports which are stored in eight states per gUSBamp. If multiple UB gUSBamp are connected in sync then up to state DigitalInput64 will be used with the master gUSBamp using DigitalInput1 - DigitalInput8 and the last gUSBamp using DigitalInput57 - DigitalInput64 if 8 gUSBamps are used, and DigitalInput41 - DigitalInput48 if only 6 gUSBamps are used. To access the digital input from any gUSBamp, take the number of gUSBamps preceding the intended gUSBamp multiplied by 8, then add the number of the bit you want to see. For example, if I wanted to access the 5th gUSBamp's 5th bit, I would look at DigitalInput37 (4 * 8 + 5).

====g.USBamps in sync with both UA and UB serial numbers====
The device specifications are the same as above and each gUSBamp only has the number of states designated to it as specified above, i.e. each UB gUSBamp has eight states and each UA gUSBamp has only one state. The numbering of the states are based on the order of the gUSBamps. For example, if we have the following setup: UB gUSBamp as master with slaves in the following order: UB UA UA UB UA UA, which gives a total of 7 gUSBamps using DigitalInput1 - DigitalInput24 (3 * 8 + 4 * 1).For example, to access the second UA gUSBamp (which has only one state), I would look at DigitalInput18, found by the number of UB gUSBamps preceding the second UA gUSBamp multiplied by 8 plus the number of UA gUSBamps preceding it plus one for the gUSBamp itself (2 * 8 + 1 + 1). To access the third UB gUSBamp's seventh bit, I would look at DigitalInput25. This was found in the same manner as above but because it is a UB gUSBamp the specific bit is added instead of just one (2 * 8 + 2 + 7).

To setup a link between gUSBamps UA and UB, the following images show how to connect them.

[[File:UAUBcombo.JPG]]

[[File:UAUBmultiple.JPG]]

===Digital Output===
Can be used with 1 - 8 gUSBamps.

====gUSBamps with UA serial numbers====
Each gUSBamp has one digital I/O port giving it two digital output bits. If multiple UA gUSBamps are connected there are a total of 16 digital output bits possible. To write to these bits, Parameter DigitalOutputEx must be filled. Each row correlates to a bit. The numbering of the bits start with 1 and 2 being the master gUSBamp and continues numbering until the eighth gUSBamp having bit 15 and 16. To determine which row to use, the bit is found by taking the number of amgUSBampsps preceding the intended gUSBamp in the chain multiplied by two and then add the number of the bit you want to write for. For example, the second bit of the fourth gUSBamp is row 8 (3 * 2 + 2).

====gUSBamps with UB serial numbers====
Each gUSBamp has two digital I/O ports giving it four digital output bits. If multiple UB gUSBamps are connected, that gives a total of 32 digital output bits possible. To write to these bits, Parameter DigitalOutputEx must be filled. Each row corresponds to a bit. The numbering of the bits start with 1 - 4 being the master gUSBamp and continues numbering until the eighth gUSBamp having bits 29 - 32. To figure out which row to use, the formula is the number of gUSBamps preceding the intended gUSBamp in the chain multiplied by four and then add the number of the bit you want to write for. For example the second bit of the fourth gUSBamp is row 14 (3 * 4 + 2).

====gUSBamps in sync with both UA and UB serial numbers====
The device specs are the same as above with each UA gUSBamp having two digital output bits and each UB gUSBamp having four digital output bits. To write the proper row, the order of the gUSBamps matter just like digital input. For example we have the setup of UB gUSBamp as master with the slaves in the following order: UB UA UA UB UA UA, which gives a total of 7 gUSBamps having a total of 20 digital output bits. To find the row that corresponds with the bit you want to write for, take the number of UB gUSBamps preceding the intended gUSBamp in the chain multiplied by 4 and add the number of UA gUSBamps preceding the intended gUSBamp in the chain multiplied by 2 and add the number of the bit you want. For example to write the expression for the second UA gUSBamp's first bit, I would write the expression in row 11 (2 * 4 + 1 * 2 + 1). For example to write the expression for the third UB gUSBamp's third bit, I would write the expression in row 15 (2 * 4 + 2 * 2 + 3).

==States==

===DigitalInput===
DigitalInput ranges from DigitalInput1 - DigitalInput64 (see [[:User Reference:gUSBampADC#Digital Input|Digital Input]] for explanation) and the values are either a 0 or a 1.

==Additional Information==

===Using 32bit Executables on 64bit Installations===
BCI2000 supports compilation of the gUSBamp source module for 64bit targets. The resulting executable will run on 64bit systems, and work with the 64bit version of the gUSBamp drivers. However, the binary distribution of BCI2000 contains 32bit executables. These run fine under 64bit systems, but you will need to perform these additional driver installation steps to install 32bit gUSBamp API DLLs on 64bit systems:
*Execute gtec's 32bit driver installer on your 64bit system.
*After successful installation, execute gtec's 64bit driver installer on your 64bit system.
*You will now have both the 32bit API DLL and the 64bit API DLL installed, such that both 32bit and 64bit executables will be able to connect to a gUSBamp attached to the system's USB ports.

===Data Storage===
Unlike other systems, the USBamp is a DC amplifier system that digitizes at 24 bit.
Bandpass and notch filtering is performed on the digitized samples, resulting in floating point signal samples in units of <math>\mu V</math>.
BCI2000 currently supports signed 16 bit integers and floating point numbers for its data storage.
If ''SignalType'' is set to int16, the floating point values have to be converted back into integers before they can be stored and transmitted to Signal Processing.
This is done by the following transformation:

<math>\mathrm{sample}_\mathrm{stored}\mathrm{(A/D\,units)}=\frac{\mathrm{sample}_\mathrm{acquired}(\mu V)}\mathrm{SourceChGain}</math>.

(''SourceChOffset'' is assumed (and required) to be zero for all channels.)
BCI2000 Signal Processing or any offline analysis routine can derive, as with
any other BCI2000 source module, sample values in <math>\mu V</math> by subtracting, from
each stored sample, ''SourceChOffset'' (i.e., zero), and multiplying it with
''SourceChGain'' for each channel. If ''SignalType'' is set to float32,
data samples are stored in units of <math>\mu V</math>. In this case, ''SourceChGain'' should be
a list of 1's (because the conversion factor between data samples into <math>\mu V</math> is
1.0 for each channel).

Still, when values other than 0 and 1 are specified, a consistent data file will be produced, i.e. values will be transformed before they are written to the file, such that applying SourceChOffset and SourceChGain will reproduce the original values in <math>\mu V</math>.

===The ''USBampgetinfo'' Command Line Tool===
This command line tool displays all connected USBamps, including their serial
number and the USB port that they connect to. Further, this tool reads, for the
first of the connected amplifiers, all supported bandpass and notch filter
configurations. Thus, this tool can be used to determine which filters can be
used for a particular sampling frequency within BCI2000. The following is an
example screen output:

<pre>
*******************************************
BCI2000 Information Tool for g.USBamp
*******************************************
(C)2004 Gerwin Schalk
Wadsworth Center
New York State Department of Health
Albany, NY, USA
*******************************************
Amp found at USB address 1 (S/N: UA-200X.XX.XX)
Printing info for first amp (USB address 1)

Available bandpass filters
===================================
num| hpfr | lpfreq | sfr | or | type
===================================
000| 0.10 | 0.0 | 32 | 8 | 1
001| 1.00 | 0.0 | 32 | 8 | 1
002| 2.00 | 0.0 | 32 | 8 | 1
003| 5.00 | 0.0 | 32 | 8 | 1
004| 0.00 | 15.0 | 32 | 8 | 1
005| 0.01 | 15.0 | 32 | 8 | 1
006| 0.10 | 15.0 | 32 | 8 | 1
007| 0.50 | 15.0 | 32 | 8 | 1
008| 2.00 | 15.0 | 32 | 8 | 1
009| 0.10 | 0.0 | 64 | 8 | 1
010| 1.00 | 0.0 | 64 | 8 | 1
011| 2.00 | 0.0 | 64 | 8 | 1
012| 5.00 | 0.0 | 64 | 8 | 1
013| 0.00 | 30.0 | 64 | 8 | 1
014| 0.01 | 30.0 | 64 | 8 | 1
015| 0.10 | 30.0 | 64 | 8 | 1
016| 0.50 | 30.0 | 64 | 8 | 1
017| 2.00 | 30.0 | 64 | 8 | 1
018| 0.10 | 0.0 | 128 | 8 | 1
019| 1.00 | 0.0 | 128 | 8 | 1
020| 2.00 | 0.0 | 128 | 8 | 1
021| 5.00 | 0.0 | 128 | 8 | 1
022| 0.00 | 30.0 | 128 | 8 | 1
023| 0.00 | 60.0 | 128 | 8 | 1
024| 0.01 | 30.0 | 128 | 8 | 1
025| 0.01 | 60.0 | 128 | 8 | 1
026| 0.10 | 30.0 | 128 | 8 | 1
027| 0.10 | 60.0 | 128 | 8 | 1
028| 0.50 | 30.0 | 128 | 8 | 1
029| 0.50 | 60.0 | 128 | 8 | 1
030| 2.00 | 30.0 | 128 | 8 | 1
031| 2.00 | 60.0 | 128 | 8 | 1
032| 0.10 | 0.0 | 256 | 8 | 1
033| 1.00 | 0.0 | 256 | 8 | 1
034| 2.00 | 0.0 | 256 | 8 | 1
035| 5.00 | 0.0 | 256 | 8 | 1
036| 0.00 | 30.0 | 256 | 8 | 1
037| 0.00 | 60.0 | 256 | 8 | 1
038| 0.00 | 100.0 | 256 | 8 | 1
039| 0.01 | 30.0 | 256 | 6 | 1
040| 0.01 | 60.0 | 256 | 8 | 1
041| 0.01 | 100.0 | 256 | 8 | 1
042| 0.10 | 30.0 | 256 | 8 | 1
043| 0.10 | 60.0 | 256 | 8 | 1
044| 0.10 | 100.0 | 256 | 8 | 1
045| 0.50 | 30.0 | 256 | 8 | 1
046| 0.50 | 60.0 | 256 | 8 | 1
047| 0.50 | 100.0 | 256 | 8 | 1
048| 2.00 | 30.0 | 256 | 8 | 1
049| 2.00 | 60.0 | 256 | 8 | 1
050| 2.00 | 100.0 | 256 | 8 | 1
051| 5.00 | 30.0 | 256 | 8 | 1
052| 5.00 | 60.0 | 256 | 8 | 1
053| 5.00 | 100.0 | 256 | 8 | 1
054| 0.10 | 0.0 | 512 | 8 | 1
055| 1.00 | 0.0 | 512 | 8 | 1
056| 2.00 | 0.0 | 512 | 8 | 1
057| 5.00 | 0.0 | 512 | 8 | 1
058| 0.00 | 30.0 | 512 | 8 | 1
059| 0.00 | 60.0 | 512 | 8 | 1
060| 0.00 | 100.0 | 512 | 8 | 1
061| 0.00 | 200.0 | 512 | 8 | 1
062| 0.01 | 30.0 | 512 | 6 | 1
063| 0.01 | 60.0 | 512 | 6 | 1
064| 0.01 | 100.0 | 512 | 6 | 1
065| 0.01 | 200.0 | 512 | 8 | 1
066| 0.10 | 30.0 | 512 | 8 | 1
067| 0.10 | 60.0 | 512 | 8 | 1
068| 0.10 | 100.0 | 512 | 8 | 1
069| 0.10 | 200.0 | 512 | 8 | 1
070| 0.50 | 30.0 | 512 | 8 | 1
071| 0.50 | 60.0 | 512 | 8 | 1
072| 0.50 | 100.0 | 512 | 8 | 1
073| 0.50 | 200.0 | 512 | 8 | 1
074| 2.00 | 30.0 | 512 | 8 | 1
075| 2.00 | 60.0 | 512 | 8 | 1
076| 2.00 | 100.0 | 512 | 8 | 1
077| 2.00 | 200.0 | 512 | 8 | 1
078| 5.00 | 30.0 | 512 | 8 | 1
079| 5.00 | 60.0 | 512 | 8 | 1
080| 5.00 | 100.0 | 512 | 8 | 1
081| 5.00 | 200.0 | 512 | 8 | 1
082| 0.10 | 0.0 | 600 | 8 | 1
083| 1.00 | 0.0 | 600 | 8 | 1
084| 2.00 | 0.0 | 600 | 8 | 1
085| 5.00 | 0.0 | 600 | 8 | 1
086| 0.00 | 30.0 | 600 | 8 | 1
087| 0.00 | 60.0 | 600 | 8 | 1
088| 0.00 | 100.0 | 600 | 8 | 1
089| 0.00 | 200.0 | 600 | 8 | 1
090| 0.00 | 250.0 | 600 | 8 | 1
091| 0.01 | 60.0 | 600 | 6 | 1
092| 0.01 | 100.0 | 600 | 6 | 1
093| 0.01 | 200.0 | 600 | 6 | 1
094| 0.01 | 250.0 | 600 | 8 | 1
095| 0.10 | 60.0 | 600 | 8 | 1
096| 0.10 | 100.0 | 600 | 8 | 1
097| 0.10 | 200.0 | 600 | 8 | 1
098| 0.10 | 250.0 | 600 | 8 | 1
099| 0.50 | 30.0 | 600 | 8 | 1
100| 0.50 | 60.0 | 600 | 8 | 1
101| 0.50 | 100.0 | 600 | 8 | 1
102| 0.50 | 200.0 | 600 | 8 | 1
103| 0.50 | 250.0 | 600 | 8 | 1
104| 2.00 | 30.0 | 600 | 8 | 1
105| 2.00 | 60.0 | 600 | 8 | 1
106| 2.00 | 100.0 | 600 | 8 | 1
107| 2.00 | 200.0 | 600 | 8 | 1
108| 2.00 | 250.0 | 600 | 8 | 1
109| 5.00 | 30.0 | 600 | 8 | 1
110| 5.00 | 60.0 | 600 | 8 | 1
111| 5.00 | 100.0 | 600 | 8 | 1
112| 5.00 | 200.0 | 600 | 8 | 1
113| 5.00 | 250.0 | 600 | 8 | 1
114| 0.10 | 0.0 | 1200 | 8 | 1
115| 1.00 | 0.0 | 1200 | 8 | 1
116| 2.00 | 0.0 | 1200 | 8 | 1
117| 5.00 | 0.0 | 1200 | 8 | 1
118| 0.00 | 30.0 | 1200 | 8 | 1
119| 0.00 | 60.0 | 1200 | 8 | 1
120| 0.00 | 100.0 | 1200 | 8 | 1
121| 0.00 | 200.0 | 1200 | 8 | 1
122| 0.00 | 250.0 | 1200 | 8 | 1
123| 0.00 | 500.0 | 1200 | 8 | 1
124| 0.01 | 100.0 | 1200 | 6 | 1
125| 0.01 | 200.0 | 1200 | 6 | 1
126| 0.01 | 250.0 | 1200 | 6 | 1
127| 0.01 | 500.0 | 1200 | 6 | 1
128| 0.10 | 100.0 | 1200 | 6 | 1
129| 0.10 | 200.0 | 1200 | 8 | 1
130| 0.10 | 250.0 | 1200 | 8 | 1
131| 0.10 | 500.0 | 1200 | 8 | 1
132| 0.50 | 100.0 | 1200 | 8 | 1
133| 0.50 | 200.0 | 1200 | 8 | 1
134| 0.50 | 250.0 | 1200 | 8 | 1
135| 0.50 | 500.0 | 1200 | 8 | 1
136| 2.00 | 100.0 | 1200 | 8 | 1
137| 2.00 | 200.0 | 1200 | 8 | 1
138| 2.00 | 250.0 | 1200 | 8 | 1
139| 2.00 | 500.0 | 1200 | 8 | 1
140| 5.00 | 100.0 | 1200 | 8 | 1
141| 5.00 | 200.0 | 1200 | 8 | 1
142| 5.00 | 250.0 | 1200 | 8 | 1
143| 5.00 | 500.0 | 1200 | 8 | 1
144| 0.10 | 0.0 | 2400 | 8 | 1
145| 1.00 | 0.0 | 2400 | 8 | 1
146| 2.00 | 0.0 | 2400 | 8 | 1
147| 5.00 | 0.0 | 2400 | 8 | 1
148| 0.00 | 30.0 | 2400 | 8 | 1
149| 0.00 | 60.0 | 2400 | 8 | 1
150| 0.00 | 100.0 | 2400 | 8 | 1
151| 0.00 | 200.0 | 2400 | 8 | 1
152| 0.00 | 250.0 | 2400 | 8 | 1
153| 0.00 | 500.0 | 2400 | 8 | 1
154| 0.00 | 1000.0 | 2400 | 8 | 1
155| 0.01 | 200.0 | 2400 | 4 | 1
156| 0.01 | 250.0 | 2400 | 6 | 1
157| 0.01 | 500.0 | 2400 | 6 | 1
158| 0.01 | 1000.0 | 2400 | 6 | 1
159| 0.10 | 200.0 | 2400 | 6 | 1
160| 0.10 | 250.0 | 2400 | 6 | 1
161| 0.10 | 500.0 | 2400 | 8 | 1
162| 0.10 | 1000.0 | 2400 | 8 | 1
163| 0.50 | 200.0 | 2400 | 8 | 1
164| 0.50 | 250.0 | 2400 | 8 | 1
165| 0.50 | 500.0 | 2400 | 8 | 1
166| 0.50 | 1000.0 | 2400 | 8 | 1
167| 2.00 | 200.0 | 2400 | 8 | 1
168| 2.00 | 250.0 | 2400 | 8 | 1
169| 2.00 | 500.0 | 2400 | 8 | 1
170| 2.00 | 1000.0 | 2400 | 8 | 1
171| 5.00 | 200.0 | 2400 | 8 | 1
172| 5.00 | 250.0 | 2400 | 8 | 1
173| 5.00 | 500.0 | 2400 | 8 | 1
174| 5.00 | 1000.0 | 2400 | 8 | 1
175| 0.10 | 0.0 | 4800 | 6 | 1
176| 1.00 | 0.0 | 4800 | 8 | 1
177| 2.00 | 0.0 | 4800 | 8 | 1
178| 5.00 | 0.0 | 4800 | 8 | 1
179| 0.00 | 30.0 | 4800 | 8 | 1
180| 0.00 | 60.0 | 4800 | 8 | 1
181| 0.00 | 100.0 | 4800 | 8 | 1
182| 0.00 | 200.0 | 4800 | 8 | 1
183| 0.00 | 250.0 | 4800 | 8 | 1
184| 0.00 | 500.0 | 4800 | 8 | 1
185| 0.00 | 1000.0 | 4800 | 8 | 1
186| 0.00 | 2000.0 | 4800 | 8 | 1
187| 0.01 | 500.0 | 4800 | 6 | 1
188| 0.01 | 1000.0 | 4800 | 6 | 1
189| 0.01 | 2000.0 | 4800 | 6 | 1
190| 0.10 | 500.0 | 4800 | 6 | 1
191| 0.10 | 1000.0 | 4800 | 6 | 1
192| 0.10 | 2000.0 | 4800 | 8 | 1
193| 0.50 | 500.0 | 4800 | 8 | 1
194| 0.50 | 1000.0 | 4800 | 8 | 1
195| 0.50 | 2000.0 | 4800 | 8 | 1
196| 2.00 | 500.0 | 4800 | 8 | 1
197| 2.00 | 1000.0 | 4800 | 8 | 1
198| 2.00 | 2000.0 | 4800 | 8 | 1
199| 5.00 | 500.0 | 4800 | 8 | 1
200| 5.00 | 1000.0 | 4800 | 8 | 1
201| 5.00 | 2000.0 | 4800 | 8 | 1

Available notch filters
===================================
num| hpfr | lpfreq | sfr | or | type
===================================
000| 48.00 | 52.0 | 128 | 4 | 1
001| 58.00 | 62.0 | 128 | 4 | 1
002| 48.00 | 52.0 | 256 | 4 | 1
003| 58.00 | 62.0 | 256 | 4 | 1
004| 48.00 | 52.0 | 512 | 4 | 1
005| 58.00 | 62.0 | 512 | 4 | 1
006| 48.00 | 52.0 | 600 | 4 | 1
007| 58.00 | 62.0 | 600 | 4 | 1
008| 48.00 | 52.0 | 1200 | 4 | 1
009| 58.00 | 62.0 | 1200 | 4 | 1
010| 48.00 | 52.0 | 2400 | 4 | 1
011| 58.00 | 62.0 | 2400 | 4 | 1
012| 48.00 | 52.0 | 4800 | 4 | 1
013| 58.00 | 62.0 | 4800 | 4 | 1

</pre>

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

File:UADigIn.JPG

2015-06-30T19:52:39Z

Kgoering: Figure of the Dig I/O port on gUSBamps with serial numbers starting with UA.

Figure of the Dig I/O port on gUSBamps with serial numbers starting with UA.

User Reference:gUSBampADC

2015-06-30T19:51:07Z

Kgoering: /* g.USBamps in sync with both UA and UB serial numbers */

==Function==
The ''gUSBampADC'' filter acquires data from any number (tested up to four) ''g.USBamp'' EEG amplifiers.
''g.USBamp'' is an amplifier/digitizer combination from g.tec medical engineering GmbH/Guger Technologies OEG (http://www.gtec.at).
Support for this device in BCI2000 consists of two components: A BCI2000-compatible Source Module (''gUSBamp.exe'') and a
command-line tool (''USBampgetinfo'').

===g.USBamp Hardware===
The USBamp consists of 16 independent 24-bit A/D converters that can sample at
up to 38.4kHz per channel. Because there is one A/D converter for each channel,
one particular sample is digitized at the exact same time for each channel. This
is unlike with traditional A/D converter boards that only have one A/D
converter. BCI2000 has a feature that can align samples in time (parameter
[[User Reference:AlignmentFilter#AlignChannels|AlignChannels]]).
Because this feature is not needed in conjunction with the USBamp, it needs to be turned off (i.e., ''AlignChannels'' needs to be 0).

====Drivers====
With the release of the Version 3.0 g.USBamp, there is now a small problem with the gUSBamp.dll included in BCI2000. The DLL included with BCI2000 was intended to be used with g.USBamp Version 2.0 hardware. If Version 3.0 hardware is used with the current BCI2000 distribution, the gUSBampADC module will default to using the Version 2.0 DLL which will not function.

Drivers come with the g.USBamp hardware - the correct drivers to match the version of the hardware. If the installer is used to install the drivers for the g.USBamp, it will also place the g.USBamp DLL into your <tt>WINDOWS/system32</tt> folder. If the DLL in <tt>BCI2000/prog</tt> is deleted, the DLL appropriate for use with your g.USBamp hardware should be used.

In short, in order to make Version 3.0 amps work with the current BCI2000 distribution, simply delete the <tt>gUSBamp.dll</tt> file from your <tt>BCI2000/prog</tt> folder.

Here is a grid of what driver/amp/dll combinations work:

{|border="1"
|'''Version 2.0 amp'''
|2.0 DLL
|3.0 DLL
|-
|2.0 Driver
|Works
|Works
|-
|3.0 Driver
|Does Not Work
|Does Not Work
|}

{|border="1"
|'''Version 3.0 amp'''
|2.0 DLL
|3.0 DLL
|-
|2.0 Driver
|Does Not Work
|Does Not Work
|-
|3.0 Driver
|Does Not Work
|Works
|}

==Parameters==
Parameters common to all source modules are described under [[User Reference:DataIOFilter]].
In addition, the ''gUSBampADC'' provides the following parameters:

===DeviceIDMaster===
Serial number (e.g., UA-2007.01.01) of the master device.
If you only have one device, this parameter has to equal ''DeviceIDs''.
If you have more then one device, then this parameter represents the serial number of the device whose SYNC goes to the slaves, i.e., the only device that has a cable connected at SYNC OUT, but none connected to SYNC IN.
If only one device is connected, this parameter may be set to ''auto''.

===DeviceIDs===
List of serial numbers (e.g., UA-2007.01.01) of all devices.
If you have more than one device, this list determines the order of the channels in the data file.
If only one device is connected, this parameter may be set to ''auto''.

===FilterEnabled===
Choose 1 if you want a pass band filter, and 0 if you don't.
The gUSBamp is a DC amplifier and thus you most likely will want a pass band filter.
Please note that, because the g.USBamp internally has a 5kHz antialiasing filter and always samples with 38.4kHz, you DO NOT need to enable any filter if you do not want.
You will never experience aliasing.

===FilterHighPass===
High pass frequency for pass band.
You need to query the amp for possible values.
See description of the [[#The USBampgetinfo Command Line Tool|USBampgetinfo]] tool for more info.

===FilterLowPass===
Low pass frequency for pass band.
See description of the USBampgetinfo tool for more info.

===FilterModelOrder===
Model order for passband filter.
See description of the USBampgetinfo tool for more info.

===FilterType===
Type of passband filter:
* 1=CHEBYSHEV,
* 2=BUTTERWORTH.

===NotchEnabled===
Choose 1 if you want a notch filter, and 0 if you don't.

===NotchHighPass===
Similar to FilterHighPass.

===NotchLowPass===
Similar to FilterLowPass.

===NotchModelOrder===
Similar to FilterModelOrder.

===NotchType===
Similar to FilterType.

===SampleBlockSize===
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 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===
The sampling rate of all connected USBamps.
If one wants to use a bandpass or a notch filter, there needs to be a filter configuration for that particular sampling rate (see the section on the ''[USBampgetinfo]'' tool). (Guger Technologies can provide you with a new driver configuration file if you need a different filter.)

The USBamp supports the following sampling rates: 32, 64, 128, 256, 512, 600, 1200, 2400, 4800, 9600, 19200, and 38400 Hz. All sampling rates are supported for one or more amplifiers. If you are sampling at high rates and from multiple amplifiers, the CPU may be overloaded depending on the speed of your computer and the BCI2000 configuration. In case you are experiencing problems (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. For example, at 38400 Hz, 4 amplifiers (64 channels), and a system update of 30 Hz, the computer would have to draw more than 73 million lines per second in the Source display!

===SignalType===
Defines the data type of the stored signal samples (int16 or float32).
If the data type is int16, signal samples (which are produced by the amplifier in units of <math>\mu V</math>) are converted back into virtual A/D units (see Data Storage section below). If the data type is float32, the signals are stored in units of <math>\mu V</math>.
In this case, SourceChOffset should be 0, and SourceChGain should be
1 (since the conversion factor from <math>\mu V</math> into <math>\mu V</math> is 1).

===SourceCh===
The total number of channels across all USBamp devices.

===SourceChDevices===
The number of channels acquired from each device.
If there is only one device, this parameter has to equal ''SourceCh''.
For example, '16 8' will acquire channels from the first device listed under ''DeviceIDs'', and 8 channels from the second device listed under ''DeviceIDs''.
Data acquisition always starts at channel 1.
The sum of all channels (e.g., 24 in this example) has to
equal the value of ''SourceCh''.

===SourceChList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh''. For more than one device, ''SourceChDevices'' determines how the ''SourceChList'' values are mapped to each device. For example if ''SourceChDevices'' = '8 8' and ''SourceChList'' = '1 2 3 4 13 14 15 16 5 6 7 8 9 10 11 12', then channels 1-4 and 13-16 will be acquired on the first device, and channels 5-12 will be acquired on the second device. These channels will be saved in the data file as 16 contiguous channels.
The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'. The channels are always in ascending order on a single device.
Channels may not be listed twice on a single device; e.g., entering '1 2 3 4 5 6 7 1' if ''SourceChDevices'' = '8' will result in an error.
If this parameter is left blank (the default), then all channels are acquired on all devices.

===BipolarChList===
A list of channels used for a bipolar montage. Each entry is configured as the reference for a source channel, based on the channel order. The number of values should equal both ''SourceCh'' and the number of values in ''SourceChList'' (if ''SourceChList'' is not empty). If ''BipolarChList'' is empty, then the standard referential recording montage is used. If a value of '0' is entered, then the reference channel is used for that channel. Finally, channel labels may be used.

As an example, a sequential bipolar montage for 8 channels could be configured like:

<tt>2 3 4 5 6 7 8 1</tt>

meaning that channel 1 is referenced to channel 2, channel 2 is referenced to channel 3, and so on. For another example, 10 channels can be configured so that the first 6 are bipolar, and the last four are referential, e.g.:

<tt>C3 F3 C4 F4 Pz Oz 0 0 0 0</tt>

===EnableDigitalInput===
Enable digital input.
If enabled, the sampled values of the digital input from the digital I/O ports will be stored in to states DigitalInput1 - DigitalInput64 depending on the number of amps connected and hardware versions. See [[:User Reference:gUSBampADC#Digital Input|Digital Input]] for more information.

===EnableDigitalOutput===
Enable digital output. If enabled, the digital output is set to the values returned when the signals go through the expressions given by the Parameter DigitalOutputEx. See [[:User Reference:gUSBampADC#Digital Output|Digital Output]] for more information.

===DigitalOutputEx===
If digital output is turned on, the given expressions will be evaluated for the current input. If the expression evaluates true the bit is set to high, else set to low. Each expression represents a different bit and the number starts with the master and is continuous through all amps like digital input. Boolean expressions work well for this ( ex. <tt>( ( StimulusCode == 0 ) && Running )</tt> ). See [[:User Reference:Expression Syntax|Expressions]] for more information on how to write expressions.

===AcquisitionMode===
If set to ''analog signal acquisition'', the g.USBamp records analog signal voltages (default). If set to ''Calibration'', the signal output is a sine wave test signal generated by the g.USBamp (which can be used to verify correct system calibration).
If set to ''Impedance'', regular analog signal acquisition is preceded by an impedance test.
This impedance test reports input impedances for each channel in kOhms.
In impedance mode, if the ground and reference is connected in the amp internally (using the ''CommonGround'' and ''CommonReference'' parameters), then you need to connect the ground and reference to block 4.

===CommonGround===
This parameter determines whether the g.USBamp internally connects the GND inputs from all blocks together.
If enabled (default), then the signal ground only needs to be connected to one input block, e.g., block 1.
Otherwise, all GND inputs need to be externally connected.

===CommonReference===
The same as ''CommonGround'', except for the signal reference.

==Digital I/O==

===Digital Inputs===
Can be used with 1 - 8 gUSBamps.

====gUSBamps with UA serial numbers====
Each gUSBamp has only one digital I/O port and this is stored in only one state per an gUSBamp. If multiple UA gUSBamps are connected in sync then up to state DigitalInput8 will be used, with the master gUSBamp using DigitalInput1 and the last slave gUSBamp using DigitalInput8 if 8 gUSBamps are used, or DigitalInput6 if only 6 gUSBamps are used. To access the digital input from any gUSBamp, access the state DigitalInput for the number of that slave gUSBamp. For example if I wanted to access the 5th gUSBamp, I would access DigitalInput5.

====gUSBamps with UB serial numbers====
Each gUSBamp has two digital I/O ports which are stored in eight states per gUSBamp. If multiple UB gUSBamp are connected in sync then up to state DigitalInput64 will be used with the master gUSBamp using DigitalInput1 - DigitalInput8 and the last gUSBamp using DigitalInput57 - DigitalInput64 if 8 gUSBamps are used, and DigitalInput41 - DigitalInput48 if only 6 gUSBamps are used. To access the digital input from any gUSBamp, take the number of gUSBamps preceding the intended gUSBamp multiplied by 8, then add the number of the bit you want to see. For example, if I wanted to access the 5th gUSBamp's 5th bit, I would look at DigitalInput37 (4 * 8 + 5).

====g.USBamps in sync with both UA and UB serial numbers====
The device specifications are the same as above and each gUSBamp only has the number of states designated to it as specified above, i.e. each UB gUSBamp has eight states and each UA gUSBamp has only one state. The numbering of the states are based on the order of the gUSBamps. For example, if we have the following setup: UB gUSBamp as master with slaves in the following order: UB UA UA UB UA UA, which gives a total of 7 gUSBamps using DigitalInput1 - DigitalInput24 (3 * 8 + 4 * 1).For example, to access the second UA gUSBamp (which has only one state), I would look at DigitalInput18, found by the number of UB gUSBamps preceding the second UA gUSBamp multiplied by 8 plus the number of UA gUSBamps preceding it plus one for the gUSBamp itself (2 * 8 + 1 + 1). To access the third UB gUSBamp's seventh bit, I would look at DigitalInput25. This was found in the same manner as above but because it is a UB gUSBamp the specific bit is added instead of just one (2 * 8 + 2 + 7).

To setup a link between gUSBamps UA and UB, the following images show how to connect them.

[[File:UAUBcombo.JPG]]

[[File:UAUBmultiple.JPG]]

===Digital Output===
Can be used with 1 - 8 gUSBamps.

====gUSBamps with UA serial numbers====
Each gUSBamp has one digital I/O port giving it two digital output bits. If multiple UA gUSBamps are connected there are a total of 16 digital output bits possible. To write to these bits, Parameter DigitalOutputEx must be filled. Each row correlates to a bit. The numbering of the bits start with 1 and 2 being the master gUSBamp and continues numbering until the eighth gUSBamp having bit 15 and 16. To determine which row to use, the bit is found by taking the number of amgUSBampsps preceding the intended gUSBamp in the chain multiplied by two and then add the number of the bit you want to write for. For example, the second bit of the fourth gUSBamp is row 8 (3 * 2 + 2).

====gUSBamps with UB serial numbers====
Each gUSBamp has two digital I/O ports giving it four digital output bits. If multiple UB gUSBamps are connected, that gives a total of 32 digital output bits possible. To write to these bits, Parameter DigitalOutputEx must be filled. Each row corresponds to a bit. The numbering of the bits start with 1 - 4 being the master gUSBamp and continues numbering until the eighth gUSBamp having bits 29 - 32. To figure out which row to use, the formula is the number of gUSBamps preceding the intended gUSBamp in the chain multiplied by four and then add the number of the bit you want to write for. For example the second bit of the fourth gUSBamp is row 14 (3 * 4 + 2).

====gUSBamps in sync with both UA and UB serial numbers====
The device specs are the same as above with each UA gUSBamp having two digital output bits and each UB gUSBamp having four digital output bits. To write the proper row, the order of the gUSBamps matter just like digital input. For example we have the setup of UB gUSBamp as master with the slaves in the following order: UB UA UA UB UA UA, which gives a total of 7 gUSBamps having a total of 20 digital output bits. To find the row that corresponds with the bit you want to write for, take the number of UB gUSBamps preceding the intended gUSBamp in the chain multiplied by 4 and add the number of UA gUSBamps preceding the intended gUSBamp in the chain multiplied by 2 and add the number of the bit you want. For example to write the expression for the second UA gUSBamp's first bit, I would write the expression in row 11 (2 * 4 + 1 * 2 + 1). For example to write the expression for the third UB gUSBamp's third bit, I would write the expression in row 15 (2 * 4 + 2 * 2 + 3).

==States==

===DigitalInput===
DigitalInput ranges from DigitalInput1 - DigitalInput64 (see [[:User Reference:gUSBampADC#Digital Input|Digital Input]] for explanation) and the values are either a 0 or a 1.

==Additional Information==

===Using 32bit Executables on 64bit Installations===
BCI2000 supports compilation of the gUSBamp source module for 64bit targets. The resulting executable will run on 64bit systems, and work with the 64bit version of the gUSBamp drivers. However, the binary distribution of BCI2000 contains 32bit executables. These run fine under 64bit systems, but you will need to perform these additional driver installation steps to install 32bit gUSBamp API DLLs on 64bit systems:
*Execute gtec's 32bit driver installer on your 64bit system.
*After successful installation, execute gtec's 64bit driver installer on your 64bit system.
*You will now have both the 32bit API DLL and the 64bit API DLL installed, such that both 32bit and 64bit executables will be able to connect to a gUSBamp attached to the system's USB ports.

===Data Storage===
Unlike other systems, the USBamp is a DC amplifier system that digitizes at 24 bit.
Bandpass and notch filtering is performed on the digitized samples, resulting in floating point signal samples in units of <math>\mu V</math>.
BCI2000 currently supports signed 16 bit integers and floating point numbers for its data storage.
If ''SignalType'' is set to int16, the floating point values have to be converted back into integers before they can be stored and transmitted to Signal Processing.
This is done by the following transformation:

<math>\mathrm{sample}_\mathrm{stored}\mathrm{(A/D\,units)}=\frac{\mathrm{sample}_\mathrm{acquired}(\mu V)}\mathrm{SourceChGain}</math>.

(''SourceChOffset'' is assumed (and required) to be zero for all channels.)
BCI2000 Signal Processing or any offline analysis routine can derive, as with
any other BCI2000 source module, sample values in <math>\mu V</math> by subtracting, from
each stored sample, ''SourceChOffset'' (i.e., zero), and multiplying it with
''SourceChGain'' for each channel. If ''SignalType'' is set to float32,
data samples are stored in units of <math>\mu V</math>. In this case, ''SourceChGain'' should be
a list of 1's (because the conversion factor between data samples into <math>\mu V</math> is
1.0 for each channel).

Still, when values other than 0 and 1 are specified, a consistent data file will be produced, i.e. values will be transformed before they are written to the file, such that applying SourceChOffset and SourceChGain will reproduce the original values in <math>\mu V</math>.

===The ''USBampgetinfo'' Command Line Tool===
This command line tool displays all connected USBamps, including their serial
number and the USB port that they connect to. Further, this tool reads, for the
first of the connected amplifiers, all supported bandpass and notch filter
configurations. Thus, this tool can be used to determine which filters can be
used for a particular sampling frequency within BCI2000. The following is an
example screen output:

<pre>
*******************************************
BCI2000 Information Tool for g.USBamp
*******************************************
(C)2004 Gerwin Schalk
Wadsworth Center
New York State Department of Health
Albany, NY, USA
*******************************************
Amp found at USB address 1 (S/N: UA-200X.XX.XX)
Printing info for first amp (USB address 1)

Available bandpass filters
===================================
num| hpfr | lpfreq | sfr | or | type
===================================
000| 0.10 | 0.0 | 32 | 8 | 1
001| 1.00 | 0.0 | 32 | 8 | 1
002| 2.00 | 0.0 | 32 | 8 | 1
003| 5.00 | 0.0 | 32 | 8 | 1
004| 0.00 | 15.0 | 32 | 8 | 1
005| 0.01 | 15.0 | 32 | 8 | 1
006| 0.10 | 15.0 | 32 | 8 | 1
007| 0.50 | 15.0 | 32 | 8 | 1
008| 2.00 | 15.0 | 32 | 8 | 1
009| 0.10 | 0.0 | 64 | 8 | 1
010| 1.00 | 0.0 | 64 | 8 | 1
011| 2.00 | 0.0 | 64 | 8 | 1
012| 5.00 | 0.0 | 64 | 8 | 1
013| 0.00 | 30.0 | 64 | 8 | 1
014| 0.01 | 30.0 | 64 | 8 | 1
015| 0.10 | 30.0 | 64 | 8 | 1
016| 0.50 | 30.0 | 64 | 8 | 1
017| 2.00 | 30.0 | 64 | 8 | 1
018| 0.10 | 0.0 | 128 | 8 | 1
019| 1.00 | 0.0 | 128 | 8 | 1
020| 2.00 | 0.0 | 128 | 8 | 1
021| 5.00 | 0.0 | 128 | 8 | 1
022| 0.00 | 30.0 | 128 | 8 | 1
023| 0.00 | 60.0 | 128 | 8 | 1
024| 0.01 | 30.0 | 128 | 8 | 1
025| 0.01 | 60.0 | 128 | 8 | 1
026| 0.10 | 30.0 | 128 | 8 | 1
027| 0.10 | 60.0 | 128 | 8 | 1
028| 0.50 | 30.0 | 128 | 8 | 1
029| 0.50 | 60.0 | 128 | 8 | 1
030| 2.00 | 30.0 | 128 | 8 | 1
031| 2.00 | 60.0 | 128 | 8 | 1
032| 0.10 | 0.0 | 256 | 8 | 1
033| 1.00 | 0.0 | 256 | 8 | 1
034| 2.00 | 0.0 | 256 | 8 | 1
035| 5.00 | 0.0 | 256 | 8 | 1
036| 0.00 | 30.0 | 256 | 8 | 1
037| 0.00 | 60.0 | 256 | 8 | 1
038| 0.00 | 100.0 | 256 | 8 | 1
039| 0.01 | 30.0 | 256 | 6 | 1
040| 0.01 | 60.0 | 256 | 8 | 1
041| 0.01 | 100.0 | 256 | 8 | 1
042| 0.10 | 30.0 | 256 | 8 | 1
043| 0.10 | 60.0 | 256 | 8 | 1
044| 0.10 | 100.0 | 256 | 8 | 1
045| 0.50 | 30.0 | 256 | 8 | 1
046| 0.50 | 60.0 | 256 | 8 | 1
047| 0.50 | 100.0 | 256 | 8 | 1
048| 2.00 | 30.0 | 256 | 8 | 1
049| 2.00 | 60.0 | 256 | 8 | 1
050| 2.00 | 100.0 | 256 | 8 | 1
051| 5.00 | 30.0 | 256 | 8 | 1
052| 5.00 | 60.0 | 256 | 8 | 1
053| 5.00 | 100.0 | 256 | 8 | 1
054| 0.10 | 0.0 | 512 | 8 | 1
055| 1.00 | 0.0 | 512 | 8 | 1
056| 2.00 | 0.0 | 512 | 8 | 1
057| 5.00 | 0.0 | 512 | 8 | 1
058| 0.00 | 30.0 | 512 | 8 | 1
059| 0.00 | 60.0 | 512 | 8 | 1
060| 0.00 | 100.0 | 512 | 8 | 1
061| 0.00 | 200.0 | 512 | 8 | 1
062| 0.01 | 30.0 | 512 | 6 | 1
063| 0.01 | 60.0 | 512 | 6 | 1
064| 0.01 | 100.0 | 512 | 6 | 1
065| 0.01 | 200.0 | 512 | 8 | 1
066| 0.10 | 30.0 | 512 | 8 | 1
067| 0.10 | 60.0 | 512 | 8 | 1
068| 0.10 | 100.0 | 512 | 8 | 1
069| 0.10 | 200.0 | 512 | 8 | 1
070| 0.50 | 30.0 | 512 | 8 | 1
071| 0.50 | 60.0 | 512 | 8 | 1
072| 0.50 | 100.0 | 512 | 8 | 1
073| 0.50 | 200.0 | 512 | 8 | 1
074| 2.00 | 30.0 | 512 | 8 | 1
075| 2.00 | 60.0 | 512 | 8 | 1
076| 2.00 | 100.0 | 512 | 8 | 1
077| 2.00 | 200.0 | 512 | 8 | 1
078| 5.00 | 30.0 | 512 | 8 | 1
079| 5.00 | 60.0 | 512 | 8 | 1
080| 5.00 | 100.0 | 512 | 8 | 1
081| 5.00 | 200.0 | 512 | 8 | 1
082| 0.10 | 0.0 | 600 | 8 | 1
083| 1.00 | 0.0 | 600 | 8 | 1
084| 2.00 | 0.0 | 600 | 8 | 1
085| 5.00 | 0.0 | 600 | 8 | 1
086| 0.00 | 30.0 | 600 | 8 | 1
087| 0.00 | 60.0 | 600 | 8 | 1
088| 0.00 | 100.0 | 600 | 8 | 1
089| 0.00 | 200.0 | 600 | 8 | 1
090| 0.00 | 250.0 | 600 | 8 | 1
091| 0.01 | 60.0 | 600 | 6 | 1
092| 0.01 | 100.0 | 600 | 6 | 1
093| 0.01 | 200.0 | 600 | 6 | 1
094| 0.01 | 250.0 | 600 | 8 | 1
095| 0.10 | 60.0 | 600 | 8 | 1
096| 0.10 | 100.0 | 600 | 8 | 1
097| 0.10 | 200.0 | 600 | 8 | 1
098| 0.10 | 250.0 | 600 | 8 | 1
099| 0.50 | 30.0 | 600 | 8 | 1
100| 0.50 | 60.0 | 600 | 8 | 1
101| 0.50 | 100.0 | 600 | 8 | 1
102| 0.50 | 200.0 | 600 | 8 | 1
103| 0.50 | 250.0 | 600 | 8 | 1
104| 2.00 | 30.0 | 600 | 8 | 1
105| 2.00 | 60.0 | 600 | 8 | 1
106| 2.00 | 100.0 | 600 | 8 | 1
107| 2.00 | 200.0 | 600 | 8 | 1
108| 2.00 | 250.0 | 600 | 8 | 1
109| 5.00 | 30.0 | 600 | 8 | 1
110| 5.00 | 60.0 | 600 | 8 | 1
111| 5.00 | 100.0 | 600 | 8 | 1
112| 5.00 | 200.0 | 600 | 8 | 1
113| 5.00 | 250.0 | 600 | 8 | 1
114| 0.10 | 0.0 | 1200 | 8 | 1
115| 1.00 | 0.0 | 1200 | 8 | 1
116| 2.00 | 0.0 | 1200 | 8 | 1
117| 5.00 | 0.0 | 1200 | 8 | 1
118| 0.00 | 30.0 | 1200 | 8 | 1
119| 0.00 | 60.0 | 1200 | 8 | 1
120| 0.00 | 100.0 | 1200 | 8 | 1
121| 0.00 | 200.0 | 1200 | 8 | 1
122| 0.00 | 250.0 | 1200 | 8 | 1
123| 0.00 | 500.0 | 1200 | 8 | 1
124| 0.01 | 100.0 | 1200 | 6 | 1
125| 0.01 | 200.0 | 1200 | 6 | 1
126| 0.01 | 250.0 | 1200 | 6 | 1
127| 0.01 | 500.0 | 1200 | 6 | 1
128| 0.10 | 100.0 | 1200 | 6 | 1
129| 0.10 | 200.0 | 1200 | 8 | 1
130| 0.10 | 250.0 | 1200 | 8 | 1
131| 0.10 | 500.0 | 1200 | 8 | 1
132| 0.50 | 100.0 | 1200 | 8 | 1
133| 0.50 | 200.0 | 1200 | 8 | 1
134| 0.50 | 250.0 | 1200 | 8 | 1
135| 0.50 | 500.0 | 1200 | 8 | 1
136| 2.00 | 100.0 | 1200 | 8 | 1
137| 2.00 | 200.0 | 1200 | 8 | 1
138| 2.00 | 250.0 | 1200 | 8 | 1
139| 2.00 | 500.0 | 1200 | 8 | 1
140| 5.00 | 100.0 | 1200 | 8 | 1
141| 5.00 | 200.0 | 1200 | 8 | 1
142| 5.00 | 250.0 | 1200 | 8 | 1
143| 5.00 | 500.0 | 1200 | 8 | 1
144| 0.10 | 0.0 | 2400 | 8 | 1
145| 1.00 | 0.0 | 2400 | 8 | 1
146| 2.00 | 0.0 | 2400 | 8 | 1
147| 5.00 | 0.0 | 2400 | 8 | 1
148| 0.00 | 30.0 | 2400 | 8 | 1
149| 0.00 | 60.0 | 2400 | 8 | 1
150| 0.00 | 100.0 | 2400 | 8 | 1
151| 0.00 | 200.0 | 2400 | 8 | 1
152| 0.00 | 250.0 | 2400 | 8 | 1
153| 0.00 | 500.0 | 2400 | 8 | 1
154| 0.00 | 1000.0 | 2400 | 8 | 1
155| 0.01 | 200.0 | 2400 | 4 | 1
156| 0.01 | 250.0 | 2400 | 6 | 1
157| 0.01 | 500.0 | 2400 | 6 | 1
158| 0.01 | 1000.0 | 2400 | 6 | 1
159| 0.10 | 200.0 | 2400 | 6 | 1
160| 0.10 | 250.0 | 2400 | 6 | 1
161| 0.10 | 500.0 | 2400 | 8 | 1
162| 0.10 | 1000.0 | 2400 | 8 | 1
163| 0.50 | 200.0 | 2400 | 8 | 1
164| 0.50 | 250.0 | 2400 | 8 | 1
165| 0.50 | 500.0 | 2400 | 8 | 1
166| 0.50 | 1000.0 | 2400 | 8 | 1
167| 2.00 | 200.0 | 2400 | 8 | 1
168| 2.00 | 250.0 | 2400 | 8 | 1
169| 2.00 | 500.0 | 2400 | 8 | 1
170| 2.00 | 1000.0 | 2400 | 8 | 1
171| 5.00 | 200.0 | 2400 | 8 | 1
172| 5.00 | 250.0 | 2400 | 8 | 1
173| 5.00 | 500.0 | 2400 | 8 | 1
174| 5.00 | 1000.0 | 2400 | 8 | 1
175| 0.10 | 0.0 | 4800 | 6 | 1
176| 1.00 | 0.0 | 4800 | 8 | 1
177| 2.00 | 0.0 | 4800 | 8 | 1
178| 5.00 | 0.0 | 4800 | 8 | 1
179| 0.00 | 30.0 | 4800 | 8 | 1
180| 0.00 | 60.0 | 4800 | 8 | 1
181| 0.00 | 100.0 | 4800 | 8 | 1
182| 0.00 | 200.0 | 4800 | 8 | 1
183| 0.00 | 250.0 | 4800 | 8 | 1
184| 0.00 | 500.0 | 4800 | 8 | 1
185| 0.00 | 1000.0 | 4800 | 8 | 1
186| 0.00 | 2000.0 | 4800 | 8 | 1
187| 0.01 | 500.0 | 4800 | 6 | 1
188| 0.01 | 1000.0 | 4800 | 6 | 1
189| 0.01 | 2000.0 | 4800 | 6 | 1
190| 0.10 | 500.0 | 4800 | 6 | 1
191| 0.10 | 1000.0 | 4800 | 6 | 1
192| 0.10 | 2000.0 | 4800 | 8 | 1
193| 0.50 | 500.0 | 4800 | 8 | 1
194| 0.50 | 1000.0 | 4800 | 8 | 1
195| 0.50 | 2000.0 | 4800 | 8 | 1
196| 2.00 | 500.0 | 4800 | 8 | 1
197| 2.00 | 1000.0 | 4800 | 8 | 1
198| 2.00 | 2000.0 | 4800 | 8 | 1
199| 5.00 | 500.0 | 4800 | 8 | 1
200| 5.00 | 1000.0 | 4800 | 8 | 1
201| 5.00 | 2000.0 | 4800 | 8 | 1

Available notch filters
===================================
num| hpfr | lpfreq | sfr | or | type
===================================
000| 48.00 | 52.0 | 128 | 4 | 1
001| 58.00 | 62.0 | 128 | 4 | 1
002| 48.00 | 52.0 | 256 | 4 | 1
003| 58.00 | 62.0 | 256 | 4 | 1
004| 48.00 | 52.0 | 512 | 4 | 1
005| 58.00 | 62.0 | 512 | 4 | 1
006| 48.00 | 52.0 | 600 | 4 | 1
007| 58.00 | 62.0 | 600 | 4 | 1
008| 48.00 | 52.0 | 1200 | 4 | 1
009| 58.00 | 62.0 | 1200 | 4 | 1
010| 48.00 | 52.0 | 2400 | 4 | 1
011| 58.00 | 62.0 | 2400 | 4 | 1
012| 48.00 | 52.0 | 4800 | 4 | 1
013| 58.00 | 62.0 | 4800 | 4 | 1

</pre>

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

File:UAUBmultiple.JPG

2015-06-30T19:50:35Z

Kgoering: Image how to setup multiple gUSBamp in sync of two different versions.

Image how to setup multiple gUSBamp in sync of two different versions.

File:UAUBcombo.JPG

2015-06-30T19:50:09Z

Kgoering: Image how to setup gUSBamp in sync of two different versions.

Image how to setup gUSBamp in sync of two different versions.

Contributions:ParallelPortFilter

2015-06-30T19:27:17Z

Kgoering: /* Example Configurations */

==Location==
http://{{SERVERNAME}}/svn/trunk/src/contrib/Extensions/ParallelPortFilter

==Versioning==

===Authors===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)

===Version History===
* 2015/06/30: Initial public release

===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Functional Description==
This simple filter extension resides in the Application module and makes input and output with the parallel port easy. The inputs are stored as states ParallelPortInput1 - ParallelPortInput24 based off the number of ports connected. For more information, see [[:Contributions:ParallelPortFilter#States|States]].

==Integration into BCI2000==
Compile the extension into your source module by enabling contributed extensions in your CMake configuration. You can do this by going into your root build folder and deleting <code>CMakeCache.txt</code> and re-running the project batch file, or by running <code>cmake -i</code> and enabling '''BUILD_PARALLELPORTFILTER'''. Once the extension is built into the source module, it can be used.

==Configuring ParallelPortFiler==
If using the filter, SourcePorts must have a number greater than 0. Then list the names for the ports separated by spaces in SourcePortsList. The list must be the same length as the value in SourcePorts. You can then set the LPTMapping with column one in using the names as in SourcePortsList and column 2 using the corresponding hardware address. This step is optional. If not configured, LPT1 maps to 0x378 and LPT2 maps to 0x278 which should work for most users. DigitalOutputEx is only necessary if user wants to write output through the parallel port.

If the default settings for LPTMapping did not produce results, the hardware address might be different for the user's computer. To find the hardware address for the parallel ports for your machine, press '''WIN''' + '''R''' and enter ''devmgmt.msc''. In Device Manager, expand the section labeled '''Ports (Com & LPT)'''. If this section does not exist, you probably do not have LPT ports or the driver is not installed properly. Find the one labeled with (LPT1) or whatever port you are looking for. Right click and select Properties. In the Resources tab, there is a field called I/O Range and take the first value of the range which is in hexadecimal. If multiple I/O Range, read the first one; if that does not work, try the other one. Take that value as the hardware address for Parameter LPTMapping. These instructions for finding the address has been tested on Windows XP, 7, and 8.

[[File:ParallelPortAddress.JPG]]

For some examples on configurations, see [[:Contributions:ParallelPortFilter#Example Configurations|Example Configurations]].

For better explanation of the parameters, see [[:Contributions:ParallelPortFilter#Parameters|Parameters]].

==Parameters==
The ParallelPortFilter is configured in the ParallelPort tab. The configurable parameters are:

===SourcePorts===
This parameter is used to initialize the filter and to keep track of the number of ports being used. This number should be the total number of parallel ports that should be used to communicate. It should be an integer value greater than 0 if being used else 0. Most computers do not have more than 3 parallel ports but some have 4. In good practice this value should not be greater than 3 unless you are sure you have that many ports.

===SourcePortsList===
This parameter lists the ports to be used and the order to communicate through them. It should be a list of the port names LPT1 - LPT3. You can not use the same port twice in on list. This list must be the same length as the value in Parameter SourcePorts.

===LPTMapping===
This parameter is to manually enter the hardware address of the ports incase that the computer being used does not conform to general use hardware addresses. Column one should have the names of the ports such as LPT1 or LPT2, same as the values in Parameter SourcePortsList, and column two should have the hexadecimal value of the port such as 0x378. The number of rows in the matrix should be equal to the value in Parameter SourcePorts, while it must have two columns if being used, no more, no less.

===DigitalOutputEx===
This matrix of expressions that controls the outputs on the parallel ports. Each port has 8 bits which correspond to 8 rows on the matrix. If the expression evaluates to True, the bit will be set to 1 else to 0. Boolean expression work quite well here. For more information on digital output and expressions usage for ParallelPortFilter see [[::Contributions:ParallelPortFilter#Digital Output|Digital Output]].

==Digital Output==
Each port has 8 bits that can be written to. These bits can be accessed through the Parameter DigitalOutputEx. The user must write expressions for each individual bit on each port. The row label corresponds to which bit it will be written to. If multiple ports are enabled, row 1 - 8 correspond to the bits 1 - 8 on the first port and row 9 - 16 correspond to the bits 1 - 8 on the second port and so on. Expressions that evaluate to True set the corresponding bit to 1 and those that evaluate to False set the corresponding bit to 0.

In the case that the user wishes to send an signal or a value through the port, the user must convert the number into binary and write the corresponding zeroes and ones to the respective bits. To do that, the formula:
<code>mod((floor(x / 2 ^(bitnumber - 1))), 2)</code>. The x is the number or the signal the user wishes to send through the port. For example if the number 193 was to be sent through the port, the Parameter DigitalOutputEx would be:

[[File:ParallelPortFilterDigitalOutExBinary.jpg]]

Not all rows have to be created. Any row not named just writes the bit as 0. The rows also can be written in whatever order if you just change the row label in the parameter. The example below just sets bit 1 and 5 to 1. All other rows are zeroes.

[[File:ParallelPortFilterRowLabelChange.jpg]]

For more on expressions, see [[:User Reference:Expression Syntax|Expressions]].

==States==
For each port there is 8 input bits which correspond to 8 ParallelPortInput states. Each state is either a 0 or a 1. If multiple ports are enabled, ParallelPortInput1 - ParallelPortInput8 correspond to the bits 1 - 8 on the first port and ParallelPortInput9 - ParallelPortInput16 correspond to the bits 1 - 8 on the second port and so on. Currently only 3 ports may be enabled, which should be more than enough for most computers do not have more than port LPT1 - LPT3.

==Example Configurations==
This example enables port LPT1 with default address and send the value 193 through it.

[[File:ParallelPortFilterDefault.jpg|1000px]]

This example enables port LPT1 with a new hardware address.

[[File:ParallelPortFilterNewAddress.jpg|1000px]]

This example enables ports with names MRIScanner and StimulusDevice with hardware addresses. Note that the address for the ports are the same as the default values for LPT1 and LPT2. This shows that LPT names can be renamed in the Parameter Configuration to make it easier to read. This does not change the names of the addresses given by the computer itself.

[[File:ParallelPortFilterNewNames.jpg|1000px]]

Contributions:ParallelPortFilter

2015-06-30T19:25:57Z

Kgoering:

==Location==
http://{{SERVERNAME}}/svn/trunk/src/contrib/Extensions/ParallelPortFilter

==Versioning==

===Authors===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)

===Version History===
* 2015/06/30: Initial public release

===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Functional Description==
This simple filter extension resides in the Application module and makes input and output with the parallel port easy. The inputs are stored as states ParallelPortInput1 - ParallelPortInput24 based off the number of ports connected. For more information, see [[:Contributions:ParallelPortFilter#States|States]].

==Integration into BCI2000==
Compile the extension into your source module by enabling contributed extensions in your CMake configuration. You can do this by going into your root build folder and deleting <code>CMakeCache.txt</code> and re-running the project batch file, or by running <code>cmake -i</code> and enabling '''BUILD_PARALLELPORTFILTER'''. Once the extension is built into the source module, it can be used.

==Configuring ParallelPortFiler==
If using the filter, SourcePorts must have a number greater than 0. Then list the names for the ports separated by spaces in SourcePortsList. The list must be the same length as the value in SourcePorts. You can then set the LPTMapping with column one in using the names as in SourcePortsList and column 2 using the corresponding hardware address. This step is optional. If not configured, LPT1 maps to 0x378 and LPT2 maps to 0x278 which should work for most users. DigitalOutputEx is only necessary if user wants to write output through the parallel port.

If the default settings for LPTMapping did not produce results, the hardware address might be different for the user's computer. To find the hardware address for the parallel ports for your machine, press '''WIN''' + '''R''' and enter ''devmgmt.msc''. In Device Manager, expand the section labeled '''Ports (Com & LPT)'''. If this section does not exist, you probably do not have LPT ports or the driver is not installed properly. Find the one labeled with (LPT1) or whatever port you are looking for. Right click and select Properties. In the Resources tab, there is a field called I/O Range and take the first value of the range which is in hexadecimal. If multiple I/O Range, read the first one; if that does not work, try the other one. Take that value as the hardware address for Parameter LPTMapping. These instructions for finding the address has been tested on Windows XP, 7, and 8.

[[File:ParallelPortAddress.JPG]]

For some examples on configurations, see [[:Contributions:ParallelPortFilter#Example Configurations|Example Configurations]].

For better explanation of the parameters, see [[:Contributions:ParallelPortFilter#Parameters|Parameters]].

==Parameters==
The ParallelPortFilter is configured in the ParallelPort tab. The configurable parameters are:

===SourcePorts===
This parameter is used to initialize the filter and to keep track of the number of ports being used. This number should be the total number of parallel ports that should be used to communicate. It should be an integer value greater than 0 if being used else 0. Most computers do not have more than 3 parallel ports but some have 4. In good practice this value should not be greater than 3 unless you are sure you have that many ports.

===SourcePortsList===
This parameter lists the ports to be used and the order to communicate through them. It should be a list of the port names LPT1 - LPT3. You can not use the same port twice in on list. This list must be the same length as the value in Parameter SourcePorts.

===LPTMapping===
This parameter is to manually enter the hardware address of the ports incase that the computer being used does not conform to general use hardware addresses. Column one should have the names of the ports such as LPT1 or LPT2, same as the values in Parameter SourcePortsList, and column two should have the hexadecimal value of the port such as 0x378. The number of rows in the matrix should be equal to the value in Parameter SourcePorts, while it must have two columns if being used, no more, no less.

===DigitalOutputEx===
This matrix of expressions that controls the outputs on the parallel ports. Each port has 8 bits which correspond to 8 rows on the matrix. If the expression evaluates to True, the bit will be set to 1 else to 0. Boolean expression work quite well here. For more information on digital output and expressions usage for ParallelPortFilter see [[::Contributions:ParallelPortFilter#Digital Output|Digital Output]].

==Digital Output==
Each port has 8 bits that can be written to. These bits can be accessed through the Parameter DigitalOutputEx. The user must write expressions for each individual bit on each port. The row label corresponds to which bit it will be written to. If multiple ports are enabled, row 1 - 8 correspond to the bits 1 - 8 on the first port and row 9 - 16 correspond to the bits 1 - 8 on the second port and so on. Expressions that evaluate to True set the corresponding bit to 1 and those that evaluate to False set the corresponding bit to 0.

In the case that the user wishes to send an signal or a value through the port, the user must convert the number into binary and write the corresponding zeroes and ones to the respective bits. To do that, the formula:
<code>mod((floor(x / 2 ^(bitnumber - 1))), 2)</code>. The x is the number or the signal the user wishes to send through the port. For example if the number 193 was to be sent through the port, the Parameter DigitalOutputEx would be:

[[File:ParallelPortFilterDigitalOutExBinary.jpg]]

Not all rows have to be created. Any row not named just writes the bit as 0. The rows also can be written in whatever order if you just change the row label in the parameter. The example below just sets bit 1 and 5 to 1. All other rows are zeroes.

[[File:ParallelPortFilterRowLabelChange.jpg]]

For more on expressions, see [[:User Reference:Expression Syntax|Expressions]].

==States==
For each port there is 8 input bits which correspond to 8 ParallelPortInput states. Each state is either a 0 or a 1. If multiple ports are enabled, ParallelPortInput1 - ParallelPortInput8 correspond to the bits 1 - 8 on the first port and ParallelPortInput9 - ParallelPortInput16 correspond to the bits 1 - 8 on the second port and so on. Currently only 3 ports may be enabled, which should be more than enough for most computers do not have more than port LPT1 - LPT3.

==Example Configurations==
This example enables port LPT1 with default address and send the value 193 through it.

[[File:ParallelPortFilterDefault.jpg]]

This example enables port LPT1 with a new hardware address.

[[File:ParallelPortFilterNewAddress.jpg]]

This example enables ports with names MRIScanner and StimulusDevice with hardware addresses. Note that the address for the ports are the same as the default values for LPT1 and LPT2. This shows that LPT names can be renamed in the Parameter Configuration to make it easier to read. This does not change the names of the addresses given by the computer itself.

[[File:ParallelPortFilterNewNames.jpg]]

Contributions:ParallelPortFilter

2015-06-30T19:24:30Z

Kgoering: /* Example Configurations */

==Location==
http://{{SERVERNAME}}/svn/trunk/src/contrib/Extensions/ParallelPortFilter

==Versioning==

===Authors===
Kristopher Kaleb Goering (kaleb.goering@gmail.com)

===Version History===
* 2015/06/30: Initial public release

===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Functional Description==
This simple filter extension resides in the Application module and makes input and output with the parallel port easy. The inputs are stored as states ParallelPortInput1 - ParallelPortInput24 based off the number of ports connected. For more information, see [[:Contributions:ParallelPortFilter#States|States]].

==Integration into BCI2000==
Compile the extension into your source module by enabling contributed extensions in your CMake configuration. You can do this by going into your root build folder and deleting <code>CMakeCache.txt</code> and re-running the project batch file, or by running <code>cmake -i</code> and enabling '''BUILD_PARALLELPORTFILTER'''. Once the extension is built into the source module, it can be used.

==Configuring ParallelPortFiler==
If using the filter, SourcePorts must have a number greater than 0. Then list the names for the ports separated by spaces in SourcePortsList. The list must be the same length as the value in SourcePorts. You can then set the LPTMapping with column one in using the names as in SourcePortsList and column 2 using the corresponding hardware address. This step is optional. If not configured, LPT1 maps to 0x378 and LPT2 maps to 0x278 which should work for most users. DigitalOutputEx is only necessary if user wants to write output through the parallel port.

If the default settings for LPTMapping did not produce results, the hardware address might be different for the user's computer. To find the hardware address for the parallel ports for your machine, press '''WIN''' + '''R''' and enter ''devmgmt.msc''. In Device Manager, expand the section labeled '''Ports (Com & LPT)'''. If this section does not exist, you probably do not have LPT ports or the driver is not installed properly. Find the one labeled with (LPT1) or whatever port you are looking for. Right click and select Properties. In the Resources tab, there is a field called I/O Range and take the first value of the range which is in hexadecimal. If multiple I/O Range, read the first one; if that does not work, try the other one. Take that value as the hardware address for Parameter LPTMapping. These instructions for finding the address has been tested on Windows XP, 7, and 8.

For some examples on configurations, see [[:Contributions:ParallelPortFilter#Example Configurations|Example Configurations]].

For better explanation of the parameters, see [[:Contributions:ParallelPortFilter#Parameters|Parameters]].

==Parameters==
The ParallelPortFilter is configured in the ParallelPort tab. The configurable parameters are:

===SourcePorts===
This parameter is used to initialize the filter and to keep track of the number of ports being used. This number should be the total number of parallel ports that should be used to communicate. It should be an integer value greater than 0 if being used else 0. Most computers do not have more than 3 parallel ports but some have 4. In good practice this value should not be greater than 3 unless you are sure you have that many ports.

===SourcePortsList===
This parameter lists the ports to be used and the order to communicate through them. It should be a list of the port names LPT1 - LPT3. You can not use the same port twice in on list. This list must be the same length as the value in Parameter SourcePorts.

===LPTMapping===
This parameter is to manually enter the hardware address of the ports incase that the computer being used does not conform to general use hardware addresses. Column one should have the names of the ports such as LPT1 or LPT2, same as the values in Parameter SourcePortsList, and column two should have the hexadecimal value of the port such as 0x378. The number of rows in the matrix should be equal to the value in Parameter SourcePorts, while it must have two columns if being used, no more, no less.

===DigitalOutputEx===
This matrix of expressions that controls the outputs on the parallel ports. Each port has 8 bits which correspond to 8 rows on the matrix. If the expression evaluates to True, the bit will be set to 1 else to 0. Boolean expression work quite well here. For more information on digital output and expressions usage for ParallelPortFilter see [[::Contributions:ParallelPortFilter#Digital Output|Digital Output]].

==Digital Output==
Each port has 8 bits that can be written to. These bits can be accessed through the Parameter DigitalOutputEx. The user must write expressions for each individual bit on each port. The row label corresponds to which bit it will be written to. If multiple ports are enabled, row 1 - 8 correspond to the bits 1 - 8 on the first port and row 9 - 16 correspond to the bits 1 - 8 on the second port and so on. Expressions that evaluate to True set the corresponding bit to 1 and those that evaluate to False set the corresponding bit to 0.

In the case that the user wishes to send an signal or a value through the port, the user must convert the number into binary and write the corresponding zeroes and ones to the respective bits. To do that, the formula:
<code>mod((floor(x / 2 ^(bitnumber - 1))), 2)</code>. The x is the number or the signal the user wishes to send through the port. For example if the number 193 was to be sent through the port, the Parameter DigitalOutputEx would be:

[[File:ParallelPortFilterDigitalOutExBinary.jpg]]

Not all rows have to be created. Any row not named just writes the bit as 0. The rows also can be written in whatever order if you just change the row label in the parameter. The example below just sets bit 1 and 5 to 1. All other rows are zeroes.

[[File:ParallelPortFilterRowLabelChange.jpg]]

For more on expressions, see [[:User Reference:Expression Syntax|Expressions]].

==States==
For each port there is 8 input bits which correspond to 8 ParallelPortInput states. Each state is either a 0 or a 1. If multiple ports are enabled, ParallelPortInput1 - ParallelPortInput8 correspond to the bits 1 - 8 on the first port and ParallelPortInput9 - ParallelPortInput16 correspond to the bits 1 - 8 on the second port and so on. Currently only 3 ports may be enabled, which should be more than enough for most computers do not have more than port LPT1 - LPT3.

==Example Configurations==
This example enables port LPT1 with default address and send the value 193 through it.

[[File:ParallelPortFilterDefault.jpg]]

This example enables port LPT1 with a new hardware address.

[[File:ParallelPortFilterNewAddress.jpg]]

This example enables ports with names MRIScanner and StimulusDevice with hardware addresses. Note that the address for the ports are the same as the default values for LPT1 and LPT2. This shows that LPT names can be renamed in the Parameter Configuration to make it easier to read. This does not change the names of the addresses given by the computer itself.

[[File:ParallelPortFilterNewNames.jpg]]

[[File:ParallelPortAddress.jpg]]

File:ParallelPortFilterNewNames.jpg

2015-06-30T19:24:04Z

Kgoering: Example of how to rename LPT for use in ParallelPortFilter.

Example of how to rename LPT for use in ParallelPortFilter.

File:ParallelPortFilterNewAddress.jpg

2015-06-30T19:22:45Z

Kgoering: This is an example of set up setting the address of LPT1 to the address for the current machine.

This is an example of set up setting the address of LPT1 to the address for the current machine.