Programming Reference:BCI2000FileReader Class - Revision history

Cstocks: /* CalibratedValue(channel, sample) */ correct parameter names

2010-07-29T21:11:39Z

CalibratedValue(channel, sample): correct parameter names

← Older revision		Revision as of 21:11, 29 July 2010
Line 14:		Line 14:
	===CalibratedValue(channel, sample)===		===CalibratedValue(channel, sample)===
	Sets the current sample position to the value specified in the second argument, and returns the calibrated sample value for the channel specified in the first argument.		Sets the current sample position to the value specified in the second argument, and returns the calibrated sample value for the channel specified in the first argument.
	The calibrated sample value is obtained by applying channel-specific sample offsets and gains as present in the file's ''~~SourceChOffsets~~'' and ''~~SourceChGains~~'' parameters.		The calibrated sample value is obtained by applying channel-specific sample offsets and gains as present in the file's ''SourceChOffset'' and ''SourceChGain'' parameters.

	===ReadStateVector(sample)===		===ReadStateVector(sample)===

Mellinger: /* States (r) */

2010-06-29T13:44:16Z

States (r)

← Older revision		Revision as of 13:44, 29 June 2010
Line 46:		Line 46:
	Access to an individual parameter, following the [[Programming_Reference:Environment_Class#Access_to_Parameters_and_States\|syntax provided by the <tt>Environment</tt> class]].		Access to an individual parameter, following the [[Programming_Reference:Environment_Class#Access_to_Parameters_and_States\|syntax provided by the <tt>Environment</tt> class]].
	===States (r)===		===States (r)===
	A [[Programming Reference:States\|<tt>StateList</tt>]] object containing all state variables present in the file.		A [[Programming Reference:States#StateList Class\|<tt>StateList</tt>]] object containing all state variables present in the file.

	===State (r)===		===State (r)===

Mellinger: /* Parameters (r) */

2010-06-29T13:43:56Z

Parameters (r)

← Older revision		Revision as of 13:43, 29 June 2010
Line 41:		Line 41:
	The state vector's length in bytes.		The state vector's length in bytes.
	===Parameters (r)===		===Parameters (r)===
	A [[Programming Reference:Parameters\|<tt>ParamList</tt>]] object that contains all parameters present in the file.		A [[Programming Reference:Parameters#ParamList Class\|<tt>ParamList</tt>]] object that contains all parameters present in the file.

	===Parameter (r)===		===Parameter (r)===

Mellinger: /* States (r) */

2010-06-29T13:43:21Z

States (r)

← Older revision		Revision as of 13:43, 29 June 2010
Line 46:		Line 46:
	Access to an individual parameter, following the [[Programming_Reference:Environment_Class#Access_to_Parameters_and_States\|syntax provided by the <tt>Environment</tt> class]].		Access to an individual parameter, following the [[Programming_Reference:Environment_Class#Access_to_Parameters_and_States\|syntax provided by the <tt>Environment</tt> class]].
	===States (r)===		===States (r)===
	A ~~state list~~ object containing all state variables present in the file.		A [[Programming Reference:States\|<tt>StateList</tt>]] object containing all state variables present in the file.

	===State (r)===		===State (r)===
	Access to an individual state variable, following the [[Programming_Reference:Environment_Class#Access_to_Parameters_and_States\|syntax provided by the <tt>Environment</tt> class]]. The returned value will match the state variable's value at the current sample position, as specified to a previous call to one of the <tt>RawValue</tt>, <tt>CalibratedValue</tt>, or <tt>ReadStateVector</tt> methods.		Access to an individual state variable, following the [[Programming_Reference:Environment_Class#Access_to_Parameters_and_States\|syntax provided by the <tt>Environment</tt> class]]. The returned value will match the state variable's value at the current sample position, as specified to a previous call to one of the <tt>RawValue</tt>, <tt>CalibratedValue</tt>, or <tt>ReadStateVector</tt> methods.

Mellinger: /* Parameters (r) */

2010-06-29T13:41:44Z

Parameters (r)

← Older revision		Revision as of 13:41, 29 June 2010
Line 41:		Line 41:
	The state vector's length in bytes.		The state vector's length in bytes.
	===Parameters (r)===		===Parameters (r)===
	A ~~parameter list~~ object that contains all parameters present in the file.		A [[Programming Reference:Parameters\|<tt>ParamList</tt>]] object that contains all parameters present in the file.

	===Parameter (r)===		===Parameter (r)===
	Access to an individual parameter, following the [[Programming_Reference:Environment_Class#Access_to_Parameters_and_States\|syntax provided by the <tt>Environment</tt> class]].		Access to an individual parameter, following the [[Programming_Reference:Environment_Class#Access_to_Parameters_and_States\|syntax provided by the <tt>Environment</tt> class]].

Mellinger: /* SignalProperties (r) */

2010-06-29T13:32:17Z

SignalProperties (r)

← Older revision		Revision as of 13:32, 29 June 2010
Line 32:		Line 32:
	The currently opened data file's sampling rate.		The currently opened data file's sampling rate.
	===SignalProperties (r)===		===SignalProperties (r)===
	A [[~~Programming Reference~~:~~SignalProperties Class~~\|<tt>SignalProperties</tt>]] object describing the current file's data format, number of channels, sample block size (in its Elements property), and physical units.		A [[Programming_Reference:Signals#SignalProperties_Class\|<tt>SignalProperties</tt>]] object describing the current file's data format, number of channels, sample block size (in its Elements property), and physical units.

	===FileFormatVersion (r)===		===FileFormatVersion (r)===

Mellinger: /* SignalProperties (r) */

2010-06-29T13:30:38Z

SignalProperties (r)

← Older revision		Revision as of 13:30, 29 June 2010
Line 32:		Line 32:
	The currently opened data file's sampling rate.		The currently opened data file's sampling rate.
	===SignalProperties (r)===		===SignalProperties (r)===
	A [[Programming Reference:SignalProperties ~~class~~\|<tt>SignalProperties</tt>]] object describing the current file's data format, number of channels, sample block size (in its Elements property), and physical units.		A [[Programming Reference:SignalProperties Class\|<tt>SignalProperties</tt>]] object describing the current file's data format, number of channels, sample block size (in its Elements property), and physical units.

	===FileFormatVersion (r)===		===FileFormatVersion (r)===

Mellinger: /* SignalProperties (r) */

2010-06-29T13:30:19Z

SignalProperties (r)

← Older revision		Revision as of 13:30, 29 June 2010
Line 32:		Line 32:
	The currently opened data file's sampling rate.		The currently opened data file's sampling rate.
	===SignalProperties (r)===		===SignalProperties (r)===
	A <tt>SignalProperties</tt> object describing the current file's data format, number of channels, sample block size (in its Elements property), and physical units.		A [[Programming Reference:SignalProperties class\|<tt>SignalProperties</tt>]] object describing the current file's data format, number of channels, sample block size (in its Elements property), and physical units.

	===FileFormatVersion (r)===		===FileFormatVersion (r)===
	A string describing the file's format as specified by the file header. Currently, this is "1.0" or "1.1".		A string describing the file's format as specified by the file header. Currently, this is "1.0" or "1.1".

Mellinger: /* State (r) */

2010-06-29T13:26:58Z

State (r)

← Older revision		Revision as of 13:26, 29 June 2010
Line 46:		Line 46:
	A state list object containing all state variables present in the file.		A state list object containing all state variables present in the file.
	===State (r)===		===State (r)===
	Access to an individual state variable, following the [[Programming_Reference:Environment_Class#Access_to_Parameters_and_States\|syntax provided by the <tt>Environment</tt> class]]. The returned value will match the state variable's value at the current sample position, as specified by one the <tt>RawValue</tt>, <tt>CalibratedValue</tt>, or <tt>ReadStateVector</tt> methods.		Access to an individual state variable, following the [[Programming_Reference:Environment_Class#Access_to_Parameters_and_States\|syntax provided by the <tt>Environment</tt> class]]. The returned value will match the state variable's value at the current sample position, as specified to a previous call to one of the <tt>RawValue</tt>, <tt>CalibratedValue</tt>, or <tt>ReadStateVector</tt> methods.

	===StateVector (r)===		===StateVector (r)===
	Access to the full state vector, with state values matching those at the current sample position.		Access to the full state vector, with state values matching those at the current sample position.

Mellinger: /* ReadStateVector(sample) */

2010-06-29T13:23:52Z

ReadStateVector(sample)

← Older revision		Revision as of 13:23, 29 June 2010
Line 17:		Line 17:

	===ReadStateVector(sample)===		===ReadStateVector(sample)===
	~~Set~~ the current sample position to the specified value, and reads state vector data.		Sets the current sample position to the specified value, and reads state vector data.

	==Properties==		==Properties==