S1S2Stimulus Class Reference

#include <S1S2Stimulus.hpp>

Collaboration diagram for S1S2Stimulus:

Public Member Functions
	S1S2Stimulus (double magnitude, double stimulusDuration, double s1Duration, double s1Period, double startTime, std::vector< double > s2Periods)
double	GetStimulus (double time)
void	SetS2ExperimentPeriodIndex (unsigned index)
unsigned	GetNumS2FrequencyValues ()
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
	S1S2Stimulus ()
Private Attributes
unsigned	mS2Index
unsigned	mNumS2FrequencyValues
Friends
class	boost::serialization::access

Detailed Description

This class provides a stimulus function which follows an S1-S2 protocol. i.e.

Run a RegularStimulus at a certain (S1) frequency Then run two pulses of a second RegularStimulus at another (S2) frequency. These are combined into a MultiStimulus.

We have a number of these MultiStimulus objects, created for a given vector s2Periods in the constructor. As a user you set which of these S2 frequencies to run with the method SetS2ExperimentPeriodIndex().

Definition at line 53 of file S1S2Stimulus.hpp.

Constructor & Destructor Documentation

S1S2Stimulus::S1S2Stimulus ( ) [inline, private]

Private constructor - for archiving's eyes only.

Definition at line 85 of file S1S2Stimulus.hpp.

S1S2Stimulus::S1S2Stimulus	(	double	magnitude,
		double	stimulusDuration,
		double	s1Duration,
		double	s1Period,
		double	startTime,
		std::vector< double >	s2Periods
	)

Constructor

Parameters:

	magnitude	The magnitude of the stimulus 'square wave'.
	stimulusDuration	The duration of the stimulus 'square wave'.
	s1Duration	The duration of the S1 phase of the experiment, should be a multiple of the s1Period.
	s1Period	The period of the S1 phase (typically ~1000ms for example).
	startTime	The time at which to begin the S1 stimulus (this delay is automatically added to give smooth transition to S2).
	s2Periods	A std::vector of the different S2 frequencies that should be run (for example {1000, 900, 800} (ms)).