Outbreak#

The Outbreak class allows the introduction of a disease outbreak event by the addition of new infected or susceptible individuals to a node. Outbreak is a node-level intervention; to distribute an outbreak to specific categories of existing individuals within a node, use OutbreakIndividual.

Note

Parameters are case-sensitive. For Boolean parameters, set to 1 for true or 0 for false. Minimum, maximum, or default values of “NA” indicate that those values are not applicable for that parameter.

EMOD does not use true defaults; that is, if the dependency relationships indicate that a parameter is required, you must supply a value for it. However, many of the tools used to work with EMOD will use the default values provided below.

JSON format does not permit comments, but you can add “dummy” parameters to add contextual information to your files. Any keys that are not EMOD parameter names will be ignored by the model.

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 base strain ID of the outbreak infection.

 
{
  "Antigen": 1
}

Genome

integer

-1

1.67E+07

0

The genome ID 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 2Log2_Number_of_Genomes_per_Clade-1. Set this to -1 to create a random number generator.

Intervention distribution example:

{
  "Use_Defaults": 1,
  "Events": [
    {
      "class": "CampaignEvent",
      "Start_Day": 40,
      "Nodeset_Config": {
        "class": "NodeSetAll"
      },
      "Event_Coordinator_Config": {
        "class": "StandardInterventionDistributionEventCoordinator",
        "Intervention_Config": {
          "class": "Outbreak",
          "Antigen": 0,
          "Genome": 0,
          "Number_Cases_Per_Node": 10,
          "Probability_Of_Infection": 0.5
        }
      }
    }
  ]
}

Import_Age

float

0

43800

365

The age (in days) of imported individuals.

 
{
  "Import_Age": 10000
}

Number_Cases_Per_Node

integer

0

2147480000.0

1

The number of new imported individuals.

Note

This will increase the population with demographics of 50/50 male/female and user-defined ages

 
{
  "Intervention_Config": {
    "Antigen": 0,
    "Genome": 0,
    "Number_Cases_Per_Node": 10,
    "class": "Outbreak"
  }
}

Probability_Of_Infection

float

0

1

1

The probability that new individuals are infected. 1.0 implies all new individuals are infected while 0.0 adds all of the people as susceptible individuals.

 
{
  "Probability_Of_Infection": 0.5
}

{
  "Events": [
    {
      "Event_Coordinator_Config": {
        "Demographic_Coverage": 0.001,
        "Intervention_Config": {
          "Clade": 1,
          "Genome": 3,
          "Import_Age": 365,
          "Number_Cases_Per_Node": 10,
          "Probability_Of_Infection": 0.7,
          "class": "Outbreak"
        },
        "Target_Demographic": "Everyone",
        "class": "StandardInterventionDistributionEventCoordinator"
      },
      "Event_Name": "Outbreak",
      "Nodeset_Config": {
        "class": "NodeSetAll"
      },
      "Start_Day": 30,
      "class": "CampaignEvent"
    }
  ]
}