Skip to content

laser.measles.abm.components.tracker_population

tracker_population

PopulationTracker(model, params=None)

Bases: BasePopulationTracker

Tracks the population size of each patch at each time tick.

The recorded series lives on tracker.population_tracker (shape (n_patches, n_ticks)) after model.run(). Sum across the patch axis for the global population time series.

Examples:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from laser.measles.scenarios.synthetic import single_patch_scenario
from laser.measles.abm import ABMModel, ABMParams
from laser.measles.abm import components
from laser.measles import create_component

scenario = single_patch_scenario(population=50_000, mcv1_coverage=0.85)
params = ABMParams(num_ticks=365, seed=42, start_time="2000-01")
model = ABMModel(scenario, params)
model.add_component(create_component(components.PopulationTracker, components.PopulationTrackerParams()))
model.run()

# Read the recorded time series after the run.
tracker = model.get_instance("PopulationTracker")[0]
pop_per_patch = tracker.population_tracker     # shape (n_patches, n_ticks)
pop_global = pop_per_patch.sum(axis=0)         # shape (n_ticks,)
print(f"start: {pop_global[0]:,}, end: {pop_global[-1]:,}")

PopulationTrackerParams

Bases: BasePopulationTrackerParams

Parameters for PopulationTrackerParams (inherits all fields from base).

Examples:

1
2
3
from laser.measles.abm.components.tracker_population import PopulationTrackerParams

params = PopulationTrackerParams()