Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
CellProperties.hpp
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#ifndef _CELLPROPERTIES_HPP_
37#define _CELLPROPERTIES_HPP_
38
39#include <vector>
40
54{
55private:
57 const std::vector<double>& mrVoltage;
59 const std::vector<double>& mrTime;
60
66
72 double mThreshold;
73
75 std::vector<double> mOnsets;
76
78 std::vector<double> mRestingValues;
79
81 std::vector<double> mCycleLengths;
82
84 std::vector<double> mPeakValues;
85
87 std::vector<double> mTimesAtPeakValues;
88
90 std::vector<double> mMaxUpstrokeVelocities;
91
93 std::vector<double> mTimesAtMaxUpstrokeVelocity;
94
96 std::vector<unsigned> mCounterOfPlateauDepolarisations;
97
101 void CalculateProperties();
102
115 std::vector<double> CalculateActionPotentialDurations(const double percentage);
116
121 void CheckExceededThreshold(void);
122
128 void CheckReturnedToThreshold(void);
129
130public:
139 CellProperties(const std::vector<double>& rVoltage,
140 const std::vector<double>& rTime,
141 double threshold = -30.0)
142 : mrVoltage(rVoltage),
143 mrTime(rTime),
145 mThreshold(threshold)
146 {
148 }
149
155 std::vector<double> GetMaxUpstrokeVelocities();
156
165
173
179 std::vector<double> GetTimesAtMaxUpstrokeVelocity();
180
189
197
203 std::vector<double> GetCycleLengths();
204
210 std::vector<double> GetPeakPotentials();
211
217 std::vector<double> GetTimesAtPeakPotentials();
218
225
231 double GetLastPeakPotential();
232
239
246
261 std::vector<double> GetRestingPotentials();
262
270
279 std::vector<double> GetAllActionPotentialDurations(const double percentage);
280
290 double GetLastActionPotentialDuration(const double percentage);
291
297 std::vector<double> GetActionPotentialAmplitudes();
298
305
310
315};
316
317#endif //_CELLPROPERTIES_HPP_
std::vector< double > mOnsets
std::vector< double > GetTimesAtMaxUpstrokeVelocity()
double GetTimeAtLastPeakPotential()
unsigned GetNumberOfAboveThresholdDepolarisationsForLastAp()
std::vector< double > GetPeakPotentials()
double GetLastRestingPotential()
const std::vector< double > & mrTime
std::vector< double > GetCycleLengths()
std::vector< double > mPeakValues
void CheckExceededThreshold(void)
double GetTimeAtLastCompleteMaxUpstrokeVelocity()
std::vector< unsigned > GetNumberOfAboveThresholdDepolarisationsForAllAps()
std::vector< double > mTimesAtPeakValues
std::vector< double > mMaxUpstrokeVelocities
double GetLastActionPotentialAmplitude()
std::vector< unsigned > mCounterOfPlateauDepolarisations
std::vector< double > GetAllActionPotentialDurations(const double percentage)
std::vector< double > mRestingValues
double GetTimeAtLastCompletePeakPotential()
std::vector< double > CalculateActionPotentialDurations(const double percentage)
void CheckReturnedToThreshold(void)
std::vector< double > mTimesAtMaxUpstrokeVelocity
double GetLastPeakPotential()
std::vector< double > GetTimesAtPeakPotentials()
double GetLastCompleteMaxUpstrokeVelocity()
CellProperties(const std::vector< double > &rVoltage, const std::vector< double > &rTime, double threshold=-30.0)
std::vector< double > GetMaxUpstrokeVelocities()
bool mUnfinishedActionPotentials
std::vector< double > GetActionPotentialAmplitudes()
const std::vector< double > & mrVoltage
std::vector< double > mCycleLengths
double GetTimeAtLastMaxUpstrokeVelocity()
double GetLastMaxUpstrokeVelocity()
double GetLastActionPotentialDuration(const double percentage)
double GetLastCompletePeakPotential()
std::vector< double > GetRestingPotentials()