Outbreak
The Outbreak class allows the introduction of a disease outbreak event by the addition of new infected individuals or infection of existing individuals in a node. Outbreak is a node-level intervention; to distribute an outbreak to specific categories of existing individuals within a node, use parameter-campaign-individual-outbreakindividual.
Note
1 2 3 4 5 6 7 8 9 10 11 | |
The table below describes all possible parameters with which this class can be configured. The JSON example that follows shows one potential configuration.
| Parameter | Example | Description | Type | Min | Max | Default |
|---|---|---|---|---|---|---|
| Clade | link | The clade ID (Clade) of the outbreak infection. Together with the genome ID (Genome) they are a unitary object representing a strain of infection, which allows for differentiation among infections. Values for Clade may range from 0 to Number_of_Clades-1 (set in the configuration file). | integer | 0 | 9 | 0 |
| Genome | link | The genome ID (Genome) of the outbreak infection. Together with the clade ID (Clade) they represent an infection as a unitary object. Values for Genome may range from -1 to 2 Log2_Number_of_Genomes_per_Clade-1 | integer | 0 | 16777215 | 0 |
| Import_Age | link | The age (in days) of infected import cases. | float | 0 | 43800 | 365 |
| Incubation_Period_Override | link | The incubation period, in days, that infected individuals will go through before becoming infectious. This value overrides the incubation period set in the configuration file. Set to -1 to honor the configuration parameter settings. | integer | -1 | 2147480000 | -1 |
| Number_Cases_Per_Node | link | The number of new cases of Outbreak to import (per node). .. note:: This will increase the population and there is no control over demographics of these individuals. |
integer | 0 | 2147480000 | 1 |