Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
|
#include <RandomCellKiller.hpp>
Public Member Functions | |
RandomCellKiller (AbstractCellPopulation< DIM > *pCellPopulation, double probabilityOfDeathInAnHour) | |
double | GetDeathProbabilityInAnHour () const |
void | CheckAndLabelSingleCellForApoptosis (CellPtr pCell) |
void | CheckAndLabelCellsForApoptosisOrDeath () |
void | OutputCellKillerParameters (out_stream &rParamsFile) |
Public Member Functions inherited from AbstractCellKiller< DIM > | |
AbstractCellKiller (AbstractCellPopulation< SPACE_DIM > *pCellPopulation) | |
virtual | ~AbstractCellKiller () |
const AbstractCellPopulation< SPACE_DIM > * | GetCellPopulation () const |
void | OutputCellKillerInfo (out_stream &rParamsFile) |
Public Member Functions inherited from Identifiable | |
virtual | ~Identifiable () |
std::string | GetIdentifier () const |
Private Member Functions | |
template<class Archive > | |
void | serialize (Archive &archive, const unsigned int version) |
Private Attributes | |
double | mProbabilityOfDeathInAnHour |
Friends | |
class | boost::serialization::access |
Additional Inherited Members | |
Protected Attributes inherited from AbstractCellKiller< DIM > | |
AbstractCellPopulation< SPACE_DIM > * | mpCellPopulation |
A cell killer that randomly kills cells based on the user set probability.
The probability passed into the constructor will be the probability of any cell dying whenever CheckAndLabelCellsForApoptosis() is called.
Note this does take into account time steps - the input probability is the probability that in an hour's worth of trying, the cell killer will have successfully killed a given cell. In the method CheckAndLabelSingleCellForApoptosis() this probability is used to calculate the probability that the cell is killed at a given time step.
We assume a constant time step and that there are an integer number (n = 1/dt) of time steps per hour. We also assume that this method is called every time step and that the probabilities of dying at different times are independent.
Definition at line 63 of file RandomCellKiller.hpp.
RandomCellKiller< DIM >::RandomCellKiller | ( | AbstractCellPopulation< DIM > * | pCellPopulation, |
double | probabilityOfDeathInAnHour | ||
) |
Default constructor.
pCellPopulation | pointer to the cell population |
probabilityOfDeathInAnHour | probability that a cell is labelled for apoptosis in one hour's worth of trying |
Definition at line 39 of file RandomCellKiller.cpp.
References EXCEPTION, and RandomCellKiller< DIM >::mProbabilityOfDeathInAnHour.
|
virtual |
Loop over cells and start apoptosis randomly, based on the user-set probability.
Implements AbstractCellKiller< DIM >.
Definition at line 82 of file RandomCellKiller.cpp.
void RandomCellKiller< DIM >::CheckAndLabelSingleCellForApoptosis | ( | CellPtr | pCell | ) |
Overridden method to test a given cell for apoptosis.
pCell | the cell to test for apoptosis |
Definition at line 56 of file RandomCellKiller.cpp.
References SimulationTime::Instance(), RandomNumberGenerator::Instance(), and RandomNumberGenerator::ranf().
double RandomCellKiller< DIM >::GetDeathProbabilityInAnHour | ( | ) | const |
Definition at line 50 of file RandomCellKiller.cpp.
|
virtual |
Overridden OutputCellKillerParameters() method.
rParamsFile | the file stream to which the parameters are output |
Implements AbstractCellKiller< DIM >.
Definition at line 93 of file RandomCellKiller.cpp.
References AbstractCellKiller< SPACE_DIM >::OutputCellKillerParameters().
|
inlineprivate |
Archive the object.
archive | the archive |
version | the current version of this class |
Definition at line 82 of file RandomCellKiller.hpp.
References SerializableSingleton< SINGLETON_CLASS >::GetSerializationWrapper(), and RandomNumberGenerator::Instance().
|
friend |
Needed for serialization.
Definition at line 74 of file RandomCellKiller.hpp.
|
private |
Probability that in an hour's worth of trying, the cell killer will have successfully killed a given cell.
Definition at line 71 of file RandomCellKiller.hpp.
Referenced by RandomCellKiller< DIM >::RandomCellKiller().