Disease Transitions

This module contains tools to model transitions between disease states.

class vivarium_public_health.disease.transition.TransitionString(value)

class vivarium_public_health.disease.transition.RateTransition(input_state, output_state, get_data_functions=None, triggered=Trigger.NOT_TRIGGERED)

Parameters:

• input_state (BaseDiseaseState) –

• output_state (BaseDiseaseState) –

• get_data_functions (Dict[str, Callable]) –

setup(builder)

Defines custom actions this component needs to run during the setup lifecycle phase.

This method is intended to be overridden by subclasses to perform any necessary setup operations specific to the component. By default, it does nothing.

Parameters:

builder (Builder) – The builder object used to set up the component.

Return type:

None

load_transition_rate_data(builder)

compute_transition_rate(index)

Parameters:

index (Index) –

Return type:

Series

class vivarium_public_health.disease.transition.ProportionTransition(input_state, output_state, get_data_functions=None, triggered=Trigger.NOT_TRIGGERED)

Parameters:

• input_state (BaseDiseaseState) –

• output_state (BaseDiseaseState) –

• get_data_functions (Dict[str, Callable]) –

setup(builder)

Defines custom actions this component needs to run during the setup lifecycle phase.

This method is intended to be overridden by subclasses to perform any necessary setup operations specific to the component. By default, it does nothing.

Parameters:

builder (Builder) – The builder object used to set up the component.

Return type:

None