OutbreakIndividual

The OutbreakIndividual intervention class introduces contagious diseases that are compatible with the simulation type to existing individuals using the individual targeted features configured in the appropriate event coordinator. To instead add new infection individuals, use Outbreak.

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. 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 } }
Ignore_Immunity	boolean	NA	NA	1	Individuals will be force-infected (with a specific strain) regardless of actual immunity level when set to true (1).	{ "Intervention_Config": { "Antigen": 0, "Genome": 0, "class": "OutbreakIndividual", "Ignore_Immunity": 0 } }
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 }

{
    "Events": [{
        "Event_Coordinator_Config": {
            "Demographic_Coverage": 0.005,
            "Intervention_Config": {
                "Outbreak_Source": "PrevalenceIncrease",
                "class": "OutbreakIndividual"
            },
            "class": "StandardInterventionDistributionEventCoordinator"
        },
        "Event_Name": "Outbreak",
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Start_Day": 1,
        "class": "CampaignEvent"
    }],
    "Use_Defaults": 1
}