Jump to content

User Reference:TransmissionFilter

From BCI2000 Wiki
Revision as of 16:46, 12 November 2026 by Mellinger (talk | contribs) (→Example)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Function

The TransmissionFilter forwards a subset of input channels to its output. Typically, it is used as the very last stage of the data acquisition module to select a subset of recorded channels for on-line processing, thus reducing data transmission overhead and processing load.

Parameters

TransmitChList

A list of input channels to be forwarded to the filter's output. May be defined as a list of channel names, ordinal channel numbers, wildcard patterns, or ranges.

  • Wildcard patterns may contain the usual * and ? wildcards, character sets enclosed in [], and may be negated by prepending an exclamation mark.
  • Ranges are given by begin and end, separated with a colon (:) or minus (-). Either of begin and end may be omitted, resulting in the full available range.

Channel labels are forwarded if present for the input signal.

Examples

  • Each of *  : - 1: 1- will match the full range of available channels.
  • !EOG* matches all channels except those whose names begin with "EOG".
  • *z will match all central electrodes.
  • ??? will match all channels whose names consist of exactly three characters.

SynthesizedChannels

A list of expressions used to create additional channels from existing information, such as BCI2000 state variables and channel data. Synthesized channels will have their expression as a label, and will be appended to transmitted channels at the end.

Example

When recording mouse position, the position will be present in the MousePosX and MousePosY state variables. To obtain additional channels with this information, set SynthesizedChannels to

MousePosX MousePosY

States

None.

See also

Technical Reference:Core Modules, BCI2000 Glossary#Source Signal