Programming Reference:GenericVisualization Class - Revision history

Mellinger: /* Send(string|GenericSignal|SignalProperties|BitmapImage) */

2019-02-07T14:40:11Z

Send(string|GenericSignal|SignalProperties|BitmapImage)

← Older revision		Revision as of 14:40, 7 February 2019
Line 18:		Line 18:
	Rather than using <tt>GenericVisualization::Send(string)</tt> to send a log message, it is possible to use the <tt>std::ostream::operator<<()</tt> inserter:		Rather than using <tt>GenericVisualization::Send(string)</tt> to send a log message, it is possible to use the <tt>std::ostream::operator<<()</tt> inserter:
	GenericVisualization vis("MYLOG");		GenericVisualization vis("MYLOG");
	vis << "Starting run number " << runNumber << endl;		vis << "Starting run number " << runNumber << std::endl;

	==Properties==		==Properties==

Mellinger: /* See also */

2011-10-11T13:53:24Z

Mellinger: /* Presenting data to the operator user */

2008-09-15T10:43:19Z

Presenting data to the operator user

← Older revision		Revision as of 10:43, 15 September 2008
Line 1:		Line 1:
	==~~Presenting data to the operator user~~==		==Location==
	~~Your~~ filter may have information that it wants to present to the user		<tt>src/shared/types</tt>
	-
	e.g., the EEG signal might appear graphically in a window, or an		==Synopsis==
	application		A filter may have information that it wants to present to the user - e.g., the EEG signal might appear graphically in a window, or an
	task log should be presented. Packaging this information into core		application task log should be presented. Packaging this information into core messages, and sending these to the operator module, is handled by the
	messages,
	and sending these to the operator module, is handled by the
	<tt>GenericVisualization</tt> class.		<tt>GenericVisualization</tt> class.
	Typically, to visualize data this way, ~~you~~ will add a data member of		Typically, to visualize data this way, one will add a data member of type <tt>GenericVisualization</tt> to a filter class.
	type
	<tt>GenericVisualization</tt> to ~~your~~ filter class - ~~see~~		Note that visualization of a filter's output signal is handled transparently by the BCI2000 framework, and no code involving <tt>GenericVisualization</tt> needs to be written unless non-standard visualization behavior is required.
	[[Programming Tutorial:Implementing a Signal Processing Filter]] ~~for an example.~~
			==Methods==
			===GenericVisualization(string SourceID)===
			Typically, a visualization's sourceID property is set from its constructor, and remains unchanged throughout the object's lifetime.
			===Send(string\|GenericSignal\|SignalProperties\|BitmapImage)===
			Sends the specified object to the operator module, packaging it into an appropriate [[Technical_Reference:BCI2000_Messages\|BCI2000 message]]. Strings are sent as log messages, a SignalProperties object is converted into a sequence of corresponding messages of type [[Technical_Reference:BCI2000_Messages#Content_Descriptor.3D255:_Visualization_Configuration\|Visualization Configuration]].

			Rather than using <tt>GenericVisualization::Send(string)</tt> to send a log message, it is possible to use the <tt>std::ostream::operator<<()</tt> inserter:
			GenericVisualization vis("MYLOG");
			vis << "Starting run number " << runNumber << endl;

			==Properties==
			===string SourceID (rw)===
			The visualization source ID, identifying a target visualization window. This property corresponds to a [[Technical_Reference:BCI2000_Messages#Content_Descriptor.3D1:_Signal_Data\|visualization messages']] source identifier field.

			==See also==
			[[Programming Reference:GenericFilter Class]], [[Programming Tutorial:Implementing a Signal Processing Filter]]

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

Mellinger: /* Presenting data to the operator user */

2007-11-08T17:25:54Z

Presenting data to the operator user

← Older revision		Revision as of 17:25, 8 November 2007
Line 12:		Line 12:
	<tt>GenericVisualization</tt> to your filter class - see		<tt>GenericVisualization</tt> to your filter class - see
	[[Programming Tutorial:Implementing a Signal Processing Filter]] for an example.		[[Programming Tutorial:Implementing a Signal Processing Filter]] for an example.

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

Mellinger: Programming Reference:Visualization Class moved to Programming Reference:GenericVisualization Class

2007-11-07T10:57:55Z

Programming Reference:Visualization Class moved to Programming Reference:GenericVisualization Class

← Older revision		Revision as of 10:57, 7 November 2007
(No difference)

Mellinger at 18:23, 27 February 2007

2007-02-27T18:23:05Z

New page

==Presenting data to the operator user==
Your filter may have information that it wants to present to the user
-
e.g., the EEG signal might appear graphically in a window, or an
application
task log should be presented. Packaging this information into core
messages,
and sending these to the operator module, is handled by the
<tt>GenericVisualization</tt> class.
Typically, to visualize data this way, you will add a data member of
type
<tt>GenericVisualization</tt> to your filter class - see
[[Programming Tutorial:Implementing a Signal Processing Filter]] for an example.

← Older revision		Revision as of 13:53, 11 October 2011
Line 25:		Line 25:

	==See also==		==See also==
	[[Programming Reference:GenericFilter Class]], [[Programming Tutorial:Implementing a Signal Processing Filter]]		[[Programming Reference:GenericFilter Class]], [[Technical Reference:Visualization Properties]], [[Programming Tutorial:Implementing a Signal Processing Filter]]

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