IndividualImmunityChanger

The IndividualImmunityChanger intervention class acts essentially as a MultiEffectVaccine, with the exception of how the behavior is implemented. Rather than attaching a persistent vaccine intervention object to an individual’s intervention list (as a campaign-individual-multieffectboostervaccine does), the IndividualImmunityChanger directly alters the immune modifiers of the individual’s susceptibility object and is then immediately disposed of. Any immune waning is not governed by Waning effect classes, as MultiEffectVaccine is, but rather by the immunity waning parameters in the configuration file.

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 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

Boost_Acquire

float

0

1

0

Specifies the boosting effect on acquisition immunity for naive individuals (without natural or vaccine-derived immunity) for a multi-effect booster vaccine. This does not replace current immunity, it builds multiplicatively on top of it.

 
{
    "Boost_Acquire": 0.7
}

Boost_Mortality

float

0

1

0

Specifies the boosting effect on mortality immunity for naive individuals (without natural or vaccine-derived immunity) for a multi-effect booster vaccine. This does not replace current immunity, it builds multiplicatively on top of it.

 
{
    "Boost_Mortality": 1.0
}

Boost_Threshold_Acquire

float

0

1

0

Specifies how much acquisition immunity is required before the vaccine changes from a prime to a boost.

 
{
    "Boost_Threshold_Acquire": 0.0
}

Boost_Threshold_Mortality

float

0

1

0

Specifies how much mortality immunity is required before the vaccine changes from a prime to a boost.

 
{
    "Boost_Threshold_Mortality": 0.0
}

Boost_Threshold_Transmit

float

0

1

0

Specifies how much transmission immunity is required before the vaccine changes from a prime to a boost.

 
{
    "Boost_Threshold_Transmit": 0.0
}

Boost_Transmit

float

0

1

0

Specifies the boosting effect on transmission immunity for naive individuals (without natural or vaccine-derived immunity) for a multi-effect booster vaccine. This does not replace current immunity, it builds multiplicatively on top of it.

 
{
    "Boost_Transmit": 0.5
}

Cost_To_Consumer

float

0

999999

10

The unit cost per vaccine (unamortized).

 
{
    "Cost_To_Consumer": 10.0
}

Prime_Acquire

float

0

1

0

Specifies the priming effect on acquisition immunity for naive individuals (without natural or vaccine-derived immunity) for a multi-effect booster vaccine.

 
{
    "Prime_Acquire": 0.1
}

Prime_Mortality

float

0

1

0

Specifies the priming effect on mortality immunity for naive individuals (without natural or vaccine-derived immunity) for a multi-effect booster vaccine.

 
{
    "Prime_Mortality": 0.3
}

Prime_Transmit

float

0

1

0

Specifies the priming effect on transmission immunity for naive individuals (without natural or vaccine-derived immunity) for a multi-effect booster vaccine.

 
{
    "Prime_Transmit": 0.2
}

{
    "Use_Defaults": 1,
    "Campaign_Name": "Generic Seattle Regression Campaign",
    "Events": [{
        "Start_Day": 10,
        "class": "CampaignEvent",
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Event_Coordinator_Config": {
            "class": "StandardInterventionDistributionEventCoordinator",
            "Target_Demographic": "Everyone",
            "Demographic_Coverage": 1.0,
            "Intervention_Config": {
                "class": "IndividualImmunityChanger",
                "Cost_To_Consumer": 10.0,
                "Prime_Acquire": 0.1,
                "Prime_Transmit": 0.2,
                "Prime_Mortality": 0.3,
                "Boost_Acquire": 0.7,
                "Boost_Transmit": 0.7,
                "Boost_Mortality": 1.0,
                "Boost_Threshold_Acquire": 0.2,
                "Boost_Threshold_Transmit": 0.1,
                "Boost_Threshold_Mortality": 0.1
            }
        }
    }]
}