Outbreak¶
The Outbreak class allows the introduction of a disease outbreak event by the addition of infected individuals or by the infection of existing individuals in the specified node set. The type of disease outbreak to be added must be configured. Outbreak is a node-level intervention; to distribute an outbreak intervention to specific categories of individuals within a targeted node, use OutbreakIndividual.
Warning
The event containing the outbreak “intervention” must be the last one listed in the campaign file or none of the disease control interventions will take place.
Note
Parameters are case-sensitive. For Boolean parameters, set to 1 for true or 0 for false. JSON does not permit comments, but you can add “dummy” parameters to add contextual information to your files.
The table below describes all possible parameters with which this class can be configured. The JSON example that follows shows one potential configuration.
Parameter | Data type | Minimum | Maximum | Default | Description | Example |
---|---|---|---|---|---|---|
Antigen | integer | 0 | 10 | 0 | The antigenic ID of the outbreak infection. | {
"Intervention_Config": {
"Antigen": 0,
"Genome": 0,
"Outbreak_Source": "PrevalenceIncrease",
"class": "OutbreakIndividual"
}
}
|
Genome | integer | -2.15E+0 | 2.15E+0 | 0 | The genetic ID of the outbreak infection. | {
"Intervention_Config": {
"Antigen": 0,
"Genome": 0,
"Outbreak_Source": "PrevalenceIncrease",
"class": "OutbreakIndividual",
"Incubation_Period_Override": 0
}
}
|
Import_Age | float | 0 | 43800 | 365 | The age (in days) of infected import cases. | {
"Import_Age": 10000
}
|
Incubation_Period_Override | integer | -1 | 2.15E+0 | -1 | 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. | {
"Incubation_Period_Override": 0
}
|
Number_Cases_Per_Node | integer | 0 | 2.15E+0 | 1 | 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. |
{
"Intervention_Config": {
"Antigen": 0,
"Genome": 0,
"Outbreak_Source": "ImportCases",
"Number_Cases_Per_Node": 10,
"class": "Outbreak"
}
}
|
{
"Use_Defaults": 1,
"Events": [{
"class": "CampaignEvent",
"Nodeset_Config": {
"class": "NodeSetAll"
},
"Start_Day": 40,
"Event_Coordinator_Config": {
"class": "StandardInterventionDistributionEventCoordinator",
"Intervention_Config": {
"class": "Outbreak",
"Antigen": 0,
"Genome": 0,
"Number_Cases_Per_Node": 10
}
}
}]
}