Properties

Property provides various methods to get information from the population.

It includes many infection methods for houses, places and other spatial cells, characterised by a force of infection exerted by each infected person. This includes infectiousness and susceptibility components.

Infectiousness is (broadly) a function of 1 person (their age, places, number of people in their household etc). Susceptibility is (broadly) a function of 2 people (a person’s susceptibility to another person / potential infector).

Overview:

class pyEpiabm.property.InfectionStatus(value)[source]

Enum representing a person’s current infection status.

class pyEpiabm.property.PlaceType(value)[source]

Enum representing a place’s type.

class pyEpiabm.property.PersonalInfection[source]

Class to calculate the infectiousness and susceptibility parameters of a Person.

static person_inf(infector, time: float)[source]

Calculate the infectiousness of a person.

Parameters:

  • infector (Person) – Infector

  • time (float) – Current simulation time

Returns:

Infectiousness parameter of person

Return type:

float

static person_susc(infectee, time: float)[source]

Calculate the susceptibility of one person to another.

Does not yet import WAIFW matrix from Polymod data to determine age dependant contact between individuals.

Parameters:

  • infectee (Person) – Infectee

  • time (float) – Current simulation time

Returns:

Susceptibility parameter of person

Return type:

float

class pyEpiabm.property.HouseholdInfection[source]

Class to calculate the infectiousness and susceptibility parameters for the force of infection parameter, within households.

static household_foi(infector, infectee, time: float)[source]

Calculate the force of infection parameter of a household, for a particular infector and infectee.

Parameters:

  • infector (Person) – Infector

  • infectee (Person) – Infectee

  • time (float) – Current simulation time

Returns:

Force of infection parameter of household

Return type:

float

static household_inf(infector, time: float)[source]

Calculate the infectiousness of a person in a given household. Does not include interventions such as isolation, or whether individual is a carehome resident.

Parameters:

  • infector (Person) – Infector

  • time (float) – Current simulation time

Returns:

Infectiousness parameter of household

Return type:

float

static household_susc(infector, infectee, time: float)[source]

Calculate the susceptibility of one person to another in a given household. Intervention parameters are based on the microcell properties of the infectee. Does not include interventions such as isolation, or whether individual is a carehome resident.

Parameters:

  • infector (Person) – Infector

  • infectee (Person) – Infectee

  • time (float) – Current simulation time

Returns:

Susceptibility parameter of household

Return type:

float

class pyEpiabm.property.PlaceInfection[source]

Class to calculate the infectiousness and susceptibility parameters for the force of infection parameter, within places.

static place_foi(place, infector, infectee, time: float)[source]

Calculate the force of infection of a place, for a particular infector and infectee.

Parameters:

  • infector (Person) – Infector

  • infectee (Person) – Infectee

  • place (Place) – Place

  • time (float) – Current simulation time

Returns:

Force of infection parameter of place

Return type:

float

static place_inf(place, infector, time: float)[source]

Calculate the infectiousness of a place. Does not include interventions such as isolation, or whether individual is a carehome resident.

Does not yet differentiate between places as we have not decided which places to implement, and what transmission to give them.

Parameters:

  • place (Place) – Place

  • infector (Person) – Infectious person

  • time (float) – Current simulation time

Returns:

Infectiousness parameter of place

Return type:

float

static place_susc(place, infectee, time: float)[source]

Calculate the susceptibility of a place. Intervention parameters are based on the microcell properties of the infectee. Does not include interventions such as isolation, or whether individual is a carehome resident.

Parameters:

  • infectee (Person) – Infectee

  • place (Place) – Place

  • time (float) – Current simulation time

Returns:

Susceptibility parameter of place

Return type:

float

class pyEpiabm.property.SpatialInfection[source]

Class to calculate the infectiousness and susceptibility parameters for the force of infection parameter, between cells.

static cell_inf(inf_cell, time: float)[source]

Calculate the infectiousness of one cell towards its nearby cells. Does not include interventions such as isolation, or whether individual is a carehome resident. Returns the expected number of infections for a given timestep.

Parameters:

  • inf_cell (Cell) – Cell causing the infection

  • time (float) – Current simulation time

Returns:

Average number of infection events from the cell per timestep

Return type:

int

static spatial_foi(inf_cell, susc_cell, infector, infectee, time: float)[source]

Calculate the force of infection between cells, for a particular infector and infectee.

Parameters:

  • inf_cell (Cell) – Cell doing infecting

  • susc_cell (Cell) – Cell receiving infections

  • infector (Person) – Infector

  • infectee (Person) – Infectee

  • time (float) – Current simulation time

Returns:

Force of infection parameter of cell

Return type:

float

static spatial_inf(inf_cell, infector, time: float)[source]

Calculate the infectiousness between cells, dependent on the infectious people in it.

Parameters:

  • inf_cell (Cell) – Cell causing the infection

  • infector (Person) – Infector

  • time (float) – Current simulation time

Returns:

Infectiousness parameter of cell

Return type:

float

static spatial_susc(susc_cell, infectee, time: float)[source]

Calculate the susceptibility of one cell towards its neighbouring cells. Intervention parameters are based on the microcell properties of the infectee.

Parameters:

  • susc_cell (Cell) – Cell receiving infections

  • infectee (Person) – Infectee

  • time (float) – Current simulation time

Returns:

Susceptibility parameter of cell

Return type:

float