RandomCellKiller< DIM > Class Template Reference

#include <RandomCellKiller.hpp>

Inheritance diagram for RandomCellKiller< DIM >:

Inheritance graph
[legend]
Collaboration diagram for RandomCellKiller< DIM >:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 RandomCellKiller (AbstractCellPopulation< DIM > *pCellPopulation, double probabilityOfDeathInAnHour)
double GetDeathProbabilityInAnHour () const
void TestAndLabelSingleCellForApoptosis (CellPtr pCell)
void TestAndLabelCellsForApoptosisOrDeath ()
void OutputCellKillerParameters (out_stream &rParamsFile)

Private Member Functions

template<class Archive>
void serialize (Archive &archive, const unsigned int version)

Private Attributes

double mProbabilityOfDeathInAnHour

Friends

class boost::serialization::access


Detailed Description

template<unsigned DIM>
class RandomCellKiller< DIM >

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 TestAndLabelCellsForApoptosis() is called.

Note this does take into account timesteps - 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 TestAndLabelSingleCellForApoptosis() this probability is used to calculate the probability that the cell is killed at a given time step.

Definition at line 51 of file RandomCellKiller.hpp.


Constructor & Destructor Documentation

template<unsigned DIM>
RandomCellKiller< DIM >::RandomCellKiller ( AbstractCellPopulation< DIM > *  pCellPopulation,
double  probabilityOfDeathInAnHour 
) [inline]

Default constructor.

Parameters:
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 32 of file RandomCellKiller.cpp.

References EXCEPTION, and RandomCellKiller< DIM >::mProbabilityOfDeathInAnHour.


Member Function Documentation

template<unsigned DIM>
template<class Archive>
void RandomCellKiller< DIM >::serialize ( Archive &  archive,
const unsigned int  version 
) [inline, private]

Archive the object and its member variables.

Serialization of singleton objects must be done with care. Before the object is serialized via a pointer, it *MUST* be serialized directly, or an assertion will trip when a second instance of the class is created on de-serialization.

Parameters:
archive the archive
version the current version of this class

Reimplemented from AbstractCellKiller< DIM >.

Definition at line 75 of file RandomCellKiller.hpp.

References RandomNumberGenerator::Instance().

template<unsigned DIM>
double RandomCellKiller< DIM >::GetDeathProbabilityInAnHour (  )  const [inline]

Returns:
mProbabilityOfDeathInAnHour.

Definition at line 43 of file RandomCellKiller.cpp.

References RandomCellKiller< DIM >::mProbabilityOfDeathInAnHour.

template<unsigned DIM>
void RandomCellKiller< DIM >::TestAndLabelSingleCellForApoptosis ( CellPtr  pCell  )  [inline]

Overridden method to test a given cell for apoptosis.

Parameters:
pCell the cell to test for apoptosis

Definition at line 49 of file RandomCellKiller.cpp.

References RandomNumberGenerator::Instance(), SimulationTime::Instance(), RandomCellKiller< DIM >::mProbabilityOfDeathInAnHour, and RandomNumberGenerator::ranf().

Referenced by RandomCellKiller< DIM >::TestAndLabelCellsForApoptosisOrDeath().

template<unsigned DIM>
void RandomCellKiller< DIM >::TestAndLabelCellsForApoptosisOrDeath (  )  [inline, virtual]

template<unsigned DIM>
void RandomCellKiller< DIM >::OutputCellKillerParameters ( out_stream &  rParamsFile  )  [inline, virtual]

Outputs cell killer parameters to file

As this method is pure virtual, it must be overridden in subclasses.

Parameters:
rParamsFile the file stream to which the parameters are output

Implements AbstractCellKiller< DIM >.

Definition at line 73 of file RandomCellKiller.cpp.

References RandomCellKiller< DIM >::mProbabilityOfDeathInAnHour, and AbstractCellKiller< SPACE_DIM >::OutputCellKillerParameters().


Friends And Related Function Documentation

template<unsigned DIM>
friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractCellKiller< DIM >.

Definition at line 62 of file RandomCellKiller.hpp.


Member Data Documentation

template<unsigned DIM>
double RandomCellKiller< DIM >::mProbabilityOfDeathInAnHour [private]

Probability that in an hour's worth of trying, the cell killer will have successfully killed a given cell.

Definition at line 59 of file RandomCellKiller.hpp.

Referenced by RandomCellKiller< DIM >::GetDeathProbabilityInAnHour(), RandomCellKiller< DIM >::OutputCellKillerParameters(), RandomCellKiller< DIM >::RandomCellKiller(), and RandomCellKiller< DIM >::TestAndLabelSingleCellForApoptosis().


The documentation for this class was generated from the following files:

Generated on Mon Nov 1 12:37:17 2010 for Chaste by  doxygen 1.5.5