Skip to content

laser.measles.abm.components.process_importation

laser.measles.abm.components.process_importation

This module defines Importation classes, which provide methods to import cases into a population during simulation.

Classes:

Name Description
Infect_Random_Agents

A class to periodically infect a random subset of agents in the population

Functions:

Name Description
Infect_Random_Agents.__init__

bool = False) -> None: Initializes the Infect_Random_Agents class with a given model, period, count, and verbosity option.

Infect_Random_Agents.__call__

Checks whether it is time to infect a random subset of agents and infects them if necessary.

Infect_Random_Agents.plot

Figure = None): Nothing yet.

laser.measles.abm.components.process_importation.ImportationParams

Bases: BaseModel

Parameters specific to the importation process components.

laser.measles.abm.components.process_importation.InfectAgentsInPatchProcess(model, verbose=False, params=None)

A component to update the infection timers of a population in a model.

Initialize an Infect_Random_Agents instance.

Args:

1
2
3
4
5
model: The model object that contains the population.
period: The number of ticks between each infection event.
count: The number of agents to infect at each event.
start (int, optional): The tick at which to start the infection events.
verbose (bool, optional): If True, enables verbose output. Defaults to False.

Attributes:

1
model: The model object that contains the population.

Side Effects:

laser.measles.abm.components.process_importation.InfectAgentsInPatchProcess.__call__(model, tick)

Updates the infection timers for the population in the model.

Args:

1
2
model: The model containing the population data.
tick: The current tick or time step in the simulation.

Returns:

1
None

laser.measles.abm.components.process_importation.InfectAgentsInPatchProcess.plot(fig=None)

Nothing yet

laser.measles.abm.components.process_importation.InfectRandomAgentsProcess(model, verbose=False, params=None)

A component to update the infection timers of a population in a model.

Initialize an Infect_Random_Agents instance.

Args:

1
2
3
4
5
model: The model object that contains the population.
period: The number of ticks between each infection event.
count: The number of agents to infect at each event.
start (int, optional): The tick at which to start the infection events.
verbose (bool, optional): If True, enables verbose output. Defaults to False.

Attributes:

1
model: The model object that contains the population.

Side Effects:

laser.measles.abm.components.process_importation.InfectRandomAgentsProcess.__call__(model, tick)

Updates the infection timers for the population in the model.

Args:

1
2
model: The model containing the population data.
tick: The current tick or time step in the simulation.

Returns:

1
None

laser.measles.abm.components.process_importation.InfectRandomAgentsProcess.plot(fig=None)

Nothing yet