Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
S1S2Stimulus.cpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, are permitted provided that the following conditions are met:
14 * Redistributions of source code must retain the above copyright notice,
15 this list of conditions and the following disclaimer.
16 * Redistributions in binary form must reproduce the above copyright notice,
17 this list of conditions and the following disclaimer in the documentation
18 and/or other materials provided with the distribution.
19 * Neither the name of the University of Oxford nor the names of its
20 contributors may be used to endorse or promote products derived from this
21 software without specific prior written permission.
22
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36#include "S1S2Stimulus.hpp"
37#include "Exception.hpp"
38
39S1S2Stimulus::S1S2Stimulus(double magnitude, double stimulusDuration, double s1Duration, double s1Period, double startTime, std::vector<double> s2Periods)
41{
42 mNumS2FrequencyValues = s2Periods.size();
43 for (unsigned i=0; i<mNumS2FrequencyValues; i++)
44 {
45 boost::shared_ptr<MultiStimulus> p_experiment_stimulus(new MultiStimulus());
46
47 // The 0.5*(s1Period-stimulusDuration) taken off the stop time is to avoid getting a double stimulus at the instant s1Duration+startTime (#2442).
48 boost::shared_ptr<RegularStimulus> p_s1(new RegularStimulus(magnitude, stimulusDuration, s1Period, startTime, s1Duration+startTime-0.5*(s1Period-stimulusDuration)));
49 boost::shared_ptr<RegularStimulus> p_s2(new RegularStimulus(magnitude, stimulusDuration, s2Periods[i], s1Duration+startTime, s1Duration + 2*s2Periods[i]+startTime));
50
51 p_experiment_stimulus->AddStimulus(p_s1);
52 p_experiment_stimulus->AddStimulus(p_s2);
53
54 // We hijack the mStimulus of the MultiStimulus class to
55 // record different stimuli for each S2 frequency.
56 this->AddStimulus(p_experiment_stimulus);
57 }
58 mS2Index=0u;
59}
60
61double S1S2Stimulus::GetStimulus(double time)
62{
63 return this->mStimuli[mS2Index]->GetStimulus(time);
64}
65
67{
68 if (index < mNumS2FrequencyValues)
69 {
70 mS2Index = index;
71 }
72 else
73 {
74 EXCEPTION("There are fewer S2 frequency values than the one you have requested.");
75 }
76}
77
82
83
86
87
#define EXCEPTION(message)
#define CHASTE_CLASS_EXPORT(T)
std::vector< boost::shared_ptr< AbstractStimulusFunction > > mStimuli
void AddStimulus(boost::shared_ptr< AbstractStimulusFunction > pStimulus)
unsigned mNumS2FrequencyValues
double GetStimulus(double time)
unsigned mS2Index
unsigned GetNumS2FrequencyValues()
void SetS2ExperimentPeriodIndex(unsigned index)