![]() |
Chaste Commit::333233612e3dcc941d260418acd7b5ccdc30390e
|
#include <RegularStimulus.hpp>
Public Member Functions | |
RegularStimulus (double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime=DBL_MAX) | |
double | GetStimulus (double time) |
double | GetPeriod () |
double | GetMagnitude () |
double | GetDuration () |
double | GetStartTime () |
void | SetMagnitude (double magnitude) |
void | SetPeriod (double period) |
void | SetDuration (double duration) |
void | SetStartTime (double startTime) |
void | SetStopTime (double stopTime) |
![]() | |
virtual | ~AbstractStimulusFunction () |
virtual void | Clear () |
Protected Attributes | |
double | mMagnitudeOfStimulus |
double | mDuration |
double | mPeriod |
double | mStartTime |
double | mStopTime |
Private Member Functions | |
template<class Archive > | |
void | serialize (Archive &archive, const unsigned int version) |
Friends | |
class | boost::serialization::access |
Provides a periodic square-wave stimulus.
Definition at line 48 of file RegularStimulus.hpp.
RegularStimulus::RegularStimulus | ( | double | magnitudeOfStimulus, |
double | duration, | ||
double | period, | ||
double | startTime, | ||
double | stopTime = DBL_MAX |
||
) |
Create a new stimulus.
magnitudeOfStimulus | The size of the stimulus |
duration | How long the square wave is applied for |
period | The time between square waves being applied |
startTime | The time at which the first wave is applied |
stopTime | The time the stimulus is removed (defaults to DBL_MAX if omitted) |
Definition at line 43 of file RegularStimulus.cpp.
References mDuration, mMagnitudeOfStimulus, mPeriod, mStartTime, and mStopTime.
double RegularStimulus::GetDuration | ( | ) |
Definition at line 93 of file RegularStimulus.cpp.
References mDuration.
double RegularStimulus::GetMagnitude | ( | ) |
Definition at line 88 of file RegularStimulus.cpp.
References mMagnitudeOfStimulus.
double RegularStimulus::GetPeriod | ( | ) |
Definition at line 83 of file RegularStimulus.cpp.
References mPeriod.
double RegularStimulus::GetStartTime | ( | ) |
Definition at line 98 of file RegularStimulus.cpp.
References mStartTime.
Get the magnitude of stimulus at time 'time'
time | The current time |
Implements AbstractStimulusFunction.
Reimplemented in RegularStimulusZeroNetCharge.
Definition at line 58 of file RegularStimulus.cpp.
References mDuration, mMagnitudeOfStimulus, mPeriod, mStartTime, and mStopTime.
|
inlineprivate |
Archive the simple stimulus, never used directly - boost uses this.
archive | |
version |
Definition at line 60 of file RegularStimulus.hpp.
References mDuration, mMagnitudeOfStimulus, mPeriod, mStartTime, and mStopTime.
void RegularStimulus::SetDuration | ( | double | duration | ) |
set the length ('duration') of the stimulus square wave.
duration | The stimulus duration to use. |
Definition at line 113 of file RegularStimulus.cpp.
References mDuration.
void RegularStimulus::SetMagnitude | ( | double | magnitude | ) |
Set the magnitude of the stimulus to apply. Takes units of uA/cm^2 in single cell simulations or uA/cm^3 in tissue simulations
See https://chaste.github.io/docs/user-guides/chaste-units/ for a full discussion of this.
magnitude | The magnitude of stimulus to apply. |
Definition at line 103 of file RegularStimulus.cpp.
References mMagnitudeOfStimulus.
void RegularStimulus::SetPeriod | ( | double | period | ) |
set the pacing cycle length ('period') of the stimulus.
period | The stimulus pacing cycle length to use. |
Definition at line 108 of file RegularStimulus.cpp.
References mPeriod.
void RegularStimulus::SetStartTime | ( | double | startTime | ) |
Set the stimulus to start at a particular time.
startTime | the time the stimulus should begin. |
Definition at line 118 of file RegularStimulus.cpp.
References mStartTime.
void RegularStimulus::SetStopTime | ( | double | stopTime | ) |
Set the stop time for this stimulus. It will never be applied after this time.
stopTime |
Definition at line 123 of file RegularStimulus.cpp.
References mStopTime.
|
friend |
Needed for serialization.
Definition at line 52 of file RegularStimulus.hpp.
|
protected |
The length of the square wave
Definition at line 76 of file RegularStimulus.hpp.
Referenced by RegularStimulus(), GetDuration(), GetStimulus(), RegularStimulusZeroNetCharge::GetStimulus(), serialize(), and SetDuration().
|
protected |
The 'height' of the square wave applied
Definition at line 74 of file RegularStimulus.hpp.
Referenced by RegularStimulus(), GetMagnitude(), GetStimulus(), RegularStimulusZeroNetCharge::GetStimulus(), serialize(), and SetMagnitude().
|
protected |
The time between applications of the wave
Definition at line 78 of file RegularStimulus.hpp.
Referenced by RegularStimulus(), GetPeriod(), GetStimulus(), RegularStimulusZeroNetCharge::GetStimulus(), serialize(), and SetPeriod().
|
protected |
The time at which the first wave is applied
Definition at line 80 of file RegularStimulus.hpp.
Referenced by RegularStimulus(), GetStartTime(), GetStimulus(), RegularStimulusZeroNetCharge::GetStimulus(), serialize(), and SetStartTime().
|
protected |
The time at which all stimuli are removed (even if halfway through a wave)
Definition at line 82 of file RegularStimulus.hpp.
Referenced by RegularStimulus(), GetStimulus(), RegularStimulusZeroNetCharge::GetStimulus(), serialize(), and SetStopTime().