Programming Reference:AssociationMap Class - Revision history

Mellinger: /* DeleteObjects() */

2008-11-27T10:13:34Z

DeleteObjects()

← Older revision		Revision as of 10:13, 27 November 2008
Line 38:		Line 38:

	''NB:'' You should not call this function for an <tt>Association</tt> object unless you can be sure that no stimulus is part of multiple associations. Otherwise, you will risk multiple deallocation of stimulus pointers.		''NB:'' You should not call this function for an <tt>Association</tt> object unless you can be sure that no stimulus is part of multiple associations. Otherwise, you will risk multiple deallocation of stimulus pointers.
	Typically, you will keep track of existing stimuli in a separate [[~~ProgrammingReference~~:~~Stimulus Class~~\|<tt>SetOfStimuli>/tt>]] object, and call that set's <tt>DeleteObjects()</tt> member function in order to dispose of stimulus objects.		Typically, you will keep track of existing stimuli in a separate [[Programming_Reference:Stimulus_Class#DeleteObjects.28.29\|<tt>SetOfStimuli</tt>]] object, and call that set's <tt>DeleteObjects()</tt> member function in order to dispose of stimulus objects.

	====Add(Stimulus pointer\|Target pointer)====		====Add(Stimulus pointer\|Target pointer)====

Mellinger: /* DeleteObjects() */

2008-11-27T10:12:29Z

DeleteObjects()

← Older revision		Revision as of 10:12, 27 November 2008
Line 36:		Line 36:
	====DeleteObjects()====		====DeleteObjects()====
	Deletes all stimulus and target objects that are part of the association, and clears the association.		Deletes all stimulus and target objects that are part of the association, and clears the association.

			''NB:'' You should not call this function for an <tt>Association</tt> object unless you can be sure that no stimulus is part of multiple associations. Otherwise, you will risk multiple deallocation of stimulus pointers.
			Typically, you will keep track of existing stimuli in a separate [[ProgrammingReference:Stimulus Class\|<tt>SetOfStimuli>/tt>]] object, and call that set's <tt>DeleteObjects()</tt> member function in order to dispose of stimulus objects.

	====Add(Stimulus pointer\|Target pointer)====		====Add(Stimulus pointer\|Target pointer)====
	Adds a stimulus or target object to the association.		Adds a stimulus or target object to the association.

Mellinger: /* Methods */

2008-11-27T09:52:49Z

Methods

← Older revision		Revision as of 09:52, 27 November 2008
Line 60:		Line 60:
	In a [[Programming Reference:StimulusTask Class\|StimulusTask]] descendant, the ''Associations'' property provides access to the single <tt>AssociationMap</tt> object stored inside the <tt>StimulusTask</tt> object.		In a [[Programming Reference:StimulusTask Class\|StimulusTask]] descendant, the ''Associations'' property provides access to the single <tt>AssociationMap</tt> object stored inside the <tt>StimulusTask</tt> object.

	Typically, only the subscript operator <~~pre~~>[]</~~pre~~> is required to assign stimulus codes to associations~~, and to read that information back, creating an empty <tt>Association</tt> object if the stimulus code is used for the first time~~:		Typically, only the subscript operator <tt>[]</tt> is required to assign stimulus codes to associations:
	Associations()[ myStimulusCode ].Add( pMyStimulus );		Associations()[ myStimulusCode ].Add( pMyStimulus );
			Similarly, association information may be read when the subscript operator appears on the right hand side of an assignment:
			int stimulusDuration = Associations()[ myStimulusCode ].StimulusDuration();
			In case there exists no <tt>Association</tt> object for a specified stimulus code, an empty <tt>Association</tt> object will be created with default properties.

	====bool StimuliIntersect(StimulusCode1, StimulusCode2)====		====bool StimuliIntersect(StimulusCode1, StimulusCode2)====

Mellinger: /* Association Class */

2008-09-10T17:46:53Z

Association Class

← Older revision		Revision as of 17:46, 10 September 2008
Line 11:		Line 11:
	An object of type <tt>Association</tt> defines a set consisting of [[Programming Reference:Stimulus Class\|stimuli]], an additional set of [[Programming Reference:Target Class\|targets]], and a number of properties associated with a single stimulus code.		An object of type <tt>Association</tt> defines a set consisting of [[Programming Reference:Stimulus Class\|stimuli]], an additional set of [[Programming Reference:Target Class\|targets]], and a number of properties associated with a single stimulus code.

	A user application based on the [[Programming Reference:StimulusTask\|StimulusTask]] class will present stimuli, or groups thereof, in sequence, and may select targets according to stimulus-related responses it obtains from the signal processing module.		A user application based on the [[Programming Reference:StimulusTask Class\|StimulusTask]] class will present stimuli, or groups thereof, in sequence, and may select targets according to stimulus-related responses it obtains from the signal processing module.

	The <tt>Association</tt> class serves to associate stimuli with each other, targets with each other, stimuli with targets, and to store sequencing information about such groups.		The <tt>Association</tt> class serves to associate stimuli with each other, targets with each other, stimuli with targets, and to store sequencing information about such groups.

Mellinger: /* int ISIMaxDuration (rw) */

2008-09-10T17:41:20Z

int ISIMaxDuration (rw)

← Older revision		Revision as of 17:41, 10 September 2008
Line 24:		Line 24:
	When ''ISIMinDuration'' is different from ''ISIMaxDuration'', the [[Programming Reference:StimulusTask Class\|StimulusTask]] base class will choose a random interval between the two from a uniform distribution.		When ''ISIMinDuration'' is different from ''ISIMaxDuration'', the [[Programming Reference:StimulusTask Class\|StimulusTask]] base class will choose a random interval between the two from a uniform distribution.

	The ''StimulusDuration'', ''ISIMinDuration'', ''ISIMaxDuration'' properties are not used by the <tt>Association</tt> class itself but by the [[Programming Reference:StimulusTask\|StimulusTask]] application base class to determine application sequencing.		The ''StimulusDuration'', ''ISIMinDuration'', ''ISIMaxDuration'' properties are not used by the <tt>Association</tt> class itself but by the [[Programming Reference:StimulusTask Class\|StimulusTask]] application base class to determine application sequencing.

	====SetOfStimuli Stimuli (rw)====		====SetOfStimuli Stimuli (rw)====

Mellinger at 17:40, 10 September 2008

2008-09-10T17:40:51Z

← Older revision		Revision as of 17:40, 10 September 2008
Line 63:		Line 63:
	Associations()[ myStimulusCode ].Add( pMyStimulus );		Associations()[ myStimulusCode ].Add( pMyStimulus );

	===bool StimuliIntersect(StimulusCode1, StimulusCode2)===		====bool StimuliIntersect(StimulusCode1, StimulusCode2)====
	Returns ''true'' if there is at least one stimulus object common to the two stimulus codes specified, ''false'' otherwise.		Returns ''true'' if there is at least one stimulus object common to the two stimulus codes specified, ''false'' otherwise.
	===bool TargetsIntersect(StimulusCode1, StimulusCode2)===		====bool TargetsIntersect(StimulusCode1, StimulusCode2)====
	Returns ''true'' if there is at least one target object common to the two stimulus codes specified, ''false'' otherwise.		Returns ''true'' if there is at least one target object common to the two stimulus codes specified, ''false'' otherwise.
	===SetOfStimuli TargetToStimuli(Target pointer)===		====SetOfStimuli TargetToStimuli(Target pointer)====
	Returns an intersection of all sets of stimuli that are associated with the specified target.		Returns an intersection of all sets of stimuli that are associated with the specified target.
	===TargetClassification ClassifyTargets(ClassResult)===		====TargetClassification ClassifyTargets(ClassResult)====
	Translates a <tt>ClassResult</tt> object into <tt>TargetClassification</tt> object.		Translates a <tt>ClassResult</tt> object into <tt>TargetClassification</tt> object.
	A <tt>ClassResult</tt> object contains classification values ''per stimulus code''; these values are translated into classification values ''per target''.		A <tt>ClassResult</tt> object contains classification values ''per stimulus code''; these values are translated into classification values ''per target''.

Mellinger: /* TargetClassification Class */

2008-09-10T17:39:55Z

TargetClassification Class

← Older revision		Revision as of 17:39, 10 September 2008
Line 77:		Line 77:

	==TargetClassification Class==		==TargetClassification Class==
			A <tt>TargetClassification</tt> object represents ''per-target'' classification values. Such an object is returned from <tt>AssociationMap::ClassifyTargets()</tt>.
			===Methods===
			====Target pointer MostLikelyTarget()====
			Returns a pointer to the target associated with the largets classification value, or NULL if there are no targets stored in the <tt>TargetClassification</tt> object.

	==See also==		==See also==

Mellinger: /* ClassResult Class */

2008-09-10T17:34:28Z

ClassResult Class

← Older revision		Revision as of 17:34, 10 September 2008
Line 74:		Line 74:

	==ClassResult Class==		==ClassResult Class==
	A mapping of stimulus codes to classification values. Classification values are computed by the [[User Reference:P3TemporalFilter\|P3TemporalFilter]] in conjunction with the [[User Reference:LinearClassifier\|LinearClassifier]], and accumulated inside a <tt>ClassResult</tt> object before translated into a target selection.		A mapping of stimulus codes to classification values. Classification values are computed by the [[User Reference:P3TemporalFilter\|P3TemporalFilter]] in conjunction with the [[User Reference:LinearClassifier\|LinearClassifier]], and accumulated by the [[Programming Reference:StimulusTask Class\|StimulusTask class]] inside a <tt>ClassResult</tt> object before translated into a target selection.

	==TargetClassification Class==		==TargetClassification Class==

Mellinger: /* ClassResult Class */

2008-09-10T17:33:52Z

ClassResult Class

← Older revision		Revision as of 17:33, 10 September 2008
Line 74:		Line 74:

	==ClassResult Class==		==ClassResult Class==
			A mapping of stimulus codes to classification values. Classification values are computed by the [[User Reference:P3TemporalFilter\|P3TemporalFilter]] in conjunction with the [[User Reference:LinearClassifier\|LinearClassifier]], and accumulated inside a <tt>ClassResult</tt> object before translated into a target selection.

	==TargetClassification Class==		==TargetClassification Class==

Mellinger: /* AssociationMap Class */

2008-09-10T17:30:05Z

AssociationMap Class

← Older revision		Revision as of 17:30, 10 September 2008
Line 52:		Line 52:

	==AssociationMap Class==		==AssociationMap Class==
			An <tt>AssocationMap</tt> links <tt>Associations</tt>, or groups of stimuli and targets, to stimulus codes. Each stimulus code maps to a single <tt>Association</tt> object, and vice versa.

			This way, the <tt>AssociationMap</tt> controls how stimuli are presented in groups, and sequences of groups, in a [[Programming Reference:StimulusTask Class\|stimulus task]], and it provides the information required to determine a selected target from a user response.

			===Methods===
			<tt>AssociationMap</tt> inherits publicly from <tt>std::map<int, Association</tt>, and provides all its member functions.
			In a [[Programming Reference:StimulusTask Class\|StimulusTask]] descendant, the ''Associations'' property provides access to the single <tt>AssociationMap</tt> object stored inside the <tt>StimulusTask</tt> object.

			Typically, only the subscript operator <pre>[]</pre> is required to assign stimulus codes to associations, and to read that information back, creating an empty <tt>Association</tt> object if the stimulus code is used for the first time:
			Associations()[ myStimulusCode ].Add( pMyStimulus );

			===bool StimuliIntersect(StimulusCode1, StimulusCode2)===
			Returns ''true'' if there is at least one stimulus object common to the two stimulus codes specified, ''false'' otherwise.
			===bool TargetsIntersect(StimulusCode1, StimulusCode2)===
			Returns ''true'' if there is at least one target object common to the two stimulus codes specified, ''false'' otherwise.
			===SetOfStimuli TargetToStimuli(Target pointer)===
			Returns an intersection of all sets of stimuli that are associated with the specified target.
			===TargetClassification ClassifyTargets(ClassResult)===
			Translates a <tt>ClassResult</tt> object into <tt>TargetClassification</tt> object.
			A <tt>ClassResult</tt> object contains classification values ''per stimulus code''; these values are translated into classification values ''per target''.

	==ClassResult Class==		==ClassResult Class==