Programming Reference:FeedbackTask Class - Revision history

Mellinger: /* Synopsis */

2008-08-19T12:45:01Z

Synopsis

← Older revision		Revision as of 12:45, 19 August 2008
Line 10:		Line 10:
	handlers by overriding its virtual functions.		handlers by overriding its virtual functions.

	In the BCI2000 core distribution, the [[User Reference:CursorTask\|CursorTask]] application module is based on the <tt>FeedbackTask</tt> base class, and implements its own specialized behavior on top of it. As a simplified example, the [[Programming Reference:FeedbackDemo\|FeedbackDemo]] application module demonstrates how to create your own feedback-trial application module based on <tt>FeedbackTask</tt>.		In the BCI2000 core distribution, the [[User Reference:CursorTask\|CursorTask]] application module is based on the <tt>FeedbackTask</tt> base class, and implements its own specialized behavior on top of it. As a simplified example, the [[Programming Reference:FeedbackDemo Application\|FeedbackDemo]] application module demonstrates how to create your own feedback-trial application module based on <tt>FeedbackTask</tt>.

	==Events==		==Events==

Mellinger: /* See also */

2008-08-19T12:44:26Z

See also

← Older revision		Revision as of 12:44, 19 August 2008
Line 117:		Line 117:

	==See also==		==See also==
	[[Programming Reference:ApplicationBase Class]],[[Programming Reference:GenericFilter Class]],[[Programming Reference:FeedbackDemo Application]];		[[Programming Reference:ApplicationBase Class]],[[Programming Reference:GenericFilter Class]],[[Programming Reference:FeedbackDemo Application]]

	[[User Reference:CursorTask]]		[[User Reference:CursorTask]]

	[[Category:Framework API]][[Category:Development]][[Category:Filters]][[Category:User Application]]		[[Category:Framework API]][[Category:Development]][[Category:Filters]][[Category:User Application]]

Mellinger: /* See also */

2008-08-19T12:44:16Z

See also

← Older revision		Revision as of 12:44, 19 August 2008
Line 117:		Line 117:

	==See also==		==See also==
	[[Programming Reference:ApplicationBase Class]],[[Programming Reference:GenericFilter Class]],[[~~User~~ Reference:~~CursorTask~~]],[[~~Programming~~ Reference:~~FeedbackDemo Application~~]],		[[Programming Reference:ApplicationBase Class]],[[Programming Reference:GenericFilter Class]],[[Programming Reference:FeedbackDemo Application]];

			[[User Reference:CursorTask]]

	[[Category:Framework API]][[Category:Development]][[Category:Filters]][[Category:User Application]]		[[Category:Framework API]][[Category:Development]][[Category:Filters]][[Category:User Application]]

Mellinger: /* See also */

2008-08-19T12:43:37Z

See also

← Older revision		Revision as of 12:43, 19 August 2008
Line 117:		Line 117:

	==See also==		==See also==
	[[Programming Reference:ApplicationBase Class]],[[Programming Reference:GenericFilter Class]],[[User Reference:CursorTask]],[[Programming Reference:FeedbackDemo ~~Class~~]],		[[Programming Reference:ApplicationBase Class]],[[Programming Reference:GenericFilter Class]],[[User Reference:CursorTask]],[[Programming Reference:FeedbackDemo Application]],

	[[Category:Framework API]][[Category:Development]][[Category:Filters]][[Category:User Application]]		[[Category:Framework API]][[Category:Development]][[Category:Filters]][[Category:User Application]]

Mellinger: /* See also */

2008-08-19T12:42:50Z

See also

← Older revision		Revision as of 12:42, 19 August 2008
Line 117:		Line 117:

	==See also==		==See also==
	[[~~User~~ Reference:~~CursorTask~~]], [[Programming Reference:~~FeedbackDemo~~]], [[~~Programming~~ Reference:~~GenericFilter Class~~]], [[Programming Reference:~~:ApplicationBase~~ Class]]		[[Programming Reference:ApplicationBase Class]],[[Programming Reference:GenericFilter Class]],[[User Reference:CursorTask]],[[Programming Reference:FeedbackDemo Class]],

	[[Category:Framework API]][[Category:Development]][[Category:Filters]][[Category:User Application]]		[[Category:Framework API]][[Category:Development]][[Category:Filters]][[Category:User Application]]

Mellinger: /* FeedbackTask(GUI::GraphDisplay=NULL) /

2008-08-19T12:41:48Z

FeedbackTask(GUI::GraphDisplay*=NULL)

← Older revision		Revision as of 12:41, 19 August 2008
Line 105:		Line 105:
	===FeedbackTask(GUI::GraphDisplay*=NULL)===		===FeedbackTask(GUI::GraphDisplay*=NULL)===
	The <tt>FeedbackTask</tt> constructor allows to specify a pointer to a [[Programming Reference:GUI::GraphDisplay Class\|<tt>GUI::GraphDisplay</tt> object representing the screen area where the output should appear, e.g. the application window.		The <tt>FeedbackTask</tt> constructor allows to specify a pointer to a [[Programming Reference:GUI::GraphDisplay Class\|<tt>GUI::GraphDisplay</tt> object representing the screen area where the output should appear, e.g. the application window.
	The constructor parameter is not used by the <tt>FeedbackTask</tt> class itself but forwarded to the [[Programming Reference::ApplicationBase Class\|<tt>ApplicationBase</tt>]] class constructor; for details, see [[Programming Reference::ApplicationBase Class]].		The constructor parameter is not used by the <tt>FeedbackTask</tt> class itself but forwarded to the [[Programming Reference:ApplicationBase Class\|<tt>ApplicationBase</tt>]] class constructor; for details, see [[Programming Reference:ApplicationBase Class]].

	==Parameters==		==Parameters==

Mellinger: /* Properties */

2008-08-19T12:29:50Z

Properties

← Older revision		Revision as of 12:29, 19 August 2008
Line 99:		Line 99:
	==Properties==		==Properties==
	<tt>FeedbackTask</tt> properties are protected, i.e. intended for use from descendant classes only.		<tt>FeedbackTask</tt> properties are protected, i.e. intended for use from descendant classes only.
	{{{ApplicationBaseProperties\|classname=FeedbackTask\|hlevel====}}}		{{ApplicationBaseProperties\|classname=FeedbackTask\|hlevel====}}

	==Methods==		==Methods==

Mellinger: /* Properties */

2008-08-19T12:29:11Z

Properties

← Older revision		Revision as of 12:29, 19 August 2008
Line 99:		Line 99:
	==Properties==		==Properties==
	<tt>FeedbackTask</tt> properties are protected, i.e. intended for use from descendant classes only.		<tt>FeedbackTask</tt> properties are protected, i.e. intended for use from descendant classes only.
			{{{ApplicationBaseProperties\|classname=FeedbackTask\|hlevel====}}}
	===~~ostream AppLog, AppLog.File, AppLog.Screen (w)~~===
	~~Inheriting from [[Programming Reference:ApplicationBase Class\|<tt>ApplicationBase</tt>]], descendants of <tt>FeedbackTask</tt> have access~~
	to the [[Programming Reference:ApplicationBase Class#Application Log\|<tt>AppLog</tt>]], [[Programming Reference:ApplicationBase Class#Application Log\|<tt>AppLog.File</tt>]], and [[Programming Reference:ApplicationBase Class#Application Log\|<tt>AppLog.Screen</tt>]] streams which are members of <tt>ApplicationBase</tt>.
	~~These streams allow convenient output into an application log file (<tt>AppLog.File</tt>), an application log window (<tt>AppLog.Screen</tt>), and both simultaneously (<tt>AppLog</tt>).~~

	==Methods==		==Methods==

Mellinger: /* ostream AppLog, AppLog.File, AppLog.Screen (w) */

2008-08-19T12:19:49Z

ostream AppLog, AppLog.File, AppLog.Screen (w)

← Older revision		Revision as of 12:19, 19 August 2008
Line 101:		Line 101:

	===ostream AppLog, AppLog.File, AppLog.Screen (w)===		===ostream AppLog, AppLog.File, AppLog.Screen (w)===
	Inheriting from [[Programming Reference:ApplicationBase Class\|<tt>ApplicationBase</tt>]], descendants of <tt>~~StimulusTask~~</tt> have access		Inheriting from [[Programming Reference:ApplicationBase Class\|<tt>ApplicationBase</tt>]], descendants of <tt>FeedbackTask</tt> have access
	to the [[Programming Reference:ApplicationBase Class#Application Log\|<tt>AppLog</tt>]], [[Programming Reference:ApplicationBase Class#Application Log\|<tt>AppLog.File</tt>]], and [[Programming Reference:ApplicationBase Class#Application Log\|<tt>AppLog.Screen</tt>]] streams which are members of <tt>ApplicationBase</tt>.		to the [[Programming Reference:ApplicationBase Class#Application Log\|<tt>AppLog</tt>]], [[Programming Reference:ApplicationBase Class#Application Log\|<tt>AppLog.File</tt>]], and [[Programming Reference:ApplicationBase Class#Application Log\|<tt>AppLog.Screen</tt>]] streams which are members of <tt>ApplicationBase</tt>.
	These streams allow convenient output into an application log file (<tt>AppLog.File</tt>), an application log window (<tt>AppLog.Screen</tt>), and both simultaneously (<tt>AppLog</tt>).		These streams allow convenient output into an application log file (<tt>AppLog.File</tt>), an application log window (<tt>AppLog.Screen</tt>), and both simultaneously (<tt>AppLog</tt>).

Mellinger at 12:19, 19 August 2008

2008-08-19T12:19:13Z

New page

==Location==
<tt>BCI2000/src/shared/modules/application</tt>

==Synopsis==
The <tt>FeedbackTask</tt> class is a base class for [[Technical Reference:Core Modules#Application Module|application modules]] that that provide feedback in a [[BCI2000 Glossary#Trial|trial-based]] paradigm. You do not use objects of type <tt>FeedbackTask</tt> directly; rather, you implement your own class that inherits from it, and implements specialized behavior building on the base functionality provided by the <tt>FeedbackTask</tt> class.

The <tt>FeedbackTask</tt> class performs sequencing, creates a block-randomized sequence of target codes, and dispatches [[Programming Reference:GenericFilter Class#Process|<tt>GenericFilter::Process()</tt>]]
calls to its virtual member functions.
Child classes (descendants) of <tt>FeedbackTask</tt> implement event
handlers by overriding its virtual functions.

In the BCI2000 core distribution, the [[User Reference:CursorTask|CursorTask]] application module is based on the <tt>FeedbackTask</tt> base class, and implements its own specialized behavior on top of it. As a simplified example, the [[Programming Reference:FeedbackDemo|FeedbackDemo]] application module demonstrates how to create your own feedback-trial application module based on <tt>FeedbackTask</tt>.

==Events==
===Events Summary===
The following table indicates which events exist, and the temporal sequence in which they occur. Trial-based applicatons proceed in "phases"; each trial consists of a ''PreFeedback'', ''Feedback'', and ''PostFeedback'' phase, and is followed with an ''ITI (Inter-Trial Interval)'' phase lasting until the next trial begins.

Events marked with * may occur multiple times in a row.

Progress from one application state to the next will occur according to the [[#Parameters|sequencing
parameters]], or if requested by a handler via its <tt>doProgress</tt> output argument (see [[#Input events|Input events]] below).

{|border="0"
! align="left"| Sequence of events
!   
! align="left"| Phase
!    
! align="left"| Typical application behavior
|-
| OnPreflight ||  
|-
| OnInitialize ||  
|-
| OnStartRun ||   ||  ||   || display initial message such as "please prepare"
|-
| DoPreRun* ||   || PreRun
|-
| Loop {
|-
|     OnTrialBegin ||   ||   ||   || display target
|-
|     DoPreFeedback* ||   || PreFeedback
|-
|     OnFeedbackBegin ||   ||   ||   || show cursor
|-
|     DoFeedback* ||   || Feedback ||   || update cursor position
|-
|     OnFeedbackEnd ||   ||   ||   || hide cursor, mark target as hit
|-
|     DoPostFeedback* ||   || PostFeedback
|-
|     OnTrialEnd ||   ||   ||   || hide targets
|-
|     DoITI* ||   || ITI
|-
| }
|-
| OnStopRun ||   ||   ||   || display final message, e.g. "finished"
|-
| OnHalt
|}

===Events forwarded from the GenericFilter interface===
====OnPreflight(SignalProperties (r))====
====OnInitialize(SignalProperties (r))====
These events are forwarded from the inherited [[Programming Reference:GenericFilter Class#Preflight|<tt>GenericFilter::Preflight</tt>]] and [[Programming Reference:GenericFilter Class#Initialize|<tt>GenericFilter::Initialize</tt>]] events, with input signal properties as an argument. Within the [[Programming Reference:Filter Chain|BCI2000 filter chain]], the <tt>FeedbackTask</tt> class always writes its input signal through to its output signal, so no ''output'' signal properties are provided to these event handlers.
====OnStartRun====
====OnStopRun====
====OnHalt====
These events are forwarded from [[Programming Reference:GenericFilter Class|<tt>GenericFilter</tt>'s]] ''StartRun'', ''StopRun'', and ''Halt'' events.

===Phase transition Events ===
These events are triggered by phase transitions during a run, e.g., the ''OnFeedbackBegin'' event handler is called whenever the phase changes from ''PreFeedback'' to ''Feedback''.
====OnTrialBegin====
Typically, an application will announce or display the desired target from this event handler.
====OnTrialEnd====
From this event handler, an application will typically clear the feedback screen.
====OnFeedbackBegin====
A feedback application will typically display the feedback cursor at its initial position.
====OnFeedbackEnd====
From this event handler, visual feedback about the classification result is typically provided, e.g. by changing the color of a target that has been hit.

===Input Events===
Each call to [[Programming Reference:GenericFilter Class#Process|<tt>GenericFilter::Process()</tt>]] is dispatched to one of these
event handlers, depending on the phase in the feedback trial, with each handler function corresponding to a phase.

With the exception of ''DoFeedback'', these event handlers will typically not be used by a task class that inherits from <tt>FeedbackTask</tt>, unless it needs to modify the standard sequencing behavior, such that it progresses faster or slower from one phase to the next, or subdivides a phase into two or more sub-phases.

Modifying sequencing behavior is possible through the handlers' ''doProgress'' argument. ''doProgress'' will typically be set to ''false'', except for the last call to the handler during the current phase in the sequence.
A handler may modify the application's sequencing behavior by setting the ''doProgress'' argument: setting it from ''false'' to ''true'' will proceed to the next phase earlier than prescribed by the [[#Parameters|sequencing parameters]], and setting it to ''false'' from ''true'' will defer progressing, such that the handler will be called again, until its ''doProgress'' argument is actually ''true'' on exit.
====DoPreRun(GenericSignal (r), bool doProgress (rw))====
====DoPreFeedback(GenericSignal (r), bool doProgress (rw))====
====DoFeedback(GenericSignal (r), bool doProgress (rw))====
From this event handler, a typical feedback application will update cursor position according to the current control signal.
In case of variable-length trials, it will also test whether a target has been hit, and set ''doProgress'' to ''true'' if this is the case.
====DoPostFeedback(GenericSignal (r), bool doProgress (rw))====
====DoITI(GenericSignal (r), bool doProgress (rw))====

==Properties==
<tt>FeedbackTask</tt> properties are protected, i.e. intended for use from descendant classes only.

===ostream AppLog, AppLog.File, AppLog.Screen (w)===
Inheriting from [[Programming Reference:ApplicationBase Class|<tt>ApplicationBase</tt>]], descendants of <tt>StimulusTask</tt> have access
to the [[Programming Reference:ApplicationBase Class#Application Log|<tt>AppLog</tt>]], [[Programming Reference:ApplicationBase Class#Application Log|<tt>AppLog.File</tt>]], and [[Programming Reference:ApplicationBase Class#Application Log|<tt>AppLog.Screen</tt>]] streams which are members of <tt>ApplicationBase</tt>.
These streams allow convenient output into an application log file (<tt>AppLog.File</tt>), an application log window (<tt>AppLog.Screen</tt>), and both simultaneously (<tt>AppLog</tt>).

==Methods==
Methods are declared protected, i.e. for use by descendants only.
===FeedbackTask(GUI::GraphDisplay*=NULL)===
The <tt>FeedbackTask</tt> constructor allows to specify a pointer to a [[Programming Reference:GUI::GraphDisplay Class|<tt>GUI::GraphDisplay</tt> object representing the screen area where the output should appear, e.g. the application window.
The constructor parameter is not used by the <tt>FeedbackTask</tt> class itself but forwarded to the [[Programming Reference::ApplicationBase Class|<tt>ApplicationBase</tt>]] class constructor; for details, see [[Programming Reference::ApplicationBase Class]].

==Parameters==
{{FeedbackTaskParams}}

==States==
{{FeedbackTaskStates}}

==Timeline==
{{FeedbackTaskTimeline}}

==See also==
[[User Reference:CursorTask]], [[Programming Reference:FeedbackDemo]], [[Programming Reference:GenericFilter Class]], [[Programming Reference::ApplicationBase Class]]

[[Category:Framework API]][[Category:Development]][[Category:Filters]][[Category:User Application]]

Programming Reference:FeedbackTask Class - Revision history

Mellinger: /* Synopsis */

Mellinger: /* See also */

Mellinger: /* See also */

Mellinger: /* See also */

Mellinger: /* See also */

Mellinger: /* FeedbackTask(GUI::GraphDisplay*=NULL) */

Mellinger: /* Properties */

Mellinger: /* Properties */

Mellinger: /* ostream AppLog, AppLog.File, AppLog.Screen (w) */

Mellinger at 12:19, 19 August 2008

Mellinger: /* FeedbackTask(GUI::GraphDisplay=NULL) /