RadialSloughingCellKiller Class Reference

#include <RadialSloughingCellKiller.hpp>

Inherits AbstractCellKiller< 2 >.

Collaboration diagram for RadialSloughingCellKiller:

[legend]

List of all members.

Public Member Functions
	RadialSloughingCellKiller (AbstractCellPopulation< 2 > *pCellPopulation, c_vector< double, 2 > centre, double radius)
c_vector< double, 2 >	GetCentre () const
double	GetRadius () const
virtual void	TestAndLabelCellsForApoptosisOrDeath ()
void	OutputCellKillerParameters (out_stream &rParamsFile)
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
c_vector< double, 2 >	mCentre
double	mRadius
Friends
class	boost::serialization::access

---

Detailed Description

Radial sloughing cell killer for use with the crypt projection model.

Kills cells if they are outside a circle whose centre and radius can be passed in but are take default values.

Definition at line 43 of file RadialSloughingCellKiller.hpp.

---

Constructor & Destructor Documentation

RadialSloughingCellKiller::RadialSloughingCellKiller	(	AbstractCellPopulation< 2 > *	pCellPopulation,
		c_vector< double, 2 >	centre,
		double	radius
	)

Constructor.

Parameters:

	pCellPopulation	pointer to the cell population.
	centre	the centre of death.
	radius	the radius of death.

Definition at line 31 of file RadialSloughingCellKiller.cpp.

---

Member Function Documentation

c_vector< double, 2 > RadialSloughingCellKiller::GetCentre

(

)

const

Returns:

mCentre.

Definition at line 38 of file RadialSloughingCellKiller.cpp.

References mCentre.

double RadialSloughingCellKiller::GetRadius

(

)

const

Returns:

mRadius.

Definition at line 43 of file RadialSloughingCellKiller.cpp.

References mRadius.

void RadialSloughingCellKiller::OutputCellKillerParameters

(

out_stream &

rParamsFile

)

[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< 2 >.

Definition at line 64 of file RadialSloughingCellKiller.cpp.

References mCentre, and mRadius.

template<class Archive >

void RadialSloughingCellKiller::serialize	(	Archive &	archive,
		const unsigned int	version
	)			[inline, private]

Serialize the object and its member variables.

Parameters:

	archive	the archive
	version	the current version of this class

Reimplemented from AbstractCellKiller< 2 >.

Definition at line 55 of file RadialSloughingCellKiller.hpp.

void RadialSloughingCellKiller::TestAndLabelCellsForApoptosisOrDeath

(

)

[virtual]

Loop over cells and kills cells outside boundary.

Implements AbstractCellKiller< 2 >.

Definition at line 48 of file RadialSloughingCellKiller.cpp.

References AbstractCellPopulation< DIM >::Begin(), AbstractCellPopulation< DIM >::End(), AbstractCellPopulation< DIM >::GetLocationOfCellCentre(), mCentre, AbstractCellKiller< 2 >::mpCellPopulation, and mRadius.

---

Friends And Related Function Documentation

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractCellKiller< 2 >.

Definition at line 53 of file RadialSloughingCellKiller.hpp.

---

Member Data Documentation

c_vector<double,2> RadialSloughingCellKiller::mCentre [private]

Centre of death.

Definition at line 48 of file RadialSloughingCellKiller.hpp.

Referenced by GetCentre(), OutputCellKillerParameters(), and TestAndLabelCellsForApoptosisOrDeath().

double RadialSloughingCellKiller::mRadius [private]

Radius of death.

Definition at line 51 of file RadialSloughingCellKiller.hpp.

Referenced by GetRadius(), OutputCellKillerParameters(), and TestAndLabelCellsForApoptosisOrDeath().

---

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

• crypt/src/killers/RadialSloughingCellKiller.hpp
• crypt/src/killers/RadialSloughingCellKiller.cpp