Programming Reference:Signals - Revision history

Mellinger: /* Properties */

2011-06-03T13:57:06Z

Properties

← Older revision		Revision as of 13:57, 3 June 2011
Line 88:		Line 88:
	====LabelIndex ChannelLabels, ElementLabels (rw)====		====LabelIndex ChannelLabels, ElementLabels (rw)====
	Labels of channels and elements, represented as [[Programming Reference:LabelIndex Class\|LabelIndex]] objects.		Labels of channels and elements, represented as [[Programming Reference:LabelIndex Class\|LabelIndex]] objects.
			====float SamplingRate (r)====
			The sampling rate of the signal, given in Hz, or 0 when the dimension in element direction is not time. SamplingRate is a readonly property; to adapt a signal's sampling rate, set its ElementUnit's Gain property to the inverse of the desired sampling rate.
			====float UpdateRate (rw)====
			The update rate of the signal, given in Hz. This number shows how often a signal is updated with new values, irrespective of its dimensions. Note that in general SamplingRate is not equal to UpdateRate*Elements.
	====PhysicalUnit ChannelUnit, ElementUnit, ValueUnit (rw)====		====PhysicalUnit ChannelUnit, ElementUnit, ValueUnit (rw)====
	Physical units associated with respective dimensions. Typically, there is no physical unit in the channel dimension; in the element dimension, the physical unit would be temporal, measured in seconds, or a frequency, measured in Hz; in the value dimension, the physical unit would be a voltage, or a power thereof. Physical units are represented as objects of type [[Programming Reference:PhysicalUnit Class\|<tt>PhysicalUnit</tt>]].		Physical units associated with respective dimensions. Typically, there is no physical unit in the channel dimension; in the element dimension, the physical unit would be temporal, measured in seconds, or a frequency, measured in Hz; in the value dimension, the physical unit would be a voltage, or a power thereof. Physical units are represented as objects of type [[Programming Reference:PhysicalUnit Class\|<tt>PhysicalUnit</tt>]].

Mellinger: /* SignalType Type (rw)= */

2008-10-24T17:34:42Z

SignalType Type (rw)=

← Older revision		Revision as of 17:34, 24 October 2008
Line 81:		Line 81:
	====int Channels, Elements (rw)====		====int Channels, Elements (rw)====
	The number of channels and elements.		The number of channels and elements.
	====SignalType Type (rw)=====		====SignalType Type (rw)====
	The signal's numeric type.		The signal's numeric type.

	====string Name (rw)====		====string Name (rw)====
	The signal's name. When a signal is sent to the operator module via a [[Programming Reference:GenericVisualization Class\|GenericVisualization]] object, its name is used as a visualization window title.		The signal's name. When a signal is sent to the operator module via a [[Programming Reference:GenericVisualization Class\|GenericVisualization]] object, its name is used as a visualization window title.

Mellinger: /* number Value(Channel, Element) (rw) */

2008-10-24T17:33:46Z

number Value(Channel, Element) (rw)

← Older revision		Revision as of 17:33, 24 October 2008
Line 39:		Line 39:
	The signal type.		The signal type.
	====number Value(Channel, Element) (rw)====		====number Value(Channel, Element) (rw)====
	The signal's value at the specified channel/element combination. Access to signal values is also possible (and recommended) using ~~bracket~~ notation on the signal object itself:		The signal's value at the specified channel/element combination. Access to signal values is also possible (and recommended) using parentheses notation on the signal object itself:
	GenericSignal mySignal( 5, 4 );		GenericSignal mySignal( 5, 4 );
	mySignal( 2, 3 ) = 4.5;		mySignal( 2, 3 ) = 4.5;


	==SignalProperties Class==		==SignalProperties Class==

Mellinger: /* WriteValueBinary(ostream, channel, element)/ReadValueBinary(istream, channel, element) */

2008-10-24T17:33:14Z

WriteValueBinary(ostream, channel, element)/ReadValueBinary(istream, channel, element)

← Older revision		Revision as of 17:33, 24 October 2008
Line 27:		Line 27:
	Read/write from/to <tt>std::iostream</tt> streams as a [[Technical_Reference:BCI2000_Messages#Brain_Signal_Format\|BCI2000 signal message]].		Read/write from/to <tt>std::iostream</tt> streams as a [[Technical_Reference:BCI2000_Messages#Brain_Signal_Format\|BCI2000 signal message]].
	====WriteValueBinary(ostream, channel, element)/ReadValueBinary(istream, channel, element)====		====WriteValueBinary(ostream, channel, element)/ReadValueBinary(istream, channel, element)====
	Binary I/O of individual values, depending on the signal's type. These functions are provided for use in [[Programming_Reference:GenericFileWriter_Class\|FileWriter]] and input ~~components~~.		Binary I/O of individual values, depending on the signal's type. These functions are provided for use in [[Programming_Reference:GenericFileWriter_Class\|FileWriter]] components, and components that read data from input files.

	===Properties===		===Properties===
	====SignalProperties Properties (rw)====		====SignalProperties Properties (rw)====

Mellinger: /* Synopsis */

2008-10-24T17:31:50Z

Synopsis

← Older revision		Revision as of 17:31, 24 October 2008
Line 4:		Line 4:
	===Synopsis===		===Synopsis===
	Many classes in both Data Acquisition and Signal Processing work on		Many classes in both Data Acquisition and Signal Processing work on
	signals, i.e., continuously flowing data organized in channels and samples.		signals, i.e., continuously flowing data organized into channels and samples.
	The <tt>GenericSignal</tt> class contains floating point data		The <tt>GenericSignal</tt> class contains floating point data
	organized as a matrix of channels and "elements" (a generalized		organized as a matrix of channels and "elements" (a generalized

Mellinger at 16:08, 12 September 2008

2008-09-12T16:08:00Z

@@ Line 1: / Line 1: @@
-==Signals==
+==GenericSignal Class==
 Many classes in both Data Acquisition and Signal Processing work on
 signals, i.e., continuously flowing data organized in channels and samples.
@@ Line 9: / Line 12: @@
 each channel as a list of "elements").
-==Signal Properties==
+===Methods===
 Sometimes, the number of channels, elements, and bytes
 required
@@ Line 19: / Line 56: @@
 whether the values contained in one signal may be copied into another
 signal without loss of information.
-<tt>GenericSignal</tt> uses a <tt>SignalProperties</tt> member to
+<tt>GenericSignal</tt> class uses a <tt>SignalProperties</tt> member to
 maintain
 information about its properties.
 [[Category:Framework API]][[Category:Development]]

Mellinger: /* Signal Properties */

2007-11-08T17:27:14Z

Signal Properties

← Older revision		Revision as of 17:27, 8 November 2007
Line 22:		Line 22:
	maintain		maintain
	information about its properties.		information about its properties.

			[[Category:Framework API]][[Category:Development]]

Atennissen at 16:47, 7 May 2007

2007-05-07T16:47:43Z

← Older revision		Revision as of 16:47, 7 May 2007
Line 10:		Line 10:

	==Signal Properties==		==Signal Properties==
	Sometimes, the number of channels, elements, and ~~the number of~~ bytes		Sometimes, the number of channels, elements, and bytes
	required		required
	for storing values, are referred to as "Signal Properties".		for storing values, are referred to as "Signal Properties".
Line 16:		Line 16:
	those		those
	values, and determining whether a given signal "fits" into another		values, and determining whether a given signal "fits" into another
	one, i.e.\		one, i.e.,
	whether the values contained in one signal may be copied into another		whether the values contained in one signal may be copied into another
	signal without loss of information.		signal without loss of information.

Mellinger at 18:05, 27 February 2007

2007-02-27T18:05:01Z

New page

==Signals==
Many classes in both Data Acquisition and Signal Processing work on
signals, i.e., continuously flowing data organized in channels and samples.
The <tt>GenericSignal</tt> class contains floating point data
organized as a matrix of channels and "elements" (a generalized
notion
of samples -- e.g., spectrally analyzed data might contain the
spectrum of
each channel as a list of "elements").

==Signal Properties==
Sometimes, the number of channels, elements, and the number of bytes
required
for storing values, are referred to as "Signal Properties".
There is a separate class, <tt>SignalProperties</tt>, for expressing
those
values, and determining whether a given signal "fits" into another
one, i.e.\
whether the values contained in one signal may be copied into another
signal without loss of information.
<tt>GenericSignal</tt> uses a <tt>SignalProperties</tt> member to
maintain
information about its properties.