sid.susceptibility¶
Module Contents¶
Functions¶
|
Prepare the multiplier for infection probabilities. |
- prepare_susceptibility_factor(susceptibility_factor_model: Optional[Callable], initial_states: pandas.DataFrame, params: pandas.DataFrame, seed: itertools.count) numpy.ndarray[source]¶
Prepare the multiplier for infection probabilities.
The multiplier defines individual susceptibility which can be used to let infection probabilities vary by age.
If no multiplier is given, all individuals have the same susceptibility. Otherwise, a custom function generates multipliers for the infection probability for each individual.
- Parameters
susceptibility_factor_model (Optional[Callable]) – The custom function which computes individual multipliers with states, parameters and a seed.
initial_states (pandas.DataFrame) – The initial states.
params (pandas.DataFrame) – The parameters.
seed (itertools.count) – The seed counter.
- Returns: susceptibility_factor (numpy.ndarray): An array with a
multiplier for each individual between 0 and 1.